final class BlazeClientBuilder[F[_]] extends BlazeBackendBuilder[Client[F]] with BackendBuilder[F, Client[F]]
Ordering
- Alphabetic
- By Inheritance
Inherited
- BlazeClientBuilder
- BackendBuilder
- BlazeBackendBuilder
- AnyRef
- Any
- Hide All
- Show All
Visibility
- Public
- Protected
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: Async[F]
- Attributes
- protected
- Definition Classes
- BlazeClientBuilder → 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(classOf[java.lang.CloneNotSupportedException]) @native()
- val connectTimeout: Duration
- val customDnsResolver: Option[(RequestKey) => Either[Throwable, InetSocketAddress]]
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- final def getClass(): Class[_ <: AnyRef]
- 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 maxIdleDuration: Duration
- 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]]
- Definition Classes
- BlazeClientBuilder → BackendBuilder
- def resourceWithState: Resource[F, (Client[F], BlazeClientState[F])]
Creates a blaze-client resource along with a BlazeClientState for monitoring purposes
- val responseHeaderTimeout: Duration
- val retries: Int
- 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: SSLContextOption
- def stream: Stream[F, Client[F]]
- 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(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @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
SSLContextobtained bySSLContext.getDefault()when making secure calls.Use an
SSLContextobtained 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]
Configures the compute thread pool used to run async computations.
Configures the compute thread pool used to run async computations.
This defaults to
cats.effect.Async[F].executionContext. In almost all cases, it is desirable to use the default. - 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 withMaxIdleDuration(maxIdleDuration: Duration = maxIdleDuration): BlazeClientBuilder[F]
Time a connection can be idle and still be borrowed.
Time a connection can be idle and still be borrowed. Helps deal with connections that are closed while idling in the pool for an extended period.
Duration.Infmeans no timeout. - 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 withRetries(retries: Int = retries): BlazeClientBuilder[F]
Number of times to immediately retry idempotent requests that fail with a
SocketException. - 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
SSLContextwhen making secure calls - 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]
Deprecated Value Members
- def executionContext: ExecutionContext
- Annotations
- @deprecated
- Deprecated
(Since version 0.23.5) Do not use - always returns cats.effect.unsafe.IORuntime.global.compute.There is no direct replacement - directly use Async[F].executionContext or your custom execution context
- def withSslContextOption(sslContext: Option[SSLContext]): BlazeClientBuilder[F]
Use some provided
SSLContextwhen making secure calls, or disable secure calls withNoneUse some provided
SSLContextwhen making secure calls, or disable secure calls withNone- Annotations
- @deprecated
- Deprecated
(Since version 0.22.0-M1) Use withDefaultSslContext, withSslContext or withoutSslContext to set the SSLContext