Packages

  • package root
    Definition Classes
    root
  • package org
    Definition Classes
    root
  • package http4s
    Definition Classes
    org
  • package client

    Provides extension methods for using the a http4s org.http4s.client.Client

    Provides extension methods for using the a http4s org.http4s.client.Client

    import scalaz.concurrent.Task
import org.http4s._
import org.http4s.client._
import org.http4s.Http4s._
import org.http4s.Status._
import org.http4s.Method._
import org.http4s.EntityDecoder

def client: Client = ???

val r: Task[String] = client(GET(uri("https://www.foo.bar/"))).as[String]
val r2: DecodeResult[String] = client(GET(uri("https://www.foo.bar/"))).attemptAs[String] // implicitly resolve the decoder
val req1 = r.run
val req2 = r.run // Each invocation fetches a new Result based on the behavior of the Client
    Definition Classes
    http4s
  • package blaze
    Definition Classes
    client
  • BlazeClient
  • BlazeClientConfig
  • PooledHttp1Client
  • SimpleHttp1Client

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

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(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])

    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
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    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)
    Implicit
    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
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. val bufferSize: Int
  8. val checkEndpointIdentification: Boolean
  9. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  10. val customExecutor: Option[ExecutorService]
  11. def ensuring(cond: (BlazeClientConfig) ⇒ Boolean, msg: ⇒ Any): BlazeClientConfig
    Implicit
    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
    Implicit
    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
    Implicit
    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
    Implicit
    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
    Definition Classes
    AnyRef
  16. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  17. def formatted(fmtstr: String): String
    Implicit
    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[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  19. val group: Option[AsynchronousChannelGroup]
  20. val idleTimeout: Duration
  21. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  22. val lenientParser: Boolean
  23. val maxChunkSize: Int
  24. val maxHeaderLength: Int
  25. val maxResponseLineSize: Int
  26. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  27. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  28. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  29. val requestTimeout: Duration
  30. val responseHeaderTimeout: Duration
  31. val sslContext: Option[SSLContext]
  32. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  33. val userAgent: Option[User-Agent]
  34. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  35. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  36. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  37. def →[B](y: B): (BlazeClientConfig, B)
    Implicit
    This member is added by an implicit conversion from BlazeClientConfig to ArrowAssoc[BlazeClientConfig] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Deprecated Value Members

  1. def endpointAuthentication: Boolean
    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

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