tomcat-server/org.http4s.tomcat.server/TomcatBuilder

TomcatBuilder

sealed class TomcatBuilder[F[_]] extends ServletContainer[F] with ServerBuilder[F]
Companion:
object
trait ServerBuilder[F]
class Object
trait Matchable
class Any

Type members

Types

Value members

Concrete methods

override def bindSocketAddress(socketAddress: InetSocketAddress): Self
Definition Classes
override def mountFilter(filter: Filter, urlMapping: String, name: Option[String], dispatches: EnumSet[DispatcherType]): Self
Definition Classes
def mountHttpApp(service: HttpApp[F], prefix: String): Self
def mountService(service: HttpRoutes[F], prefix: String): Self
override def mountServlet(servlet: HttpServlet, urlMapping: String, name: Option[String]): Self
Definition Classes
override def resource: Resource[F, Server]
Definition Classes
def withAsyncTimeout(asyncTimeout: Duration): Self
def withBanner(banner: Seq[String]): Self
def withClassloader(classloader: ClassLoader): Self
def withExternalExecutor(executor: Executor): TomcatBuilder[F]

Replace the protocol handler's internal executor with a custom, external executor

Replace the protocol handler's internal executor with a custom, external executor

def withIdleTimeout(idleTimeout: Duration): Self
def withInternalExecutor: TomcatBuilder[F]

Use Tomcat's internal executor

Use Tomcat's internal executor

def withSSL(keyStore: StoreInfo, keyManagerPassword: String, protocol: String, trustStore: Option[StoreInfo], clientAuth: SSLClientAuthMode): Self
def withServiceErrorHandler(serviceErrorHandler: () => F): Self
override def withServletIo(servletIo: ServletIo[F]): Self
Definition Classes

Inherited methods

def allocated: F[(Server, F[Unit])]

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.

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.

Inherited from:
BackendBuilder
final def bindAny(host: String): Self
Inherited from:
ServerBuilder
final def bindHttp(port: Int, host: String): Self
Inherited from:
ServerBuilder
final def bindLocal(port: Int): Self
Inherited from:
ServerBuilder
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.

Inherited from:
ServerBuilder
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.

Inherited from:
ServerBuilder
def stream: Stream[F, Server]

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.

Inherited from:
BackendBuilder
final def withoutBanner: Self

Disable the banner when the server starts up

Disable the banner when the server starts up

Inherited from:
ServerBuilder