ServletContainer

org.http4s.servlet.ServletContainer
See theServletContainer companion object
abstract class ServletContainer[F[_]] extends ServerBuilder[F]

Attributes

Companion:
object
Source:
ServletContainer.scala
Graph
Supertypes
trait ServerBuilder[F]
class Object
trait Matchable
class Any

Members list

Concise view

Type members

Types

Attributes

Source:
ServletContainer.scala

Value members

Abstract methods

def mountFilter(filter: HttpFilter, urlMapping: String, name: Option[String], dispatches: EnumSet[DispatcherType]): Self

Mounts a filter to the server.

Mounts a filter to the server.

The http4s way is to create a middleware around an HttpRoutes, which runs not just on servlet containers, but all supported backends. This method is good for legacy scenarios, or for reusing parts of the servlet ecosystem for an app that is committed to running on a servlet container.

Attributes

Source:
ServletContainer.scala
def mountServlet(servlet: HttpServlet, urlMapping: String, name: Option[String]): Self

Mounts a servlet to the server.

Mounts a servlet to the server.

The http4s way is to create HttpRoutes, which runs not just on servlet containers, but all supported backends. This method is good for legacy scenarios, or for reusing parts of the servlet ecosystem for an app that is committed to running on a servlet container.

Attributes

Source:
ServletContainer.scala
def withServletIo(servletIo: ServletIo[F]): Self

Sets the servlet I/O mode for reads and writes within the servlet. Not to be confused with the server connectors.

Sets the servlet I/O mode for reads and writes within the servlet. Not to be confused with the server connectors.

Attributes

See also:
Source:
ServletContainer.scala

Inherited methods

final def bindAny(host: String): Self

Attributes

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

Attributes

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

Attributes

Inherited from:
ServerBuilder
Source:
ServerBuilder.scala
def bindSocketAddress(socketAddress: InetSocketAddress): Self

Attributes

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

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

Inherited from:
ServerBuilder
Source:
ServerBuilder.scala

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

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

Set the banner to display when the server starts up

Set the banner to display when the server starts up

Attributes

Inherited from:
ServerBuilder
Source:
ServerBuilder.scala

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

Inherited from:
ServerBuilder
Source:
ServerBuilder.scala
final def withoutBanner: Self

Disable the banner when the server starts up

Disable the banner when the server starts up

Attributes

Inherited from:
ServerBuilder
Source:
ServerBuilder.scala

Deprecated and Inherited methods

def allocated: F[(A, 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.

Attributes

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

Implicits

Inherited implicits

implicit protected def F: Concurrent[F]

Attributes

Inherited from:
ServerBuilder
Source:
ServerBuilder.scala