sealed abstract class BlazeClientBuilder[F[_]] extends BlazeBackendBuilder[Client[F]] with BackendBuilder[F, Client[F]]
- Source
- BlazeClientBuilder.scala
- Alphabetic
- By Inheritance
- BlazeClientBuilder
- BackendBuilder
- BlazeBackendBuilder
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Type Members
-
type
Self = BlazeClientBuilder[F]
- Definition Classes
- BlazeClientBuilder → BlazeBackendBuilder
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
-
implicit
val
F: ConcurrentEffect[F]
- Attributes
- protected
- Definition Classes
- BlazeClientBuilder → BackendBuilder
-
def
allocated: F[(Client[F], F[Unit])]
Returns an effect that allocates a backend and an
F[Unit]
to release it.Returns an effect that allocates a backend and an
F[Unit]
to release it. The returnedF
waits until the backend is ready to process requests. The second element of the tuple shuts down the backend when run.Unlike resource and stream, there is no automatic release of the backend. This function is intended for REPL sessions, tests, and other situations where composing a cats.effect.Resource or fs2.Stream is not tenable. resource or stream is recommended wherever possible.
- Definition Classes
- BackendBuilder
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
- val asynchronousChannelGroup: Option[AsynchronousChannelGroup]
- val bufferSize: Int
-
def
channelOption[A](socketOption: SocketOption[A]): Option[A]
- Definition Classes
- BlazeBackendBuilder
-
val
channelOptions: ChannelOptions
- Definition Classes
- BlazeClientBuilder → BlazeBackendBuilder
- val checkEndpointIdentification: Boolean
- val chunkBufferMaxSize: Int
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
- val connectTimeout: Duration
- val customDnsResolver: Option[(RequestKey) ⇒ Either[Throwable, InetSocketAddress]]
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- val executionContext: ExecutionContext
-
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 idleTimeout: Duration
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
final
val
logger: Logger
- Attributes
- protected
- val maxChunkSize: Int
- val maxConnectionsPerRequestKey: (RequestKey) ⇒ Int
- val maxHeaderLength: Int
- val maxResponseLineSize: Int
- val maxTotalConnections: Int
- val maxWaitQueueLimit: 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 parserMode: ParserMode
- val requestTimeout: Duration
-
def
resource: Resource[F, Client[F]]
Returns the backend as a resource.
Returns the backend as a resource. Resource acquire waits until the backend is ready to process requests.
- Definition Classes
- BlazeClientBuilder → BackendBuilder
- val responseHeaderTimeout: Duration
- val scheduler: Resource[F, TickWheelExecutor]
-
def
socketKeepAlive: Option[Boolean]
- Definition Classes
- BlazeBackendBuilder
-
def
socketReceiveBufferSize: Option[Int]
- Definition Classes
- BlazeBackendBuilder
-
def
socketReuseAddress: Option[Boolean]
- Definition Classes
- BlazeBackendBuilder
-
def
socketSendBufferSize: Option[Int]
- Definition Classes
- BlazeBackendBuilder
- val sslContext: Option[SSLContext]
-
def
stream: Stream[F, Client[F]]
Returns the backend as a single-element stream.
Returns the backend as a single-element stream. The stream does not emit until the backend is ready to process requests. The backend is shut down when the stream is finalized.
- Definition Classes
- BackendBuilder
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
tcpNoDelay: Option[Boolean]
- Definition Classes
- BlazeBackendBuilder
-
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 withAsynchronousChannelGroup(asynchronousChannelGroup: AsynchronousChannelGroup): BlazeClientBuilder[F]
- def withAsynchronousChannelGroupOption(asynchronousChannelGroup: Option[AsynchronousChannelGroup]): BlazeClientBuilder[F]
- def withBufferSize(bufferSize: Int): BlazeClientBuilder[F]
-
def
withChannelOption[A](key: SocketOption[A], value: A): Self
- Definition Classes
- BlazeBackendBuilder
-
def
withChannelOptions(channelOptions: ChannelOptions): BlazeClientBuilder[F]
- Definition Classes
- BlazeClientBuilder → BlazeBackendBuilder
- def withCheckEndpointAuthentication(checkEndpointIdentification: Boolean): BlazeClientBuilder[F]
- def withChunkBufferMaxSize(chunkBufferMaxSize: Int): BlazeClientBuilder[F]
- def withConnectTimeout(connectTimeout: Duration): BlazeClientBuilder[F]
- def withCustomDnsResolver(customDnsResolver: (RequestKey) ⇒ Either[Throwable, InetSocketAddress]): BlazeClientBuilder[F]
-
def
withDefaultChannelOption[A](key: SocketOption[A]): Self
- Definition Classes
- BlazeBackendBuilder
-
def
withDefaultSocketKeepAlive: Self
- Definition Classes
- BlazeBackendBuilder
-
def
withDefaultSocketReceiveBufferSize: Self
- Definition Classes
- BlazeBackendBuilder
-
def
withDefaultSocketReuseAddress: Self
- Definition Classes
- BlazeBackendBuilder
-
def
withDefaultSocketSendBufferSize: Self
- Definition Classes
- BlazeBackendBuilder
-
def
withDefaultSslContext: BlazeClientBuilder[F]
Use an
SSLContext
obtained bySSLContext.getDefault()
when making secure calls.Use an
SSLContext
obtained bySSLContext.getDefault()
when making secure calls.Since 0.21, the creation is not deferred.
-
def
withDefaultTcpNoDelay: Self
- Definition Classes
- BlazeBackendBuilder
- def withExecutionContext(executionContext: ExecutionContext): BlazeClientBuilder[F]
- def withIdleTimeout(idleTimeout: Duration): BlazeClientBuilder[F]
- def withMaxChunkSize(maxChunkSize: Int): BlazeClientBuilder[F]
- def withMaxConnectionsPerRequestKey(maxConnectionsPerRequestKey: (RequestKey) ⇒ Int): BlazeClientBuilder[F]
- def withMaxHeaderLength(maxHeaderLength: Int): BlazeClientBuilder[F]
- def withMaxResponseLineSize(maxResponseLineSize: Int): BlazeClientBuilder[F]
- def withMaxTotalConnections(maxTotalConnections: Int): BlazeClientBuilder[F]
- def withMaxWaitQueueLimit(maxWaitQueueLimit: Int): BlazeClientBuilder[F]
- def withParserMode(parserMode: ParserMode): BlazeClientBuilder[F]
- def withRequestTimeout(requestTimeout: Duration): BlazeClientBuilder[F]
- def withResponseHeaderTimeout(responseHeaderTimeout: Duration): BlazeClientBuilder[F]
- def withScheduler(scheduler: TickWheelExecutor): BlazeClientBuilder[F]
-
def
withSocketKeepAlive(socketKeepAlive: Boolean): Self
- Definition Classes
- BlazeBackendBuilder
-
def
withSocketReceiveBufferSize(socketReceiveBufferSize: Int): Self
- Definition Classes
- BlazeBackendBuilder
-
def
withSocketReuseAddress(socketReuseAddress: Boolean): Self
- Definition Classes
- BlazeBackendBuilder
-
def
withSocketSendBufferSize(socketSendBufferSize: Int): Self
- Definition Classes
- BlazeBackendBuilder
-
def
withSslContext(sslContext: SSLContext): BlazeClientBuilder[F]
Use the provided
SSLContext
when making secure calls -
def
withSslContextOption(sslContext: Option[SSLContext]): BlazeClientBuilder[F]
Use some provided
SSLContext
when making secure calls, or disable secure calls withNone
-
def
withTcpNoDelay(tcpNoDelay: Boolean): Self
- Definition Classes
- BlazeBackendBuilder
- def withUserAgent(userAgent: User-Agent): BlazeClientBuilder[F]
- def withUserAgentOption(userAgent: Option[User-Agent]): BlazeClientBuilder[F]
- def withoutAsynchronousChannelGroup: BlazeClientBuilder[F]
-
def
withoutSslContext: BlazeClientBuilder[F]
Disable secure calls
- def withoutUserAgent: BlazeClientBuilder[F]