package client
- Alphabetic
- Public
- All
Type Members
- sealed abstract class BlazeClientBuilder[F[_]] extends BlazeBackendBuilder[Client[F]] with BackendBuilder[F, Client[F]]
- final case class NoConnectionAllowedException(key: RequestKey) extends IllegalArgumentException with Product with Serializable
- sealed abstract class ParserMode extends Product with Serializable
- final case class WaitQueueFullFailure() extends RuntimeException with Product with Serializable
-
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
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
Value Members
-
object
BlazeClient
Blaze client implementation
- object BlazeClientBuilder
- object ParserMode extends Serializable
Deprecated Value Members
-
object
BlazeClientConfig extends Serializable
- Annotations
- @deprecated
- Deprecated
(Since version 0.19.0-M2) Use BlazeClientBuilder