org.http4s.blaze.client

Members list

Concise view

Type members

Classlikes

Blaze client implementation

Blaze client implementation

Attributes

Source:
BlazeClient.scala
Graph
Supertypes
class Object
trait Matchable
class Any
Self type
sealed abstract class BlazeClientBuilder[F[_]]

Configure and obtain a BlazeClient

Configure and obtain a BlazeClient

Attributes

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

executionContextConfig

optional 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

maxIdleDuration

maximum time a connection can be idle and still be borrowed. Helps deal with connections that are closed while idling in the pool for an extended period.

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.

retries

the number of times an idempotent request that fails with a SocketException will be retried. This is a means to deal with connections that expired while in the pool. Retries happen immediately. The default is 2. For a more sophisticated retry strategy, see the org.http4s.client.middleware.Retry middleware.

scheduler

execution scheduler

sslContext

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

userAgent

optional custom user agent header

Companion:
object
Source:
BlazeClientBuilder.scala
Graph
Supertypes
class Object
trait Matchable
class Any

Attributes

Companion:
class
Source:
BlazeClientBuilder.scala
Graph
Supertypes
class Object
trait Matchable
class Any
Self type
trait BlazeClientState[F[_]]

Attributes

Source:
BlazeClientState.scala
Graph
Supertypes
class Object
trait Matchable
class Any

Attributes

Source:
PoolManager.scala
Graph
Supertypes
trait Product
trait Equals
class Exception
class Throwable
class Object
trait Matchable
class Any
sealed abstract class ParserMode extends Product with Serializable

Attributes

Companion:
object
Source:
ParserMode.scala
Graph
Supertypes
trait Product
trait Equals
class Object
trait Matchable
class Any
Known subtypes
object Lenient.type
object Strict.type
object ParserMode

Attributes

Companion:
class
Source:
ParserMode.scala
Graph
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class WaitQueueFullFailure() extends RuntimeException

Attributes

Source:
PoolManager.scala
Graph
Supertypes
trait Product
trait Equals
class Exception
class Throwable
class Object
trait Matchable
class Any