Value Members

1.  final def !=(arg0: Any): Boolean

   Definition Classes

   AnyRef → Any

2.  final def ##(): Int

   Definition Classes

   AnyRef → Any

3.  def +(other: String): String

   Implicit

   This member is added by an implicit conversion from TomcatBuilder[F] to any2stringadd[TomcatBuilder[F]] performed by method any2stringadd in scala.Predef.

   Definition Classes

   any2stringadd

4.  def ->[B](y: B): (TomcatBuilder[F], B)

   Implicit

   This member is added by an implicit conversion from TomcatBuilder[F] to ArrowAssoc[TomcatBuilder[F]] performed by method ArrowAssoc in scala.Predef.

   Definition Classes

   ArrowAssoc

   Annotations

   @inline()

5.  final def ==(arg0: Any): Boolean

   Definition Classes

   AnyRef → Any

6.  implicit val F: ConcurrentEffect[F]

   Attributes

   protected

   Definition Classes

   TomcatBuilder → ServerBuilder → BackendBuilder

7.  def allocated: F[(Server[F], F[Unit])]

   Returns an effect that allocates a backend and an F[Unit] to release it.

   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.

   Definition Classes

   BackendBuilder

8.  final def asInstanceOf[T0]: T0

   Definition Classes

   Any

9.  final def bindAny(host: String = defaults.Host): Self

   Definition Classes

   ServerBuilder

10.  final def bindHttp(port: Int = defaults.HttpPort, host: String = defaults.Host): Self

    Definition Classes

    ServerBuilder

11.  final def bindLocal(port: Int): Self

    Definition Classes

    ServerBuilder

12.  def bindSocketAddress(socketAddress: InetSocketAddress): Self

    Definition Classes

    TomcatBuilder → ServerBuilder

13.  def clone(): AnyRef

    Attributes

    protected[lang]

    Definition Classes

    AnyRef

    Annotations

    @throws( ... ) @native()

14.  def ensuring(cond: (TomcatBuilder[F]) ⇒ Boolean, msg: ⇒ Any): TomcatBuilder[F]

    Implicit

    This member is added by an implicit conversion from TomcatBuilder[F] to Ensuring[TomcatBuilder[F]] performed by method Ensuring in scala.Predef.

    Definition Classes

    Ensuring

15.  def ensuring(cond: (TomcatBuilder[F]) ⇒ Boolean): TomcatBuilder[F]

    Implicit

    This member is added by an implicit conversion from TomcatBuilder[F] to Ensuring[TomcatBuilder[F]] performed by method Ensuring in scala.Predef.

    Definition Classes

    Ensuring

16.  def ensuring(cond: Boolean, msg: ⇒ Any): TomcatBuilder[F]

    Implicit

    This member is added by an implicit conversion from TomcatBuilder[F] to Ensuring[TomcatBuilder[F]] performed by method Ensuring in scala.Predef.

    Definition Classes

    Ensuring

17.  def ensuring(cond: Boolean): TomcatBuilder[F]

    Implicit

    This member is added by an implicit conversion from TomcatBuilder[F] to Ensuring[TomcatBuilder[F]] performed by method Ensuring in scala.Predef.

    Definition Classes

    Ensuring

18.  final def eq(arg0: AnyRef): Boolean

    Definition Classes

    AnyRef

19.  def equals(arg0: Any): Boolean

    Definition Classes

    AnyRef → Any

20.  def finalize(): Unit

    Attributes

    protected[lang]

    Definition Classes

    AnyRef

    Annotations

    @throws( classOf[java.lang.Throwable] )

21.  def formatted(fmtstr: String): String

    Implicit

    This member is added by an implicit conversion from TomcatBuilder[F] to StringFormat[TomcatBuilder[F]] performed by method StringFormat in scala.Predef.

    Definition Classes

    StringFormat

    Annotations

    @inline()

22.  final def getClass(): Class[_]

    Definition Classes

    AnyRef → Any

    Annotations

    @native()

23.  def hashCode(): Int

    Definition Classes

    AnyRef → Any

    Annotations

    @native()

24.  final def isInstanceOf[T0]: Boolean

    Definition Classes

    Any

25.  def mountFilter(filter: Filter, 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.

    Definition Classes

    TomcatBuilder → ServletContainer

26.  def mountService(service: HttpRoutes[F], prefix: String): Self
27.  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.

    Definition Classes

    TomcatBuilder → ServletContainer

28.  final def ne(arg0: AnyRef): Boolean

    Definition Classes

    AnyRef

29.  final def notify(): Unit

    Definition Classes

    AnyRef

    Annotations

    @native()

30.  final def notifyAll(): Unit

    Definition Classes

    AnyRef

    Annotations

    @native()

31.  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

    TomcatBuilder → ServerBuilder → BackendBuilder

32.  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

33.  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.

    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

34.  def stream: Stream[F, Server[F]]

    Returns the backend as a single-element stream.

    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.

    Definition Classes

    BackendBuilder

35.  final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes

    AnyRef

36.  def toString(): String

    Definition Classes

    AnyRef → Any

37.  final def wait(): Unit

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

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

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

39.  final def wait(arg0: Long): Unit

    Definition Classes

    AnyRef

    Annotations

    @throws( ... ) @native()

40.  def withAsyncTimeout(asyncTimeout: Duration): Self
41.  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

    TomcatBuilder → ServerBuilder

42.  def withExternalExecutor(executor: Executor): TomcatBuilder[F]

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

43.  def withIdleTimeout(idleTimeout: Duration): Self
44.  def withInternalExecutor: TomcatBuilder[F]

    Use Tomcat's internal executor

45.  def withSSL(keyStore: StoreInfo, keyManagerPassword: String, protocol: String = "TLS", trustStore: Option[StoreInfo] = None, clientAuth: SSLClientAuthMode = SSLClientAuthMode.NotRequested): Self
46.  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

    TomcatBuilder → ServerBuilder

47.  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.

    Definition Classes

    TomcatBuilder → ServletContainer

    See also

    org.http4s.servlet.ServletIo

48.  final def withoutBanner: Self

    Disable the banner when the server starts up

    Disable the banner when the server starts up

    Definition Classes

    ServerBuilder

49.  def →[B](y: B): (TomcatBuilder[F], B)

    Implicit

    This member is added by an implicit conversion from TomcatBuilder[F] to ArrowAssoc[TomcatBuilder[F]] performed by method ArrowAssoc in scala.Predef.

    Definition Classes

    ArrowAssoc