Packages

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

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
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  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. 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
  2. val asynchronousChannelGroup: Option[AsynchronousChannelGroup]
  3. val bufferSize: Int
  4. def channelOption[A](socketOption: SocketOption[A]): Option[A]
    Definition Classes
    BlazeBackendBuilder
  5. val channelOptions: ChannelOptions
    Definition Classes
    BlazeClientBuilder → BlazeBackendBuilder
  6. val checkEndpointIdentification: Boolean
  7. val chunkBufferMaxSize: Int
  8. val connectTimeout: Duration
  9. val executionContext: ExecutionContext
  10. val idleTimeout: Duration
  11. val maxChunkSize: Int
  12. val maxConnectionsPerRequestKey: (RequestKey) ⇒ Int
  13. val maxHeaderLength: Int
  14. val maxResponseLineSize: Int
  15. val maxTotalConnections: Int
  16. val maxWaitQueueLimit: Int
  17. val parserMode: ParserMode
  18. val requestTimeout: Duration
  19. 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
  20. val responseHeaderTimeout: Duration
  21. val scheduler: Resource[F, TickWheelExecutor]
  22. def socketKeepAlive: Option[Boolean]
    Definition Classes
    BlazeBackendBuilder
  23. def socketReceiveBufferSize: Option[Int]
    Definition Classes
    BlazeBackendBuilder
  24. def socketReuseAddress: Option[Boolean]
    Definition Classes
    BlazeBackendBuilder
  25. def socketSendBufferSize: Option[Int]
    Definition Classes
    BlazeBackendBuilder
  26. val sslContext: Option[SSLContext]
  27. 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
  28. def tcpNoDelay: Option[Boolean]
    Definition Classes
    BlazeBackendBuilder
  29. val userAgent: Option[User-Agent]
  30. def withAsynchronousChannelGroup(asynchronousChannelGroup: AsynchronousChannelGroup): BlazeClientBuilder[F]
  31. def withAsynchronousChannelGroupOption(asynchronousChannelGroup: Option[AsynchronousChannelGroup]): BlazeClientBuilder[F]
  32. def withBufferSize(bufferSize: Int): BlazeClientBuilder[F]
  33. def withChannelOption[A](key: SocketOption[A], value: A): Self
    Definition Classes
    BlazeBackendBuilder
  34. def withChannelOptions(channelOptions: ChannelOptions): BlazeClientBuilder[F]
    Definition Classes
    BlazeClientBuilder → BlazeBackendBuilder
  35. def withCheckEndpointAuthentication(checkEndpointIdentification: Boolean): BlazeClientBuilder[F]
  36. def withChunkBufferMaxSize(chunkBufferMaxSize: Int): BlazeClientBuilder[F]
  37. def withConnectTimeout(connectTimeout: Duration): BlazeClientBuilder[F]
  38. def withDefaultChannelOption[A](key: SocketOption[A]): Self
    Definition Classes
    BlazeBackendBuilder
  39. def withDefaultSocketKeepAlive: Self
    Definition Classes
    BlazeBackendBuilder
  40. def withDefaultSocketReceiveBufferSize: Self
    Definition Classes
    BlazeBackendBuilder
  41. def withDefaultSocketReuseAddress: Self
    Definition Classes
    BlazeBackendBuilder
  42. def withDefaultSocketSendBufferSize: Self
    Definition Classes
    BlazeBackendBuilder
  43. 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.

    The creation of the context is lazy, as SSLContext.getDefault() throws on some platforms. The context creation is deferred until the first secure client call.

  44. def withDefaultTcpNoDelay: Self
    Definition Classes
    BlazeBackendBuilder
  45. def withExecutionContext(executionContext: ExecutionContext): BlazeClientBuilder[F]
  46. def withIdleTimeout(idleTimeout: Duration): BlazeClientBuilder[F]
  47. def withMaxChunkSize(maxChunkSize: Int): BlazeClientBuilder[F]
  48. def withMaxConnectionsPerRequestKey(maxConnectionsPerRequestKey: (RequestKey) ⇒ Int): BlazeClientBuilder[F]
  49. def withMaxHeaderLength(maxHeaderLength: Int): BlazeClientBuilder[F]
  50. def withMaxResponseLineSize(maxResponseLineSize: Int): BlazeClientBuilder[F]
  51. def withMaxTotalConnections(maxTotalConnections: Int): BlazeClientBuilder[F]
  52. def withMaxWaitQueueLimit(maxWaitQueueLimit: Int): BlazeClientBuilder[F]
  53. def withParserMode(parserMode: ParserMode): BlazeClientBuilder[F]
  54. def withRequestTimeout(requestTimeout: Duration): BlazeClientBuilder[F]
  55. def withResponseHeaderTimeout(responseHeaderTimeout: Duration): BlazeClientBuilder[F]
  56. def withScheduler(scheduler: TickWheelExecutor): BlazeClientBuilder[F]
  57. def withSocketKeepAlive(socketKeepAlive: Boolean): Self
    Definition Classes
    BlazeBackendBuilder
  58. def withSocketReceiveBufferSize(socketReceiveBufferSize: Int): Self
    Definition Classes
    BlazeBackendBuilder
  59. def withSocketReuseAddress(socketReuseAddress: Boolean): Self
    Definition Classes
    BlazeBackendBuilder
  60. def withSocketSendBufferSize(socketSendBufferSize: Int): Self
    Definition Classes
    BlazeBackendBuilder
  61. def withSslContext(sslContext: SSLContext): BlazeClientBuilder[F]

    Use the provided SSLContext when making secure calls

  62. def withTcpNoDelay(tcpNoDelay: Boolean): Self
    Definition Classes
    BlazeBackendBuilder
  63. def withUserAgent(userAgent: User-Agent): BlazeClientBuilder[F]
  64. def withUserAgentOption(userAgent: Option[User-Agent]): BlazeClientBuilder[F]
  65. def withoutAsynchronousChannelGroup: BlazeClientBuilder[F]
  66. def withoutUserAgent: BlazeClientBuilder[F]

Deprecated Value Members

  1. def withSslContextOption(sslContext: Option[SSLContext]): BlazeClientBuilder[F]
    Annotations
    @deprecated
    Deprecated

    (Since version 0.20.2) Use withSslContext or withDefaultSslContext

  2. def withoutSslContext: BlazeClientBuilder[F]
    Annotations
    @deprecated
    Deprecated

    (Since version 0.20.2) Use withDefaultSslContext