Packages

final class BlazeClientBuilder[F[_]] extends BlazeBackendBuilder[Client[F]] with BackendBuilder[F, Client[F]]

Configure and obtain a BlazeClient

Source
BlazeClientBuilder.scala
Linear Supertypes
BackendBuilder[F, Client[F]], BlazeBackendBuilder[Client[F]], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. BlazeClientBuilder
  2. BackendBuilder
  3. BlazeBackendBuilder
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. type Self = BlazeClientBuilder[F]
    Definition Classes
    BlazeClientBuilder → BlazeBackendBuilder

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. implicit val F: Async[F]
    Attributes
    protected
    Definition Classes
    BlazeClientBuilder → BackendBuilder
  5. 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 returned F 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
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. val asynchronousChannelGroup: Option[AsynchronousChannelGroup]
  8. val bufferSize: Int
  9. def channelOption[A](socketOption: SocketOption[A]): Option[A]
    Definition Classes
    BlazeBackendBuilder
  10. val channelOptions: ChannelOptions
    Definition Classes
    BlazeClientBuilder → BlazeBackendBuilder
  11. val checkEndpointIdentification: Boolean
  12. val chunkBufferMaxSize: Int
  13. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  14. val connectTimeout: Duration
  15. val customDnsResolver: Option[(RequestKey) ⇒ Either[Throwable, InetSocketAddress]]
  16. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  18. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  19. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  20. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  21. val idleTimeout: Duration
  22. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  23. final val logger: Logger
    Attributes
    protected
  24. val maxChunkSize: Int
  25. val maxConnectionsPerRequestKey: (RequestKey) ⇒ Int
  26. val maxHeaderLength: Int
  27. val maxResponseLineSize: Int
  28. val maxTotalConnections: Int
  29. val maxWaitQueueLimit: Int
  30. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  31. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  32. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  33. val parserMode: ParserMode
  34. val requestTimeout: Duration
  35. 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
  36. def resourceWithState: Resource[F, (Client[F], BlazeClientState[F])]

    Creates a blaze-client resource along with a BlazeClientState for monitoring purposes

  37. val responseHeaderTimeout: Duration
  38. val scheduler: Resource[F, TickWheelExecutor]
  39. def socketKeepAlive: Option[Boolean]
    Definition Classes
    BlazeBackendBuilder
  40. def socketReceiveBufferSize: Option[Int]
    Definition Classes
    BlazeBackendBuilder
  41. def socketReuseAddress: Option[Boolean]
    Definition Classes
    BlazeBackendBuilder
  42. def socketSendBufferSize: Option[Int]
    Definition Classes
    BlazeBackendBuilder
  43. val sslContext: SSLContextOption
  44. 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
  45. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  46. def tcpNoDelay: Option[Boolean]
    Definition Classes
    BlazeBackendBuilder
  47. def toString(): String
    Definition Classes
    AnyRef → Any
  48. val userAgent: Option[User-Agent]
  49. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  50. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  51. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  52. def withAsynchronousChannelGroup(asynchronousChannelGroup: AsynchronousChannelGroup): BlazeClientBuilder[F]
  53. def withAsynchronousChannelGroupOption(asynchronousChannelGroup: Option[AsynchronousChannelGroup]): BlazeClientBuilder[F]
  54. def withBufferSize(bufferSize: Int): BlazeClientBuilder[F]
  55. def withChannelOption[A](key: SocketOption[A], value: A): Self
    Definition Classes
    BlazeBackendBuilder
  56. def withChannelOptions(channelOptions: ChannelOptions): BlazeClientBuilder[F]
    Definition Classes
    BlazeClientBuilder → BlazeBackendBuilder
  57. def withCheckEndpointAuthentication(checkEndpointIdentification: Boolean): BlazeClientBuilder[F]
  58. def withChunkBufferMaxSize(chunkBufferMaxSize: Int): BlazeClientBuilder[F]
  59. def withConnectTimeout(connectTimeout: Duration): BlazeClientBuilder[F]
  60. def withCustomDnsResolver(customDnsResolver: (RequestKey) ⇒ Either[Throwable, InetSocketAddress]): BlazeClientBuilder[F]
  61. def withDefaultChannelOption[A](key: SocketOption[A]): Self
    Definition Classes
    BlazeBackendBuilder
  62. def withDefaultSocketKeepAlive: Self
    Definition Classes
    BlazeBackendBuilder
  63. def withDefaultSocketReceiveBufferSize: Self
    Definition Classes
    BlazeBackendBuilder
  64. def withDefaultSocketReuseAddress: Self
    Definition Classes
    BlazeBackendBuilder
  65. def withDefaultSocketSendBufferSize: Self
    Definition Classes
    BlazeBackendBuilder
  66. def withDefaultSslContext: BlazeClientBuilder[F]

    Use an SSLContext obtained by SSLContext.getDefault() when making secure calls.

    Use an SSLContext obtained by SSLContext.getDefault() when making secure calls.

    Since 0.21, the creation is not deferred.

  67. def withDefaultTcpNoDelay: Self
    Definition Classes
    BlazeBackendBuilder
  68. def withExecutionContext(executionContext: ExecutionContext): BlazeClientBuilder[F]
  69. def withIdleTimeout(idleTimeout: Duration): BlazeClientBuilder[F]
  70. def withMaxChunkSize(maxChunkSize: Int): BlazeClientBuilder[F]
  71. def withMaxConnectionsPerRequestKey(maxConnectionsPerRequestKey: (RequestKey) ⇒ Int): BlazeClientBuilder[F]
  72. def withMaxHeaderLength(maxHeaderLength: Int): BlazeClientBuilder[F]
  73. def withMaxResponseLineSize(maxResponseLineSize: Int): BlazeClientBuilder[F]
  74. def withMaxTotalConnections(maxTotalConnections: Int): BlazeClientBuilder[F]
  75. def withMaxWaitQueueLimit(maxWaitQueueLimit: Int): BlazeClientBuilder[F]
  76. def withParserMode(parserMode: ParserMode): BlazeClientBuilder[F]
  77. def withRequestTimeout(requestTimeout: Duration): BlazeClientBuilder[F]
  78. def withResponseHeaderTimeout(responseHeaderTimeout: Duration): BlazeClientBuilder[F]
  79. def withScheduler(scheduler: TickWheelExecutor): BlazeClientBuilder[F]
  80. def withSocketKeepAlive(socketKeepAlive: Boolean): Self
    Definition Classes
    BlazeBackendBuilder
  81. def withSocketReceiveBufferSize(socketReceiveBufferSize: Int): Self
    Definition Classes
    BlazeBackendBuilder
  82. def withSocketReuseAddress(socketReuseAddress: Boolean): Self
    Definition Classes
    BlazeBackendBuilder
  83. def withSocketSendBufferSize(socketSendBufferSize: Int): Self
    Definition Classes
    BlazeBackendBuilder
  84. def withSslContext(sslContext: SSLContext): BlazeClientBuilder[F]

    Use the provided SSLContext when making secure calls

  85. def withTcpNoDelay(tcpNoDelay: Boolean): Self
    Definition Classes
    BlazeBackendBuilder
  86. def withUserAgent(userAgent: User-Agent): BlazeClientBuilder[F]
  87. def withUserAgentOption(userAgent: Option[User-Agent]): BlazeClientBuilder[F]
  88. def withoutAsynchronousChannelGroup: BlazeClientBuilder[F]
  89. def withoutSslContext: BlazeClientBuilder[F]

    Disable secure calls

  90. def withoutUserAgent: BlazeClientBuilder[F]

Deprecated Value Members

  1. def executionContext: ExecutionContext
    Annotations
    @deprecated
    Deprecated

    (Since version 0.23.5)

  2. def withSslContextOption(sslContext: Option[SSLContext]): BlazeClientBuilder[F]

    Use some provided SSLContext when making secure calls, or disable secure calls with None

    Use some provided SSLContext when making secure calls, or disable secure calls with None

    Annotations
    @deprecated
    Deprecated

    (Since version 0.22.0-M1) Use withDefaultSslContext, withSslContext or withoutSslContext to set the SSLContext

Inherited from BackendBuilder[F, Client[F]]

Inherited from BlazeBackendBuilder[Client[F]]

Inherited from AnyRef

Inherited from Any

Ungrouped