Class/Object

org.http4s.client.blaze

BlazeClientConfig

Related Docs: object BlazeClientConfig | package blaze

Permalink

final case class BlazeClientConfig(responseHeaderTimeout: Duration, idleTimeout: Duration, requestTimeout: Duration, userAgent: Option[User-Agent], sslContext: Option[SSLContext], checkEndpointIdentification: Boolean, maxResponseLineSize: Int, maxHeaderLength: Int, maxChunkSize: Int, lenientParser: Boolean, bufferSize: Int, customExecutor: Option[ExecutorService], group: Option[AsynchronousChannelGroup]) extends Product with Serializable

Config object for the blaze clients

responseHeaderTimeout

duration between the completion of a request and the completion of the response header. Does not include time to acquire the connection or the time to read the response.

idleTimeout

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

requestTimeout

maximum duration for a request to complete before a timeout. Does not include time to acquire the the connection, but does include time to read the response

userAgent

optional custom user agent header

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

lenientParser

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

bufferSize

internal buffer size of the blaze client

customExecutor

custom executor to run async computations. Will not be shutdown with client.

group

custom AsynchronousChannelGroup to use other than the system default

Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
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], sslContext: Option[SSLContext], checkEndpointIdentification: Boolean, maxResponseLineSize: Int, maxHeaderLength: Int, maxChunkSize: Int, lenientParser: Boolean, bufferSize: Int, customExecutor: Option[ExecutorService], group: Option[AsynchronousChannelGroup])

    Permalink

    responseHeaderTimeout

    duration between the completion of a request and the completion of the response header. Does not include time to acquire the connection or the time to read the response.

    idleTimeout

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

    requestTimeout

    maximum duration for a request to complete before a timeout. Does not include time to acquire the the connection, but does include time to read the response

    userAgent

    optional custom user agent header

    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

    lenientParser

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

    bufferSize

    internal buffer size of the blaze client

    customExecutor

    custom executor to run async computations. Will not be shutdown with client.

    group

    custom AsynchronousChannelGroup to use other than the system default

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. val bufferSize: Int

    Permalink

    internal buffer size of the blaze client

  6. val checkEndpointIdentification: Boolean

    Permalink

    require endpoint identification for secure requests according to RFC 2818, Section 3.1.

    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.

  7. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. val customExecutor: Option[ExecutorService]

    Permalink

    custom executor to run async computations.

    custom executor to run async computations. Will not be shutdown with client.

  9. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  10. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  11. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  12. val group: Option[AsynchronousChannelGroup]

    Permalink

    custom AsynchronousChannelGroup to use other than the system default

  13. val idleTimeout: Duration

    Permalink

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

  14. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  15. val lenientParser: Boolean

    Permalink

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

  16. val maxChunkSize: Int

    Permalink

    maximum size of chunked content chunks

  17. val maxHeaderLength: Int

    Permalink

    maximum length of headers

  18. val maxResponseLineSize: Int

    Permalink

    maximum length of the request line

  19. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  20. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  21. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  22. val requestTimeout: Duration

    Permalink

    maximum duration for a request to complete before a timeout.

    maximum duration for a request to complete before a timeout. Does not include time to acquire the the connection, but does include time to read the response

  23. val responseHeaderTimeout: Duration

    Permalink

    duration between the completion of a request and the completion of the response header.

    duration between the completion of a request and the completion of the response header. Does not include time to acquire the connection or the time to read the response.

  24. val sslContext: Option[SSLContext]

    Permalink

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

  25. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  26. val userAgent: Option[User-Agent]

    Permalink

    optional custom user agent header

  27. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  28. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  29. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def endpointAuthentication: Boolean

    Permalink
    Annotations
    @deprecated
    Deprecated

    (Since version 0.16) Parameter has been renamed to checkEndpointIdentification

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped