Packages

sealed class TomcatBuilder[F[_]] extends ServletContainer[F] with ServerBuilder[F] with IdleTimeoutSupport[F] with SSLKeyStoreSupport[F]

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. TomcatBuilder
  2. SSLKeyStoreSupport
  3. IdleTimeoutSupport
  4. ServletContainer
  5. AsyncTimeoutSupport
  6. ServerBuilder
  7. AnyRef
  8. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. type Self = TomcatBuilder[F]
    Definition Classes
    TomcatBuilder → ServletContainer → ServerBuilder

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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. final def bindAny(host: String = DefaultHost): Self
    Definition Classes
    ServerBuilder
  8. final def bindHttp(port: Int = DefaultHttpPort, host: String = DefaultHost): Self
    Definition Classes
    ServerBuilder
  9. final def bindLocal(port: Int): Self
    Definition Classes
    ServerBuilder
  10. def bindSocketAddress(socketAddress: InetSocketAddress): Self
    Definition Classes
    TomcatBuilder → ServerBuilder
  11. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  12. 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
  13. 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
  14. 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
  15. 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
  16. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  18. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  19. 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()
  20. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  21. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  22. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  23. 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 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.

    Definition Classes
    TomcatBuilder → ServletContainer
  24. def mountService(service: HttpService[F], prefix: String): Self
    Definition Classes
    TomcatBuilder → ServerBuilder
  25. 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.

    Definition Classes
    TomcatBuilder → ServletContainer
  26. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  27. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  28. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  29. final def serve(implicit F: Effect[F], ec: ExecutionContext): 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
  30. 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
  31. def start: F[Server[F]]

    Returns a task to start a server.

    Returns a task to start a server. The task completes with a reference to the server when it has started.

    Definition Classes
    TomcatBuilder → ServerBuilder
  32. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  33. def toString(): String
    Definition Classes
    AnyRef → Any
  34. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  35. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  36. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  37. def withAsyncTimeout(asyncTimeout: Duration): Self
    Definition Classes
    TomcatBuilder → AsyncTimeoutSupport
  38. 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
  39. def withExecutionContext(executionContext: ExecutionContext): Self
    Definition Classes
    TomcatBuilder → ServerBuilder
  40. def withIdleTimeout(idleTimeout: Duration): Self
    Definition Classes
    TomcatBuilder → IdleTimeoutSupport
  41. def withSSL(keyStore: StoreInfo, keyManagerPassword: String, protocol: String, trustStore: Option[StoreInfo], clientAuth: Boolean): Self
    Definition Classes
    TomcatBuilder → SSLKeyStoreSupport
  42. 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
  43. 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

  44. final def withoutBanner: Self

    Disable the banner when the server starts up

    Disable the banner when the server starts up

    Definition Classes
    ServerBuilder
  45. 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

Deprecated Value Members

  1. def withExecutorService(executorService: ExecutorService): Self
    Definition Classes
    ServerBuilder
    Annotations
    @deprecated
    Deprecated

    (Since version 0.17) Use withExecutionContext

  2. def withServiceExecutor(executorService: ExecutorService): Self
    Definition Classes
    ServerBuilder
    Annotations
    @deprecated
    Deprecated

    (Since version 0.17.0) Use withExecutionContext

Inherited from SSLKeyStoreSupport[F]

Inherited from IdleTimeoutSupport[F]

Inherited from ServletContainer[F]

Inherited from AsyncTimeoutSupport[F]

Inherited from ServerBuilder[F]

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from TomcatBuilder[F] to any2stringadd[TomcatBuilder[F]]

Inherited by implicit conversion StringFormat from TomcatBuilder[F] to StringFormat[TomcatBuilder[F]]

Inherited by implicit conversion Ensuring from TomcatBuilder[F] to Ensuring[TomcatBuilder[F]]

Inherited by implicit conversion ArrowAssoc from TomcatBuilder[F] to ArrowAssoc[TomcatBuilder[F]]

Ungrouped