Packages

class BlazeServerBuilder[F[_]] extends ServerBuilder[F] with BlazeBackendBuilder[Server]

BlazeServerBuilder is the component for the builder pattern aggregating different components to finally serve requests.

Variables:

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

Type Members

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

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
    BlazeServerBuilder → ServerBuilder → BackendBuilder
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. final def bindAny(host: String): Self
    Definition Classes
    ServerBuilder
  7. final def bindHttp(port: Int, host: String): Self
    Definition Classes
    ServerBuilder
  8. final def bindLocal(port: Int): Self
    Definition Classes
    ServerBuilder
  9. def bindSocketAddress(socketAddress: InetSocketAddress): Self
    Definition Classes
    BlazeServerBuilder → ServerBuilder
  10. def channelOption[A](socketOption: SocketOption[A]): Option[A]
    Definition Classes
    BlazeBackendBuilder
  11. val channelOptions: ChannelOptions
    Definition Classes
    BlazeServerBuilder → BlazeBackendBuilder
  12. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  13. def enableHttp2(enabled: Boolean): Self
  14. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  16. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  17. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  18. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  19. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  20. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  21. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  22. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  23. def resource: Resource[F, Server]
    Definition Classes
    BlazeServerBuilder → ServerBuilder → BackendBuilder
  24. final def serve: Stream[F, ExitCode]
    Definition Classes
    ServerBuilder
  25. final def serveWhile(terminateWhenTrue: Signal[F, Boolean], exitWith: Ref[F, ExitCode]): Stream[F, ExitCode]
    Definition Classes
    ServerBuilder
  26. def socketKeepAlive: Option[Boolean]
    Definition Classes
    BlazeBackendBuilder
  27. def socketReceiveBufferSize: Option[Int]
    Definition Classes
    BlazeBackendBuilder
  28. def socketReuseAddress: Option[Boolean]
    Definition Classes
    BlazeBackendBuilder
  29. def socketSendBufferSize: Option[Int]
    Definition Classes
    BlazeBackendBuilder
  30. def stream: Stream[F, Server]
    Definition Classes
    BackendBuilder
  31. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  32. def tcpNoDelay: Option[Boolean]
    Definition Classes
    BlazeBackendBuilder
  33. def toString(): String
    Definition Classes
    AnyRef → Any
  34. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  35. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  36. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  37. def withBanner(banner: Seq[String]): Self
    Definition Classes
    BlazeServerBuilder → ServerBuilder
  38. def withBufferSize(size: Int): Self
  39. def withChannelOption[A](key: SocketOption[A], value: A): Self
    Definition Classes
    BlazeBackendBuilder
  40. def withChannelOptions(channelOptions: ChannelOptions): BlazeServerBuilder[F]
    Definition Classes
    BlazeServerBuilder → BlazeBackendBuilder
  41. def withChunkBufferMaxSize(chunkBufferMaxSize: Int): BlazeServerBuilder[F]
  42. def withConnectorPoolSize(size: Int): Self
  43. def withDefaultChannelOption[A](key: SocketOption[A]): Self
    Definition Classes
    BlazeBackendBuilder
  44. def withDefaultSocketKeepAlive: Self
    Definition Classes
    BlazeBackendBuilder
  45. def withDefaultSocketReceiveBufferSize: Self
    Definition Classes
    BlazeBackendBuilder
  46. def withDefaultSocketReuseAddress: Self
    Definition Classes
    BlazeBackendBuilder
  47. def withDefaultSocketSendBufferSize: Self
    Definition Classes
    BlazeBackendBuilder
  48. def withDefaultTcpNoDelay: Self
    Definition Classes
    BlazeBackendBuilder
  49. def withExecutionContext(executionContext: ExecutionContext): BlazeServerBuilder[F]

    Configures the compute thread pool used to process some async computations.

    Configures the compute thread pool used to process some async computations.

    This defaults to cats.effect.Async[F].executionContext. In almost all cases, it is desirable to use the default.

    The Blaze server has a single-threaded event loop receiver used for picking up tcp connections which is completely separate to this pool. Following picking up a tcp connection, Blaze shifts to a compute pool to process requests. The request processing logic specified by the HttpApp is executed on the cats.effect.Async[F].executionContext. Some of the other async computations involved in request processing are executed on this pool.

  50. def withHttpApp(httpApp: HttpApp[F]): Self
  51. def withHttpWebSocketApp(f: (WebSocketBuilder2[F]) => HttpApp[F]): Self
  52. def withIdleTimeout(idleTimeout: Duration): Self
  53. def withLengthLimits(maxRequestLineLen: Int = maxRequestLineLen, maxHeadersLen: Int = maxHeadersLen): Self

    Configure HTTP parser length limits

    Configure HTTP parser length limits

    These are to avoid denial of service attacks due to, for example, an infinite request line.

    maxRequestLineLen

    maximum request line to parse

    maxHeadersLen

    maximum data that compose headers

  54. def withMaxConnections(maxConnections: Int): BlazeServerBuilder[F]
  55. def withMaxHeadersLength(maxHeadersLength: Int): BlazeServerBuilder[F]
  56. def withMaxRequestLineLength(maxRequestLineLength: Int): BlazeServerBuilder[F]
  57. def withMaxWebSocketBufferSize(maxWebSocketBufferSize: Option[Int]): BlazeServerBuilder[F]
  58. def withResponseHeaderTimeout(responseHeaderTimeout: Duration): Self
  59. def withSelectorThreadFactory(selectorThreadFactory: ThreadFactory): Self
  60. def withServiceErrorHandler(serviceErrorHandler: ServiceErrorHandler[F]): Self
    Definition Classes
    BlazeServerBuilder → ServerBuilder
  61. def withSocketKeepAlive(socketKeepAlive: Boolean): Self
    Definition Classes
    BlazeBackendBuilder
  62. def withSocketReceiveBufferSize(socketReceiveBufferSize: Int): Self
    Definition Classes
    BlazeBackendBuilder
  63. def withSocketReuseAddress(socketReuseAddress: Boolean): Self
    Definition Classes
    BlazeBackendBuilder
  64. def withSocketSendBufferSize(socketSendBufferSize: Int): Self
    Definition Classes
    BlazeBackendBuilder
  65. def withSslContext(sslContext: SSLContext): Self

    Configures the server with TLS, using the provided SSLContext and its default SSLParameters

  66. def withSslContextAndParameters(sslContext: SSLContext, sslParameters: SSLParameters): Self

    Configures the server with TLS, using the provided SSLContext and SSLParameters.

  67. def withTcpNoDelay(tcpNoDelay: Boolean): Self
    Definition Classes
    BlazeBackendBuilder
  68. final def withoutBanner: Self
    Definition Classes
    ServerBuilder
  69. def withoutSsl: Self

Deprecated Value Members

  1. def allocated: F[(Server, F[Unit])]
    Definition Classes
    BackendBuilder
    Annotations
    @deprecated
    Deprecated

    (Since version 0.23.14) Use manually called '.resource.allocated' instead. Will be removed from public API in 1.0.

  2. def withSSL(keyStore: StoreInfo, keyManagerPassword: String, protocol: String = "TLS", trustStore: Option[StoreInfo] = None, clientAuth: SSLClientAuthMode = SSLClientAuthMode.NotRequested): Self
    Annotations
    @deprecated
    Deprecated

    (Since version 0.21.0-RC3) Build an SSLContext from the first four parameters and use withSslContext (note lowercase). To also request client certificates, use withSslContextAndParameters, calling either .setWantClientAuth(true) or setNeedClientAuth(true) on the SSLParameters.

  3. def withSSLContext(sslContext: SSLContext, clientAuth: SSLClientAuthMode = SSLClientAuthMode.NotRequested): Self
    Annotations
    @deprecated
    Deprecated

    (Since version 0.21.0-RC3) Use withSslContext (note lowercase). To request client certificates, use withSslContextAndParameters, calling either .setWantClientAuth(true) or setNeedClientAuth(true) on the SSLParameters.

  4. def withWebSockets(enableWebsockets: Boolean): Self
    Annotations
    @deprecated
    Deprecated

    (Since version 0.23) This operation is a no-op. WebSockets are always enabled.

Inherited from BlazeBackendBuilder[Server]

Inherited from ServerBuilder[F]

Inherited from BackendBuilder[F, Server]

Inherited from AnyRef

Inherited from Any

Ungrouped