final class EmberClientBuilder[F[_]] extends AnyRef
- Self Type
- EmberClientBuilder[F]
- Source
- EmberClientBuilder.scala
- Alphabetic
- By Inheritance
- EmberClientBuilder
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- val additionalSocketOptions: List[SocketOption]
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
- def build: Resource[F, Client[F]]
- val checkEndpointIdentification: Boolean
- val chunkSize: Int
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- val idleTimeInPool: Duration
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- val maxPerKey: (RequestKey) ⇒ Int
- val maxResponseHeaderSize: Int
- val maxTotal: Int
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- val retryPolicy: RetryPolicy[F]
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
- val timeout: Duration
-
def
toString(): String
- Definition Classes
- AnyRef → Any
- val userAgent: Option[User-Agent]
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
def
withAdditionalSocketOptions(additionalSocketOptions: List[SocketOption]): EmberClientBuilder[F]
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.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. -
def
withChunkSize(chunkSize: Int): EmberClientBuilder[F]
Sets the max
chunkSizein bytes to read from sockets at a time. -
def
withHttp2: EmberClientBuilder[F]
Enables HTTP/2 support.
Enables HTTP/2 support. Disabled by default.
-
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.
-
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.
-
def
withLogger(logger: Logger[F]): EmberClientBuilder[F]
Sets the
Logger. -
def
withMaxPerKey(maxPerKey: (RequestKey) ⇒ Int): EmberClientBuilder[F]
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.
-
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
RequestKeyvalues set withwithMaxPerKeycannot override this total maximum. -
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.
-
def
withRetryPolicy(retryPolicy: RetryPolicy[F]): EmberClientBuilder[F]
Sets the
RetryPolicy. -
def
withSocketGroup(sg: SocketGroup[F]): EmberClientBuilder[F]
Sets the
SocketGroup, a group of TCP sockets to be used in connections. -
def
withTLSContext(tlsContext: TLSContext[F]): EmberClientBuilder[F]
Sets a custom
TLSContext.Sets a custom
TLSContext. By default aTLSContextis created from the system defaultSSLContext. -
def
withTimeout(timeout: Duration): EmberClientBuilder[F]
Sets the header receive timeout on connections.
-
def
withUnixSockets(unixSockets: UnixSockets[F]): EmberClientBuilder[F]
Sets underlying
UnixSocketsto use for requests with aUnixSocketAddress.Sets underlying
UnixSocketsto use for requests with aUnixSocketAddress. Useful for secure and efficient inter-process communication. See alsoUnixSocketclient middleware to direct all requests to aUnixSocketAddress. -
def
withUserAgent(userAgent: User-Agent): EmberClientBuilder[F]
Sets the default User-Agent string.
Sets the default User-Agent string. A
User-Agentheader on a request takes priority over this setting. -
def
withoutCheckEndpointAuthentication: EmberClientBuilder[F]
Disables endpoint authentication/verification.
-
def
withoutHttp2: EmberClientBuilder[F]
Disables HTTP/2 support.
Disables HTTP/2 support. Disabled by default.
-
def
withoutPushPromiseSupport: EmberClientBuilder[F]
Disables Push promise support.
Disables Push promise support. Push promise support is disabled by default.
-
def
withoutTLSContext: EmberClientBuilder[F]
Unset any
TLSContextand creates one from the system defaultSSLContext. -
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-Agentheader on a request takes priority over this setting.