blaze-client/org.http4s.blaze.client

org.http4s.blaze.client

package org.http4s.blaze.client

Type members

Classlikes

object BlazeClient

Blaze client implementation

Blaze client implementation

sealed abstract class BlazeClientBuilder[F[_]] extends BlazeBackendBuilder[Client[F]] with BackendBuilder[F, Client[F]]
Value Params
sslContext

Some custom SSLContext, or None if the default SSL context is to be lazily instantiated.

Companion
object
object BlazeClientBuilder
Companion
class
final case class NoConnectionAllowedException(key: RequestKey) extends IllegalArgumentException
sealed abstract class ParserMode extends Product with Serializable
Companion
object
object ParserMode
Companion
class
final case class WaitQueueFullFailure() extends RuntimeException

Deprecated classlikes

@deprecated("Use BlazeClientBuilder", "0.19.0-M2")
final case class BlazeClientConfig(responseHeaderTimeout: Duration, idleTimeout: Duration, requestTimeout: Duration, userAgent: Option[`User-Agent`], maxTotalConnections: Int, maxWaitQueueLimit: Int, maxConnectionsPerRequestKey: RequestKey => Int, sslContext: Option[SSLContext], @deprecatedName(scala.Symbol.apply("endpointAuthentication")) checkEndpointIdentification: Boolean, maxResponseLineSize: Int, maxHeaderLength: Int, maxChunkSize: Int, chunkBufferMaxSize: Int, lenientParser: Boolean, bufferSize: Int, executionContext: ExecutionContext, group: Option[AsynchronousChannelGroup])

Config object for the blaze clients

Config object for the blaze clients

Value Params
bufferSize

internal buffer size of the blaze client

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.

executionContext

custom executionContext to run async computations.

group

custom AsynchronousChannelGroup to use other than the system default

idleTimeout

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

lenientParser

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

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

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.

sslContext

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

userAgent

optional custom user agent header

Companion
object
Deprecated
@deprecated("Use BlazeClientBuilder", "0.19.0-M2")
object BlazeClientConfig
Companion
class
Deprecated
@deprecated("Use BlazeClientBuilder", "0.19.0-M2")
object Http1Client

Create a HTTP1 client which will attempt to recycle connections

Create a HTTP1 client which will attempt to recycle connections

Deprecated