ServletContainer

Instance Constructors

new ServletContainer()(implicit arg0: Async[F])

Type Members

abstract type Self <: ServletContainer[F]

Definition Classes
ServletContainer → ServerBuilder

Abstract Value Members

abstract def bindSocketAddress(socketAddress: InetSocketAddress): Self

Definition Classes
ServerBuilder
abstract def mountFilter(filter: Filter, urlMapping: String, name: Option[String] = None, 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 HttpService, 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.
abstract def mountService(service: HttpService[F], prefix: String): Self

Definition Classes
ServerBuilder
abstract def mountServlet(servlet: HttpServlet, urlMapping: String, name: Option[String] = None): Self

Mounts a servlet to the server.
Mounts a servlet to the server.
The http4s way is to create an HttpService, 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.
abstract def start: F[Server[F]]

Definition Classes
ServerBuilder
abstract def withAsyncTimeout(asyncTimeout: Duration): Self

Definition Classes
AsyncTimeoutSupport
abstract def withBanner(banner: Seq[String]): Self

Definition Classes
ServerBuilder
abstract def withExecutionContext(executionContext: ExecutionContext): Self

Definition Classes
ServerBuilder
abstract def withServiceErrorHandler(serviceErrorHandler: ServiceErrorHandler[F]): Self

Definition Classes
ServerBuilder
abstract def withServletIo(servletIo: ServletIo[F]): Self

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

See also
org.http4s.servlet.ServletIo

Concrete Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
final def bindAny(host: String): Self

Definition Classes
ServerBuilder
final def bindHttp(port: Int, host: String): Self

Definition Classes
ServerBuilder
final def bindLocal(port: Int): Self

Definition Classes
ServerBuilder
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
final def serve(implicit F: Effect[F], ec: ExecutionContext): Stream[F, ExitCode]

Definition Classes
ServerBuilder
final def serveWhile(terminateWhenTrue: Signal[F, Boolean], exitWith: Ref[F, ExitCode]): Stream[F, ExitCode]

Definition Classes
ServerBuilder
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def withoutBanner: Self

Definition Classes
ServerBuilder

Deprecated Value Members

def withExecutorService(executorService: ExecutorService): Self

Definition Classes
ServerBuilder
Annotations
@deprecated
Deprecated
(Since version 0.17) Use withExecutionContext
def withServiceExecutor(executorService: ExecutorService): Self

Definition Classes
ServerBuilder
Annotations
@deprecated
Deprecated
(Since version 0.17.0) Use withExecutionContext

Related Docs: object ServletContainer | package servlet

abstract class ServletContainer[F[_]] extends ServerBuilder[F] with AsyncTimeoutSupport[F]

Instance Constructors

new ServletContainer()(implicit arg0: Async[F])

Type Members

abstract type Self <: ServletContainer[F]

Abstract Value Members

abstract def bindSocketAddress(socketAddress: InetSocketAddress): Self

abstract def mountFilter(filter: Filter, urlMapping: String, name: Option[String] = None, dispatches: EnumSet[DispatcherType] = ...): Self

abstract def mountService(service: HttpService[F], prefix: String): Self

abstract def mountServlet(servlet: HttpServlet, urlMapping: String, name: Option[String] = None): Self

abstract def start: F[Server[F]]

abstract def withAsyncTimeout(asyncTimeout: Duration): Self

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

abstract def withExecutionContext(executionContext: ExecutionContext): Self

abstract def withServiceErrorHandler(serviceErrorHandler: ServiceErrorHandler[F]): Self

abstract def withServletIo(servletIo: ServletIo[F]): Self

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

final def bindAny(host: String): Self

final def bindHttp(port: Int, host: String): Self

final def bindLocal(port: Int): Self

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

final def serve(implicit F: Effect[F], ec: ExecutionContext): Stream[F, ExitCode]

final def serveWhile(terminateWhenTrue: Signal[F, Boolean], exitWith: Ref[F, ExitCode]): Stream[F, ExitCode]

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

final def withoutBanner: Self

Deprecated Value Members

def withExecutorService(executorService: ExecutorService): Self

def withServiceExecutor(executorService: ExecutorService): Self

Inherited from AsyncTimeoutSupport[F]

Inherited from ServerBuilder[F]

Inherited from AnyRef

Inherited from Any

Ungrouped