ServerBuilderOps

final class ServerBuilderOps[SB <: ServerBuilder[SB]](val builder: SB) extends AnyVal
class AnyVal
trait Matchable
class Any

Value members

Methods

def resource[F[_]](F: Sync[F]): Resource[F, Server]

Builds a Server into a bracketed resource. The server is shut down when the resource is released. Shutdown is as follows:

  1. We request an orderly shutdown, allowing preexisting calls to continue without accepting new calls.
  2. We block for up to 30 seconds on termination, using the blocking context
  3. If the server is not yet terminated, we trigger a forceful shutdown

For different tradeoffs in shutdown behavior, see {{resourceWithShutdown}}.

def resourceWithShutdown[F[_]](shutdown: Server => F[Unit])(F: Sync[F]): Resource[F, Server]

Builds a Server into a bracketed resource. The server is shut down when the resource is released.

Value Params
shutdown

Determines the behavior of the cleanup of the server, with respect to forceful vs. graceful shutdown and how to poll or block for termination.

def stream[F[_]](F: Async[F]): Stream[F, Server]

Builds a Server into a bracketed stream. The server is shut down when the stream is complete. Shutdown is as follows:

  1. We request an orderly shutdown, allowing preexisting calls to continue without accepting new calls.
  2. We block for up to 30 seconds on termination, using the blocking context
  3. If the server is not yet terminated, we trigger a forceful shutdown

For different tradeoffs in shutdown behavior, see {{streamWithShutdown}}.

def streamWithShutdown[F[_]](shutdown: Server => F[Unit])(F: Async[F]): Stream[F, Server]

Builds a Server into a bracketed stream. The server is shut down when the stream is complete.

Value Params
shutdown

Determines the behavior of the cleanup of the server, with respect to forceful vs. graceful shutdown and how to poll or block for termination.

Fields

val builder: SB