Packages

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

Source
BlazeClientConfig.scala
Linear Supertypes
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])

    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. val bufferSize: Int
  2. val checkEndpointIdentification: Boolean
  3. val chunkBufferMaxSize: Int
  4. val executionContext: ExecutionContext
  5. val group: Option[AsynchronousChannelGroup]
  6. val idleTimeout: Duration
  7. val lenientParser: Boolean
  8. val maxChunkSize: Int
  9. val maxConnectionsPerRequestKey: (RequestKey) ⇒ Int
  10. val maxHeaderLength: Int
  11. val maxResponseLineSize: Int
  12. val maxTotalConnections: Int
  13. val maxWaitQueueLimit: Int
  14. val requestTimeout: Duration
  15. val responseHeaderTimeout: Duration
  16. val sslContext: Option[SSLContext]
  17. val userAgent: Option[User-Agent]

Deprecated Value Members

  1. def endpointAuthentication: Boolean
    Annotations
    @deprecated
    Deprecated

    (Since version 0.16) Parameter has been renamed to checkEndpointIdentification