Configure and obtain a BlazeClient
- Value Params
- asynchronousChannelGroup
custom AsynchronousChannelGroup to use other than the system default
- bufferSize
internal buffer size of the blaze client
- channelOptions
custom socket options
- 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.
- chunkBufferMaxSize
Size of the buffer that is used when Content-Length header is not specified.
- connectTimeout
Duration a connection attempt times out after
- customDnsResolver
customDnsResolver to use other than the system default
- executionContext
custom executionContext to run async computations.
- idleTimeout
duration that a connection can wait without traffic being read or written before timeout
- maxChunkSize
maximum size of chunked content chunks
- maxConnectionsPerRequestKey
Map of RequestKey to number of max connections
- maxHeaderLength
maximum length of headers
- maxResponseLineSize
maximum length of the request line
- maxTotalConnections
maximum connections the client will have at any specific time
- maxWaitQueueLimit
maximum number requests waiting for a connection at any specific time
- parserMode
lenient or strict parsing mode. The lenient mode will accept illegal chars but replaces them with � (0xFFFD)
- requestTimeout
maximum duration from the submission of a request through reading the body before a timeout.
- responseHeaderTimeout
duration between the submission of a request and the completion of the response header. Does not include time to read the response body.
- scheduler
execution scheduler
- sslContext
Some custom
SSLContext, orNoneif the default SSL context is to be lazily instantiated.- userAgent
optional custom user agent header
- Companion
- object
Type members
Types
Value members
Concrete methods
Use an SSLContext obtained by SSLContext.getDefault() when making secure calls.
Use an SSLContext obtained by SSLContext.getDefault() when making secure calls.
Since 0.21, the creation is not deferred.
Deprecated methods
Use some provided SSLContext when making secure calls, or disable secure calls with None
Use some provided SSLContext when making secure calls, or disable secure calls with None
- Deprecated
[Since version 0.22.0-M1]Use withDefaultSslContext, withSslContext or withoutSslContext to set the SSLContext
Inherited methods
Returns an effect that allocates a backend and an F[Unit] to
release it. The returned F waits until the backend is ready
to process requests. The second element of the tuple shuts
down the backend when run.
Returns an effect that allocates a backend and an F[Unit] to
release it. The returned F waits until the backend is ready
to process requests. The second element of the tuple shuts
down the backend when run.
Unlike resource and stream, there is no automatic release of the backend. This function is intended for REPL sessions, tests, and other situations where composing a cats.effect.Resource or fs2.Stream is not tenable. resource or stream is recommended wherever possible.
- Inherited from
- BackendBuilder
Returns the backend as a single-element stream. The stream does not emit until the backend is ready to process requests. The backend is shut down when the stream is finalized.
Returns the backend as a single-element stream. The stream does not emit until the backend is ready to process requests. The backend is shut down when the stream is finalized.
- Inherited from
- BackendBuilder