Class/Object

org.http4s.client.blaze

BlazeClientConfig

Related Docs: object BlazeClientConfig | package blaze

Permalink

final case class BlazeClientConfig(responseHeaderTimeout: Duration, idleTimeout: Duration, requestTimeout: Duration, userAgent: Option[User-Agent], maxTotalConnections: Int, maxWaitQueueLimit: Int, maxConnectionsPerRequestKey: (RequestKey) ⇒ Int, sslContext: Option[SSLContext], checkEndpointIdentification: Boolean, maxResponseLineSize: Int, maxHeaderLength: Int, maxChunkSize: Int, chunkBufferMaxSize: Int, lenientParser: Boolean, bufferSize: Int, executionContext: ExecutionContext, group: Option[AsynchronousChannelGroup]) extends Product with Serializable

Config object for the blaze clients

responseHeaderTimeout

duration between the submission of a request and the completion of the response header. Does not include time to read the response body.

idleTimeout

duration that a connection can wait without traffic being read or written before timeout

requestTimeout

maximum duration from the submission of a request through reading the body before a timeout.

userAgent

optional custom user agent header

maxTotalConnections

maximum connections the client will have at any specific time

maxWaitQueueLimit

maximum number requests waiting for a connection at any specific time

maxConnectionsPerRequestKey

Map of RequestKey to number of max connections

sslContext

optional custom SSLContext to use to replace the default, SSLContext.getDefault.

checkEndpointIdentification

require endpoint identification for secure requests according to RFC 2818, Section 3.1. If the certificate presented does not match the hostname of the request, the request fails with a CertificateException. This setting does not affect checking the validity of the cert via the sslContext's trust managers.

maxResponseLineSize

maximum length of the request line

maxHeaderLength

maximum length of headers

maxChunkSize

maximum size of chunked content chunks

chunkBufferMaxSize

Size of the buffer that is used when Content-Length header is not specified.

lenientParser

a lenient parser will accept illegal chars but replaces them with � (0xFFFD)

bufferSize

internal buffer size of the blaze client

executionContext

custom executionContext to run async computations.

group

custom AsynchronousChannelGroup to use other than the system default

Annotations
@deprecated
Deprecated

(Since version 0.19.0-M2) Use BlazeClientBuilder

Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. BlazeClientConfig
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new BlazeClientConfig(responseHeaderTimeout: Duration, idleTimeout: Duration, requestTimeout: Duration, userAgent: Option[User-Agent], maxTotalConnections: Int, maxWaitQueueLimit: Int, maxConnectionsPerRequestKey: (RequestKey) ⇒ Int, sslContext: Option[SSLContext], checkEndpointIdentification: Boolean, maxResponseLineSize: Int, maxHeaderLength: Int, maxChunkSize: Int, chunkBufferMaxSize: Int, lenientParser: Boolean, bufferSize: Int, executionContext: ExecutionContext, group: Option[AsynchronousChannelGroup])

    Permalink

    responseHeaderTimeout

    duration between the submission of a request and the completion of the response header. Does not include time to read the response body.

    idleTimeout

    duration that a connection can wait without traffic being read or written before timeout

    requestTimeout

    maximum duration from the submission of a request through reading the body before a timeout.

    userAgent

    optional custom user agent header

    maxTotalConnections

    maximum connections the client will have at any specific time

    maxWaitQueueLimit

    maximum number requests waiting for a connection at any specific time

    maxConnectionsPerRequestKey

    Map of RequestKey to number of max connections

    sslContext

    optional custom SSLContext to use to replace the default, SSLContext.getDefault.

    checkEndpointIdentification

    require endpoint identification for secure requests according to RFC 2818, Section 3.1. If the certificate presented does not match the hostname of the request, the request fails with a CertificateException. This setting does not affect checking the validity of the cert via the sslContext's trust managers.

    maxResponseLineSize

    maximum length of the request line

    maxHeaderLength

    maximum length of headers

    maxChunkSize

    maximum size of chunked content chunks

    chunkBufferMaxSize

    Size of the buffer that is used when Content-Length header is not specified.

    lenientParser

    a lenient parser will accept illegal chars but replaces them with � (0xFFFD)

    bufferSize

    internal buffer size of the blaze client

    executionContext

    custom executionContext to run async computations.

    group

    custom AsynchronousChannelGroup to use other than the system default

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. val bufferSize: Int

    Permalink

    internal buffer size of the blaze client

  6. val checkEndpointIdentification: Boolean

    Permalink

    require endpoint identification for secure requests according to RFC 2818, Section 3.1.

    require endpoint identification for secure requests according to RFC 2818, Section 3.1. If the certificate presented does not match the hostname of the request, the request fails with a CertificateException. This setting does not affect checking the validity of the cert via the sslContext's trust managers.

  7. val chunkBufferMaxSize: Int

    Permalink

    Size of the buffer that is used when Content-Length header is not specified.

  8. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  9. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  10. val executionContext: ExecutionContext

    Permalink

    custom executionContext to run async computations.

  11. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  12. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  13. val group: Option[AsynchronousChannelGroup]

    Permalink

    custom AsynchronousChannelGroup to use other than the system default

  14. val idleTimeout: Duration

    Permalink

    duration that a connection can wait without traffic being read or written before timeout

  15. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  16. val lenientParser: Boolean

    Permalink

    a lenient parser will accept illegal chars but replaces them with � (0xFFFD)

  17. val maxChunkSize: Int

    Permalink

    maximum size of chunked content chunks

  18. val maxConnectionsPerRequestKey: (RequestKey) ⇒ Int

    Permalink

    Map of RequestKey to number of max connections

  19. val maxHeaderLength: Int

    Permalink

    maximum length of headers

  20. val maxResponseLineSize: Int

    Permalink

    maximum length of the request line

  21. val maxTotalConnections: Int

    Permalink

    maximum connections the client will have at any specific time

  22. val maxWaitQueueLimit: Int

    Permalink

    maximum number requests waiting for a connection at any specific time

  23. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  24. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  25. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  26. val requestTimeout: Duration

    Permalink

    maximum duration from the submission of a request through reading the body before a timeout.

  27. val responseHeaderTimeout: Duration

    Permalink

    duration between the submission of a request and the completion of the response header.

    duration between the submission of a request and the completion of the response header. Does not include time to read the response body.

  28. val sslContext: Option[SSLContext]

    Permalink

    optional custom SSLContext to use to replace the default, SSLContext.getDefault.

  29. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  30. val userAgent: Option[User-Agent]

    Permalink

    optional custom user agent header

  31. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  32. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  33. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def endpointAuthentication: Boolean

    Permalink
    Annotations
    @deprecated
    Deprecated

    (Since version 0.16) Parameter has been renamed to checkEndpointIdentification

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped