ServerBuilder

org.http4s.server.ServerBuilder
trait ServerBuilder[F[_]]

Attributes

Source:
ServerBuilder.scala
Graph
Supertypes
class Object
trait Matchable
class Any

Members list

Concise view

Type members

Types

type Self <: ServerBuilder[F]

Attributes

Source:
ServerBuilder.scala

Value members

Abstract methods

Attributes

Source:
ServerBuilder.scala

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

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

Attributes

Source:
ServerBuilder.scala
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

Attributes

Source:
ServerBuilder.scala
def withServiceErrorHandler(serviceErrorHandler: Request[F] => PartialFunction[Throwable, F[Response[F]]]): Self

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.

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.

Attributes

Source:
ServerBuilder.scala

Concrete methods

final def bindAny(host: String): Self

Attributes

Source:
ServerBuilder.scala
final def bindHttp(port: Int, host: String): Self

Attributes

Source:
ServerBuilder.scala
final def bindLocal(port: Int): Self

Attributes

Source:
ServerBuilder.scala
final def serve: Stream[F, ExitCode]

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

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

Attributes

Source:
ServerBuilder.scala
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. Useful for servers with associated lifetime behaviors.

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

Attributes

Source:
ServerBuilder.scala
final def withoutBanner: Self

Disable the banner when the server starts up

Disable the banner when the server starts up

Attributes

Source:
ServerBuilder.scala

Inherited methods

def stream: Stream[F, A]

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.

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.

Attributes

Inherited from:
BackendBuilder (hidden)
Source:
BackendBuilder.scala

Implicits

Implicits

implicit protected def F: Concurrent[F]

Attributes

Source:
ServerBuilder.scala