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
  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 !=(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
    BlazeBuilder → 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
    BlazeBuilder → ServerBuilder
  11. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  12. def enableHttp2(enabled: Boolean): Self
  13. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  15. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  16. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  17. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  18. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  19. def mountService(service: HttpRoutes[F], prefix: String): Self
  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[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
  24. 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
  25. 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
  26. 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
  27. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  28. def toString(): String
    Definition Classes
    AnyRef → Any
  29. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  30. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  31. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  32. 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
  33. def withBufferSize(size: Int): Self
  34. def withConnectorPoolSize(size: Int): Self
  35. def withExecutionContext(executionContext: ExecutionContext): BlazeBuilder[F]
  36. def withIdleTimeout(idleTimeout: Duration): Self
  37. 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

  38. def withNio2(isNio2: Boolean): Self
  39. def withSSL(keyStore: StoreInfo, keyManagerPassword: String, protocol: String = "TLS", trustStore: Option[StoreInfo] = None, clientAuth: SSLClientAuthMode = SSLClientAuthMode.NotRequested): Self
  40. def withSSLContext(sslContext: SSLContext, clientAuth: SSLClientAuthMode = SSLClientAuthMode.NotRequested): Self
  41. 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
  42. def withWebSockets(enableWebsockets: Boolean): Self
  43. final def withoutBanner: Self

    Disable the banner when the server starts up

    Disable the banner when the server starts up

    Definition Classes
    ServerBuilder

Inherited from ServerBuilder[F]

Inherited from BackendBuilder[F, Server[F]]

Inherited from AnyRef

Inherited from Any

Ungrouped