abstract class ServletContainer[F[_]] extends ServerBuilder[F] with AsyncTimeoutSupport[F]
- Alphabetic
- By Inheritance
- ServletContainer
- AsyncTimeoutSupport
- ServerBuilder
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- All
Instance Constructors
- new ServletContainer()(implicit arg0: Async[F])
Type Members
-
abstract
type
Self <: ServletContainer[F]
- Definition Classes
- ServletContainer → ServerBuilder
Abstract Value Members
-
implicit abstract
def
F: Concurrent[F]
- Attributes
- protected
- Definition Classes
- ServerBuilder
-
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 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.
-
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 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.
-
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.
- Definition Classes
- ServerBuilder
-
abstract
def
withAsyncTimeout(asyncTimeout: Duration): Self
- Definition Classes
- AsyncTimeoutSupport
-
abstract
def
withBanner(banner: Seq[String]): Self
Set the banner to display when the server starts up
Set the banner to display when the server starts up
- Definition Classes
- ServerBuilder
-
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.
- 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
Concrete Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
def
+(other: String): String
- Implicit
- This member is added by an implicit conversion from ServletContainer[F] to any2stringadd[ServletContainer[F]] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
-
def
->[B](y: B): (ServletContainer[F], B)
- Implicit
- This member is added by an implicit conversion from ServletContainer[F] to ArrowAssoc[ServletContainer[F]] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @inline()
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
final
def
bindAny(host: String = DefaultHost): Self
- Definition Classes
- ServerBuilder
-
final
def
bindHttp(port: Int = DefaultHttpPort, host: String = DefaultHost): Self
- Definition Classes
- ServerBuilder
-
final
def
bindLocal(port: Int): Self
- Definition Classes
- ServerBuilder
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )
-
def
ensuring(cond: (ServletContainer[F]) ⇒ Boolean, msg: ⇒ Any): ServletContainer[F]
- Implicit
- This member is added by an implicit conversion from ServletContainer[F] to Ensuring[ServletContainer[F]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: (ServletContainer[F]) ⇒ Boolean): ServletContainer[F]
- Implicit
- This member is added by an implicit conversion from ServletContainer[F] to Ensuring[ServletContainer[F]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: Boolean, msg: ⇒ Any): ServletContainer[F]
- Implicit
- This member is added by an implicit conversion from ServletContainer[F] to Ensuring[ServletContainer[F]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: Boolean): ServletContainer[F]
- Implicit
- This member is added by an implicit conversion from ServletContainer[F] to Ensuring[ServletContainer[F]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
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] )
-
def
formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from ServletContainer[F] to StringFormat[ServletContainer[F]] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @inline()
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
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.
- Definition Classes
- ServerBuilder
-
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.
- Definition Classes
- ServerBuilder
-
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.
- 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
- @native() @throws( ... )
-
final
def
withoutBanner: Self
Disable the banner when the server starts up
Disable the banner when the server starts up
- Definition Classes
- ServerBuilder
-
def
→[B](y: B): (ServletContainer[F], B)
- Implicit
- This member is added by an implicit conversion from ServletContainer[F] to ArrowAssoc[ServletContainer[F]] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc