Packages

final class EmberClientBuilder[F[_]] extends AnyRef

Self Type
EmberClientBuilder[F]
Source
EmberClientBuilder.scala
Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. EmberClientBuilder
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. val additionalSocketOptions: List[SocketOption]
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def build: Resource[F, Client[F]]
  7. val checkEndpointIdentification: Boolean
  8. val chunkSize: Int
  9. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  10. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  11. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  12. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  13. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  14. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  15. val idleTimeInPool: Duration
  16. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  17. val maxPerKey: (RequestKey) ⇒ Int
  18. val maxResponseHeaderSize: Int
  19. val maxTotal: Int
  20. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  21. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  22. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  23. val retryPolicy: RetryPolicy[F]
  24. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  25. val timeout: Duration
  26. def toString(): String
    Definition Classes
    AnyRef → Any
  27. val userAgent: Option[User-Agent]
  28. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  29. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  30. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  31. def withAdditionalSocketOptions(additionalSocketOptions: List[SocketOption]): EmberClientBuilder[F]

    Sets additional socket options to apply to the underlying sockets.

  32. def withCheckEndpointAuthentication(checkEndpointIdentification: Boolean): EmberClientBuilder[F]

    Sets whether or not to force endpoint authentication/verification on the TLSContext.

    Sets whether or not to force endpoint authentication/verification on the TLSContext. Enabled by default. When enabled the server's identity will be checked against the server's certificate during SSL/TLS handshaking. This is important to avoid man-in-the-middle attacks by confirming server identity against their certificate.

  33. def withChunkSize(chunkSize: Int): EmberClientBuilder[F]

    Sets the max chunkSize in bytes to read from sockets at a time.

  34. def withHttp2: EmberClientBuilder[F]

    Enables HTTP/2 support.

    Enables HTTP/2 support. Disabled by default.

  35. def withIdleConnectionTime(idleConnectionTime: Duration): EmberClientBuilder[F]

    Sets the idle timeout on connections.

    Sets the idle timeout on connections. The timeout is reset with each read or write.

  36. def withIdleTimeInPool(idleTimeInPool: Duration): EmberClientBuilder[F]

    Sets the connection pool's maximum time a connection can be idle.

    Sets the connection pool's maximum time a connection can be idle. The timeout starts when a connection is returned the the pool, and reset when it is borrowed.

  37. def withLogger(logger: Logger[F]): EmberClientBuilder[F]

    Sets the Logger.

  38. def withMaxPerKey(maxPerKey: (RequestKey) ⇒ Int): EmberClientBuilder[F]

    Sets the connection pool's maximum number of pooled connections per RequestKey.

  39. def withMaxResponseHeaderSize(maxResponseHeaderSize: Int): EmberClientBuilder[F]

    Sets the max size in bytes to read while parsing response headers.

  40. def withMaxTotal(maxTotal: Int): EmberClientBuilder[F]

    Sets the connection pool's total maximum number of idle connections.

    Sets the connection pool's total maximum number of idle connections. Per RequestKey values set with withMaxPerKey cannot override this total maximum.

  41. def withPushPromiseSupport(f: (Request[Pure], F[Response[F]]) ⇒ F[Outcome[F, Throwable, Unit]]): EmberClientBuilder[F]

    Push promises are implemented via responding with a PushPromise frame which is effectively a request headers frame for a request that wasn't sent by the client.

    Push promises are implemented via responding with a PushPromise frame which is effectively a request headers frame for a request that wasn't sent by the client.

    The second param is the response once it is available that you can wait for OR you can cancel the Outcome to send a termination signal to ask the remote server to stop sending additional data from this data stream. If you want to handle these the outcome can just be outcome successful. But you can save significant data by canceling requests you don't want.

    Push promises are very useful to get all the data necessary to render a page in parallel to the actual data for that page leading to much faster render times, or sending additional cache enriching information.

    Push promise support is disabled by default.

  42. def withRetryPolicy(retryPolicy: RetryPolicy[F]): EmberClientBuilder[F]

    Sets the RetryPolicy.

  43. def withSocketGroup(sg: SocketGroup[F]): EmberClientBuilder[F]

    Sets the SocketGroup, a group of TCP sockets to be used in connections.

  44. def withTLSContext(tlsContext: TLSContext[F]): EmberClientBuilder[F]

    Sets a custom TLSContext.

    Sets a custom TLSContext. By default a TLSContext is created from the system default SSLContext.

  45. def withTimeout(timeout: Duration): EmberClientBuilder[F]

    Sets the header receive timeout on connections.

  46. def withUnixSockets(unixSockets: UnixSockets[F]): EmberClientBuilder[F]

    Sets underlying UnixSockets to use for requests with a UnixSocketAddress.

    Sets underlying UnixSockets to use for requests with a UnixSocketAddress. Useful for secure and efficient inter-process communication. See also UnixSocket client middleware to direct all requests to a UnixSocketAddress.

  47. def withUserAgent(userAgent: User-Agent): EmberClientBuilder[F]

    Sets the default User-Agent string.

    Sets the default User-Agent string. A User-Agent header on a request takes priority over this setting.

  48. def withoutCheckEndpointAuthentication: EmberClientBuilder[F]

    Disables endpoint authentication/verification.

  49. def withoutHttp2: EmberClientBuilder[F]

    Disables HTTP/2 support.

    Disables HTTP/2 support. Disabled by default.

  50. def withoutPushPromiseSupport: EmberClientBuilder[F]

    Disables Push promise support.

    Disables Push promise support. Push promise support is disabled by default.

  51. def withoutTLSContext: EmberClientBuilder[F]

    Unset any TLSContext and creates one from the system default SSLContext.

  52. def withoutUserAgent: EmberClientBuilder[F]

    Clears the default User-Agent string, so no User-Agent header is sent.

    Clears the default User-Agent string, so no User-Agent header is sent. A User-Agent header on a request takes priority over this setting.

Inherited from AnyRef

Inherited from Any

Ungrouped