Packages

trait ServerBuilder[F[_]] extends AnyRef

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ServerBuilder
  2. AnyRef
  3. 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

Type Members

  1. abstract type Self <: ServerBuilder[F]

Abstract Value Members

  1. abstract def bindSocketAddress(socketAddress: InetSocketAddress): Self
  2. abstract 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.

  3. abstract def withBanner(banner: Seq[String]): Self

    Set the banner to display when the server starts up

  4. abstract 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.

Concrete Value Members

  1. final def bindAny(host: String = DefaultHost): Self
  2. final def bindHttp(port: Int = DefaultHttpPort, host: String = DefaultHost): Self
  3. final def bindLocal(port: Int): Self
  4. 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.

  5. 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.

  6. 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.

  7. final def withoutBanner: Self

    Disable the banner when the server starts up