EmberClientBuilder

final class EmberClientBuilder[F[_]]
Companion:
object
class Object
trait Matchable
class Any

Value members

Concrete methods

def build: Resource[F, Client[F]]

Sets additional socket options to apply to the underlying sockets.

Sets additional socket options to apply to the underlying sockets.

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

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.

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.

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

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

Enables HTTP/2 support. Disabled by default.

Enables HTTP/2 support. Disabled by default.

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

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

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.

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.

Sets the Logger.

Sets the Logger.

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

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

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

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

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

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

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

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.

def withRetryPolicy(retryPolicy: () => F): EmberClientBuilder[F]

Sets the RetryPolicy.

Sets the RetryPolicy.

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

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

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

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

Sets the header receive timeout on connections.

Sets the header receive timeout on connections.

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.

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.

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

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

Disables endpoint authentication/verification.

Disables endpoint authentication/verification.

Disables HTTP/2 support. Disabled by default.

Disables HTTP/2 support. Disabled by default.

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

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

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

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

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.

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.