Packages

class BlazeBuilder[F[_]] extends ServerBuilder[F]

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

Variables:

Annotations
@deprecated
Deprecated

(Since version 0.19.0-M2) Use BlazeServerBuilder instead

Source
BlazeBuilder.scala
Linear Supertypes
ServerBuilder[F], BackendBuilder[F, Server[F]], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. BlazeBuilder
  2. ServerBuilder
  3. BackendBuilder
  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

Instance Constructors

  1. new BlazeBuilder(socketAddress: InetSocketAddress, executionContext: ExecutionContext, idleTimeout: Duration, isNio2: Boolean, connectorPoolSize: Int, bufferSize: Int, enableWebSockets: Boolean, sslBits: Option[SSLConfig], isHttp2Enabled: Boolean, maxRequestLineLen: Int, maxHeadersLen: Int, serviceMounts: Vector[ServiceMount[F]], serviceErrorHandler: ServiceErrorHandler[F], banner: Seq[String])(implicit F: ConcurrentEffect[F], timer: Timer[F])

Type Members

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

Value Members

  1. 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
  2. final def bindAny(host: String = defaults.Host): Self
    Definition Classes
    ServerBuilder
  3. final def bindHttp(port: Int = defaults.HttpPort, host: String = defaults.Host): Self
    Definition Classes
    ServerBuilder
  4. final def bindLocal(port: Int): Self
    Definition Classes
    ServerBuilder
  5. def bindSocketAddress(socketAddress: InetSocketAddress): Self
    Definition Classes
    BlazeBuilder → ServerBuilder
  6. def enableHttp2(enabled: Boolean): Self
  7. def mountService(service: HttpRoutes[F], prefix: String): Self
  8. 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
    BlazeBuilder → ServerBuilder → BackendBuilder
  9. 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
  10. 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
  11. 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
  12. 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
    BlazeBuilder → ServerBuilder
  13. def withBufferSize(size: Int): Self
  14. def withConnectorPoolSize(size: Int): Self
  15. def withExecutionContext(executionContext: ExecutionContext): BlazeBuilder[F]
  16. def withIdleTimeout(idleTimeout: Duration): Self
  17. 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

  18. def withNio2(isNio2: Boolean): Self
  19. def withSSL(keyStore: StoreInfo, keyManagerPassword: String, protocol: String = "TLS", trustStore: Option[StoreInfo] = None, clientAuth: SSLClientAuthMode = SSLClientAuthMode.NotRequested): Self
  20. def withSSLContext(sslContext: SSLContext, clientAuth: SSLClientAuthMode = SSLClientAuthMode.NotRequested): Self
  21. 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
    BlazeBuilder → ServerBuilder
  22. def withWebSockets(enableWebsockets: Boolean): Self
  23. final def withoutBanner: Self

    Disable the banner when the server starts up

    Disable the banner when the server starts up

    Definition Classes
    ServerBuilder