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. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from BlazeClientBuilder[F] to any2stringadd[BlazeClientBuilder[F]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (BlazeClientBuilder[F], B)
    Implicit
    This member is added by an implicit conversion from BlazeClientBuilder[F] to ArrowAssoc[BlazeClientBuilder[F]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. implicit val F: ConcurrentEffect[F]
    Attributes
    protected
    Definition Classes
    BlazeClientBuilder → BackendBuilder
  7. 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
  8. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  9. val asynchronousChannelGroup: Option[AsynchronousChannelGroup]
  10. val bufferSize: Int
  11. def channelOption[A](socketOption: SocketOption[A]): Option[A]
    Definition Classes
    BlazeBackendBuilder
  12. val channelOptions: ChannelOptions
    Definition Classes
    BlazeClientBuilder → BlazeBackendBuilder
  13. val checkEndpointIdentification: Boolean
  14. val chunkBufferMaxSize: Int
  15. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  16. val connectTimeout: Duration
  17. def ensuring(cond: (BlazeClientBuilder[F]) ⇒ Boolean, msg: ⇒ Any): BlazeClientBuilder[F]
    Implicit
    This member is added by an implicit conversion from BlazeClientBuilder[F] to Ensuring[BlazeClientBuilder[F]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  18. def ensuring(cond: (BlazeClientBuilder[F]) ⇒ Boolean): BlazeClientBuilder[F]
    Implicit
    This member is added by an implicit conversion from BlazeClientBuilder[F] to Ensuring[BlazeClientBuilder[F]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  19. def ensuring(cond: Boolean, msg: ⇒ Any): BlazeClientBuilder[F]
    Implicit
    This member is added by an implicit conversion from BlazeClientBuilder[F] to Ensuring[BlazeClientBuilder[F]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  20. def ensuring(cond: Boolean): BlazeClientBuilder[F]
    Implicit
    This member is added by an implicit conversion from BlazeClientBuilder[F] to Ensuring[BlazeClientBuilder[F]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  21. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  22. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  23. val executionContext: ExecutionContext
  24. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  25. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from BlazeClientBuilder[F] to StringFormat[BlazeClientBuilder[F]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  26. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  27. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  28. val idleTimeout: Duration
  29. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  30. final val logger: Logger
    Attributes
    protected
  31. val maxChunkSize: Int
  32. val maxConnectionsPerRequestKey: (RequestKey) ⇒ Int
  33. val maxHeaderLength: Int
  34. val maxResponseLineSize: Int
  35. val maxTotalConnections: Int
  36. val maxWaitQueueLimit: Int
  37. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  38. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  39. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  40. val parserMode: ParserMode
  41. val requestTimeout: Duration
  42. 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
  43. val responseHeaderTimeout: Duration
  44. val scheduler: Resource[F, TickWheelExecutor]
  45. def socketKeepAlive: Option[Boolean]
    Definition Classes
    BlazeBackendBuilder
  46. def socketReceiveBufferSize: Option[Int]
    Definition Classes
    BlazeBackendBuilder
  47. def socketReuseAddress: Option[Boolean]
    Definition Classes
    BlazeBackendBuilder
  48. def socketSendBufferSize: Option[Int]
    Definition Classes
    BlazeBackendBuilder
  49. val sslContext: Option[SSLContext]
  50. 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
  51. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  52. def tcpNoDelay: Option[Boolean]
    Definition Classes
    BlazeBackendBuilder
  53. def toString(): String
    Definition Classes
    AnyRef → Any
  54. val userAgent: Option[User-Agent]
  55. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  56. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  57. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  58. def withAsynchronousChannelGroup(asynchronousChannelGroup: AsynchronousChannelGroup): BlazeClientBuilder[F]
  59. def withAsynchronousChannelGroupOption(asynchronousChannelGroup: Option[AsynchronousChannelGroup]): BlazeClientBuilder[F]
  60. def withBufferSize(bufferSize: Int): BlazeClientBuilder[F]
  61. def withChannelOption[A](key: SocketOption[A], value: A): Self
    Definition Classes
    BlazeBackendBuilder
  62. def withChannelOptions(channelOptions: ChannelOptions): BlazeClientBuilder[F]
    Definition Classes
    BlazeClientBuilder → BlazeBackendBuilder
  63. def withCheckEndpointAuthentication(checkEndpointIdentification: Boolean): BlazeClientBuilder[F]
  64. def withChunkBufferMaxSize(chunkBufferMaxSize: Int): BlazeClientBuilder[F]
  65. def withConnectTimeout(connectTimeout: Duration): BlazeClientBuilder[F]
  66. def withDefaultChannelOption[A](key: SocketOption[A]): Self
    Definition Classes
    BlazeBackendBuilder
  67. def withDefaultSocketKeepAlive: Self
    Definition Classes
    BlazeBackendBuilder
  68. def withDefaultSocketReceiveBufferSize: Self
    Definition Classes
    BlazeBackendBuilder
  69. def withDefaultSocketReuseAddress: Self
    Definition Classes
    BlazeBackendBuilder
  70. def withDefaultSocketSendBufferSize: Self
    Definition Classes
    BlazeBackendBuilder
  71. 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.

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

    Use the provided SSLContext when making secure calls

  90. def withTcpNoDelay(tcpNoDelay: Boolean): Self
    Definition Classes
    BlazeBackendBuilder
  91. def withUserAgent(userAgent: User-Agent): BlazeClientBuilder[F]
  92. def withUserAgentOption(userAgent: Option[User-Agent]): BlazeClientBuilder[F]
  93. def withoutAsynchronousChannelGroup: BlazeClientBuilder[F]
  94. def withoutUserAgent: BlazeClientBuilder[F]
  95. def →[B](y: B): (BlazeClientBuilder[F], B)
    Implicit
    This member is added by an implicit conversion from BlazeClientBuilder[F] to ArrowAssoc[BlazeClientBuilder[F]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

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

Inherited from BackendBuilder[F, Client[F]]

Inherited from BlazeBackendBuilder[Client[F]]

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from BlazeClientBuilder[F] to any2stringadd[BlazeClientBuilder[F]]

Inherited by implicit conversion StringFormat from BlazeClientBuilder[F] to StringFormat[BlazeClientBuilder[F]]

Inherited by implicit conversion Ensuring from BlazeClientBuilder[F] to Ensuring[BlazeClientBuilder[F]]

Inherited by implicit conversion ArrowAssoc from BlazeClientBuilder[F] to ArrowAssoc[BlazeClientBuilder[F]]

Ungrouped