Config

zio.http.ZClient.Config
See theConfig companion object
final case class Config(ssl: Option[ClientSSLConfig], proxy: Option[Proxy], connectionPool: ConnectionPoolConfig, maxInitialLineLength: Int, maxHeaderSize: Int, requestDecompression: Decompression, localAddress: Option[InetSocketAddress], addUserAgentHeader: Boolean, webSocketConfig: WebSocketConfig, idleTimeout: Option[Duration], connectionTimeout: Option[Duration], bodyReadTimeout: Option[Duration] = ...)

Attributes

Companion
object
Source
ZClient.scala
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Self type

Members list

Value members

Concrete methods

def addUserAgentHeader(addUserAgentHeader: Boolean): Config

Attributes

Source
ZClient.scala
def bodyReadTimeout(timeout: Duration): Config

Configure the timeout for reading HTTP response bodies. This timeout is specifically for the time spent reading the body after headers are received. If not set, defaults to idleTimeout.

Configure the timeout for reading HTTP response bodies. This timeout is specifically for the time spent reading the body after headers are received. If not set, defaults to idleTimeout.

This is separate from:

  • connectionTimeout: Time to establish TCP connection
  • idleTimeout: Time channel can be idle without any data

Value parameters

timeout

The duration to wait for body data

Attributes

Source
ZClient.scala
def connectionTimeout(timeout: Duration): Config

Attributes

Source
ZClient.scala
def dynamicConnectionPool(minimum: Int, maximum: Int, ttl: Duration): Config

Attributes

Source
ZClient.scala
def fixedConnectionPool(size: Int): Config

Attributes

Source
ZClient.scala
def idleTimeout(timeout: Duration): Config

Attributes

Source
ZClient.scala
def maxHeaderSize(headerSize: Int): Config

Configure the client to use maxHeaderSize value when encode/decode headers.

Configure the client to use maxHeaderSize value when encode/decode headers.

Attributes

Source
ZClient.scala
def maxInitialLineLength(initialLineLength: Int): Config

Attributes

Source
ZClient.scala
def noBodyReadTimeout: Config

Attributes

Source
ZClient.scala
def noConnectionTimeout: Config

Attributes

Source
ZClient.scala
def noIdleTimeout: Config

Attributes

Source
ZClient.scala
def proxy(proxy: Proxy): Config

Attributes

Source
ZClient.scala
def requestDecompression(isStrict: Boolean): Config

Attributes

Source
ZClient.scala
def ssl(ssl: ClientSSLConfig): Config

Attributes

Source
ZClient.scala
def webSocketConfig(webSocketConfig: WebSocketConfig): Config

Attributes

Source
ZClient.scala

Inherited methods

def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product