Packages

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

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

Variables:

Source
BlazeServerBuilder.scala
Linear Supertypes
BlazeBackendBuilder[Server[F]], ServerBuilder[F], BackendBuilder[F, Server[F]], 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. All

Instance Constructors

  1. new BlazeServerBuilder(socketAddress: InetSocketAddress, executionContext: ExecutionContext, responseHeaderTimeout: Duration, idleTimeout: Duration, isNio2: Boolean, connectorPoolSize: Int, bufferSize: Int, selectorThreadFactory: ThreadFactory, enableWebSockets: Boolean, sslConfig: SslConfig[F], isHttp2Enabled: Boolean, maxRequestLineLen: Int, maxHeadersLen: Int, chunkBufferMaxSize: Int, httpApp: HttpApp[F], serviceErrorHandler: ServiceErrorHandler[F], banner: Seq[String], maxConnections: Int, channelOptions: ChannelOptions)(implicit F: ConcurrentEffect[F], timer: Timer[F])
    Annotations
    @deprecated
    Deprecated

    (Since version 0.21.17) Use BlazeServerBuilder.apply and configure with with methods

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: ConcurrentEffect[F]
    Attributes
    protected
    Definition Classes
    BlazeServerBuilder → ServerBuilder → BackendBuilder
  5. def allocated: F[(Server[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. final def bindAny(host: String = defaults.IPv4Host): Self
    Definition Classes
    ServerBuilder
  8. final def bindHttp(port: Int = defaults.HttpPort, host: String = defaults.IPv4Host): Self
    Definition Classes
    ServerBuilder
  9. final def bindLocal(port: Int): Self
    Definition Classes
    ServerBuilder
  10. def bindSocketAddress(socketAddress: InetSocketAddress): Self
    Definition Classes
    BlazeServerBuilder → ServerBuilder
  11. def channelOption[A](socketOption: SocketOption[A]): Option[A]
    Definition Classes
    BlazeBackendBuilder
  12. val channelOptions: ChannelOptions
    Definition Classes
    BlazeServerBuilder → BlazeBackendBuilder
  13. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  14. def enableHttp2(enabled: Boolean): Self
  15. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  17. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  18. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  19. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  20. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  21. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  22. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  23. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  24. def resource: Resource[F, Server[F]]

    Returns a Server resource.

    Returns a Server resource. The resource is not acquired until the server is started and ready to accept requests.

    Definition Classes
    BlazeServerBuilder → ServerBuilder → BackendBuilder
  25. final def serve: Stream[F, ExitCode]

    Runs the server as a process that never emits.

    Runs the server as a process that never emits. Useful for a server that runs for the rest of the JVM's life.

    Definition Classes
    ServerBuilder
  26. final def serveWhile(terminateWhenTrue: Signal[F, Boolean], exitWith: Ref[F, ExitCode]): Stream[F, ExitCode]

    Runs the server as a Stream that emits only when the terminated signal becomes true.

    Runs the server as a Stream that emits only when the terminated signal becomes true. Useful for servers with associated lifetime behaviors.

    Definition Classes
    ServerBuilder
  27. def socketKeepAlive: Option[Boolean]
    Definition Classes
    BlazeBackendBuilder
  28. def socketReceiveBufferSize: Option[Int]
    Definition Classes
    BlazeBackendBuilder
  29. def socketReuseAddress: Option[Boolean]
    Definition Classes
    BlazeBackendBuilder
  30. def socketSendBufferSize: Option[Int]
    Definition Classes
    BlazeBackendBuilder
  31. def stream: Stream[F, Server[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
  32. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  33. def tcpNoDelay: Option[Boolean]
    Definition Classes
    BlazeBackendBuilder
  34. def toString(): String
    Definition Classes
    AnyRef → Any
  35. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  36. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  37. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  38. def withBanner(banner: Seq[String]): Self

    Set the banner to display when the server starts up

    Set the banner to display when the server starts up

    Definition Classes
    BlazeServerBuilder → ServerBuilder
  39. def withBufferSize(size: Int): Self
  40. def withChannelOption[A](key: SocketOption[A], value: A): Self
    Definition Classes
    BlazeBackendBuilder
  41. def withChannelOptions(channelOptions: ChannelOptions): BlazeServerBuilder[F]
    Definition Classes
    BlazeServerBuilder → BlazeBackendBuilder
  42. def withChunkBufferMaxSize(chunkBufferMaxSize: Int): BlazeServerBuilder[F]
  43. def withConnectorPoolSize(size: Int): Self
  44. def withDefaultChannelOption[A](key: SocketOption[A]): Self
    Definition Classes
    BlazeBackendBuilder
  45. def withDefaultSocketKeepAlive: Self
    Definition Classes
    BlazeBackendBuilder
  46. def withDefaultSocketReceiveBufferSize: Self
    Definition Classes
    BlazeBackendBuilder
  47. def withDefaultSocketReuseAddress: Self
    Definition Classes
    BlazeBackendBuilder
  48. def withDefaultSocketSendBufferSize: Self
    Definition Classes
    BlazeBackendBuilder
  49. def withDefaultTcpNoDelay: Self
    Definition Classes
    BlazeBackendBuilder
  50. def withExecutionContext(executionContext: ExecutionContext): BlazeServerBuilder[F]
  51. def withHttpApp(httpApp: 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 withResponseHeaderTimeout(responseHeaderTimeout: Duration): Self
  58. def withSelectorThreadFactory(selectorThreadFactory: ThreadFactory): Self
  59. def withServiceErrorHandler(serviceErrorHandler: ServiceErrorHandler[F]): Self

    Sets the handler for errors thrown invoking the service.

    Sets the handler for errors thrown invoking the service. Is not guaranteed to be invoked on errors on the server backend, such as parsing a request or handling a context timeout.

    Definition Classes
    BlazeServerBuilder → ServerBuilder
  60. def withSocketKeepAlive(socketKeepAlive: Boolean): Self
    Definition Classes
    BlazeBackendBuilder
  61. def withSocketReceiveBufferSize(socketReceiveBufferSize: Int): Self
    Definition Classes
    BlazeBackendBuilder
  62. def withSocketReuseAddress(socketReuseAddress: Boolean): Self
    Definition Classes
    BlazeBackendBuilder
  63. def withSocketSendBufferSize(socketSendBufferSize: Int): Self
    Definition Classes
    BlazeBackendBuilder
  64. def withSslContext(sslContext: SSLContext): Self

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

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

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

  66. def withTcpNoDelay(tcpNoDelay: Boolean): Self
    Definition Classes
    BlazeBackendBuilder
  67. def withWebSockets(enableWebsockets: Boolean): Self
  68. final def withoutBanner: Self

    Disable the banner when the server starts up

    Disable the banner when the server starts up

    Definition Classes
    ServerBuilder
  69. def withoutSsl: Self

Deprecated Value Members

  1. def withNio2(isNio2: Boolean): Self
    Annotations
    @deprecated
    Deprecated

    (Since version 0.21.17) NIO2 support in http4s-blaze-server will be removed in 0.22.

  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.

Inherited from BlazeBackendBuilder[Server[F]]

Inherited from ServerBuilder[F]

Inherited from BackendBuilder[F, Server[F]]

Inherited from AnyRef

Inherited from Any

Ungrouped