Packages

class BlazeBuilder[F[_]] extends ServerBuilder[F] with IdleTimeoutSupport[F] with SSLKeyStoreSupport[F] with SSLContextSupport[F] with server.WebSocketSupport[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
server.WebSocketSupport[F], SSLContextSupport[F], SSLKeyStoreSupport[F], IdleTimeoutSupport[F], ServerBuilder[F], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. BlazeBuilder
  2. WebSocketSupport
  3. SSLContextSupport
  4. SSLKeyStoreSupport
  5. IdleTimeoutSupport
  6. ServerBuilder
  7. AnyRef
  8. 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. final def bindAny(host: String = DefaultHost): Self
    Definition Classes
    ServerBuilder
  2. final def bindHttp(port: Int = DefaultHttpPort, host: String = DefaultHost): Self
    Definition Classes
    ServerBuilder
  3. final def bindLocal(port: Int): Self
    Definition Classes
    ServerBuilder
  4. def bindSocketAddress(socketAddress: InetSocketAddress): Self
    Definition Classes
    BlazeBuilder → ServerBuilder
  5. def enableHttp2(enabled: Boolean): Self
  6. def mountService(service: HttpRoutes[F], prefix: String): Self
  7. 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
  8. 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
  9. final def serveWhile(terminateWhenTrue: SignallingRef[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
  10. def stream: Stream[F, Server[F]]

    Returns a Server stream.

    Returns a Server stream. The stream does not emit until the server is started and ready to accept requests.

    Definition Classes
    ServerBuilder
  11. 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
  12. def withBufferSize(size: Int): Self
  13. def withConnectorPoolSize(size: Int): Self
  14. def withExecutionContext(executionContext: ExecutionContext): BlazeBuilder[F]
  15. def withIdleTimeout(idleTimeout: Duration): Self
    Definition Classes
    BlazeBuilder → IdleTimeoutSupport
  16. 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

  17. def withNio2(isNio2: Boolean): Self
  18. def withSSL(keyStore: StoreInfo, keyManagerPassword: String, protocol: String, trustStore: Option[StoreInfo], clientAuth: Boolean): Self
    Definition Classes
    BlazeBuilder → SSLKeyStoreSupport
  19. def withSSLContext(sslContext: SSLContext, clientAuth: Boolean): Self
    Definition Classes
    BlazeBuilder → SSLContextSupport
  20. 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
  21. def withWebSockets(enableWebsockets: Boolean): Self
    Definition Classes
    BlazeBuilder → WebSocketSupport
  22. final def withoutBanner: Self

    Disable the banner when the server starts up

    Disable the banner when the server starts up

    Definition Classes
    ServerBuilder