Class/Object

org.http4s.client.blaze

BlazeClientConfig

Related Docs: object BlazeClientConfig | package blaze

Permalink

final case class BlazeClientConfig(idleTimeout: Duration, requestTimeout: Duration, userAgent: Option[User-Agent], sslContext: Option[SSLContext], endpointAuthentication: 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

idleTimeout

duration that a connection can wait without traffic before timeout

requestTimeout

maximum duration for a request to complete before a timeout

userAgent

optional custom user agent header

sslContext

optional custom SSLContext to use to replace the default

endpointAuthentication

require endpoint authentication for encrypted connections

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

Source
BlazeClientConfig.scala
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
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new BlazeClientConfig(idleTimeout: Duration, requestTimeout: Duration, userAgent: Option[User-Agent], sslContext: Option[SSLContext], endpointAuthentication: Boolean, maxResponseLineSize: Int, maxHeaderLength: Int, maxChunkSize: Int, lenientParser: Boolean, bufferSize: Int, customExecutor: Option[ExecutorService], group: Option[AsynchronousChannelGroup])

    Permalink

    idleTimeout

    duration that a connection can wait without traffic before timeout

    requestTimeout

    maximum duration for a request to complete before a timeout

    userAgent

    optional custom user agent header

    sslContext

    optional custom SSLContext to use to replace the default

    endpointAuthentication

    require endpoint authentication for encrypted connections

    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. def +(other: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from BlazeClientConfig to any2stringadd[BlazeClientConfig] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (BlazeClientConfig, B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from BlazeClientConfig to ArrowAssoc[BlazeClientConfig] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean

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

    Permalink
    Definition Classes
    Any
  7. val bufferSize: Int

    Permalink

    internal buffer size of the blaze client

  8. def clone(): AnyRef

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

    Permalink

    custom executor to run async computations.

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

  10. val endpointAuthentication: Boolean

    Permalink

    require endpoint authentication for encrypted connections

  11. def ensuring(cond: (BlazeClientConfig) ⇒ Boolean, msg: ⇒ Any): BlazeClientConfig

    Permalink
    Implicit information
    This member is added by an implicit conversion from BlazeClientConfig to Ensuring[BlazeClientConfig] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: (BlazeClientConfig) ⇒ Boolean): BlazeClientConfig

    Permalink
    Implicit information
    This member is added by an implicit conversion from BlazeClientConfig to Ensuring[BlazeClientConfig] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: Boolean, msg: ⇒ Any): BlazeClientConfig

    Permalink
    Implicit information
    This member is added by an implicit conversion from BlazeClientConfig to Ensuring[BlazeClientConfig] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. def ensuring(cond: Boolean): BlazeClientConfig

    Permalink
    Implicit information
    This member is added by an implicit conversion from BlazeClientConfig to Ensuring[BlazeClientConfig] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. final def eq(arg0: AnyRef): Boolean

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  17. def formatted(fmtstr: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from BlazeClientConfig to StringFormat[BlazeClientConfig] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  18. final def getClass(): Class[_]

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

    Permalink

    custom AsynchronousChannelGroup to use other than the system default

  20. val idleTimeout: Duration

    Permalink

    duration that a connection can wait without traffic before timeout

  21. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  22. val lenientParser: Boolean

    Permalink

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

  23. val maxChunkSize: Int

    Permalink

    maximum size of chunked content chunks

  24. val maxHeaderLength: Int

    Permalink

    maximum length of headers

  25. val maxResponseLineSize: Int

    Permalink

    maximum length of the request line

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

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

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

    Permalink
    Definition Classes
    AnyRef
  29. val requestTimeout: Duration

    Permalink

    maximum duration for a request to complete before a timeout

  30. val sslContext: Option[SSLContext]

    Permalink

    optional custom SSLContext to use to replace the default

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

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

    Permalink

    optional custom user agent header

  33. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  36. def [B](y: B): (BlazeClientConfig, B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from BlazeClientConfig to ArrowAssoc[BlazeClientConfig] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from BlazeClientConfig to any2stringadd[BlazeClientConfig]

Inherited by implicit conversion StringFormat from BlazeClientConfig to StringFormat[BlazeClientConfig]

Inherited by implicit conversion Ensuring from BlazeClientConfig to Ensuring[BlazeClientConfig]

Inherited by implicit conversion ArrowAssoc from BlazeClientConfig to ArrowAssoc[BlazeClientConfig]

Ungrouped