Packages

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

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. JettyBuilder
  2. SSLContextSupport
  3. SSLKeyStoreSupport
  4. IdleTimeoutSupport
  5. ServletContainer
  6. AsyncTimeoutSupport
  7. ServerBuilder
  8. AnyRef
  9. 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 = JettyBuilder[F]
    Definition Classes
    JettyBuilder → ServletContainer → ServerBuilder

Value Members

  1. final def bindAny(host: String = DefaultHost): Self
    Definition Classes
    ServerBuilder
  2. final def bindHttp(port: Int = DefaultHttpPort, host: String = DefaultHost): Self
    Definition Classes
    ServerBuilder
  3. final def bindLocal(port: Int): Self
    Definition Classes
    ServerBuilder
  4. def bindSocketAddress(socketAddress: InetSocketAddress): Self
    Definition Classes
    JettyBuilder → ServerBuilder
  5. 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
    JettyBuilder → ServletContainer
  6. def mountService(service: HttpRoutes[F], prefix: String): Self
  7. 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
    JettyBuilder → ServletContainer
  8. 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
    JettyBuilder → ServerBuilder
  9. 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
  10. 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
  11. 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
  12. def withAsyncTimeout(asyncTimeout: Duration): Self
    Definition Classes
    JettyBuilder → AsyncTimeoutSupport
  13. 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
    JettyBuilder → ServerBuilder
  14. def withIdleTimeout(idleTimeout: Duration): Self
    Definition Classes
    JettyBuilder → IdleTimeoutSupport
  15. def withSSL(keyStore: StoreInfo, keyManagerPassword: String, protocol: String, trustStore: Option[StoreInfo], clientAuth: Boolean): Self
    Definition Classes
    JettyBuilder → SSLKeyStoreSupport
  16. def withSSLContext(sslContext: SSLContext, clientAuth: Boolean): Self
    Definition Classes
    JettyBuilder → SSLContextSupport
  17. 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
    JettyBuilder → ServerBuilder
  18. 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
    JettyBuilder → ServletContainer
    See also

    org.http4s.servlet.ServletIo

  19. def withThreadPool(threadPool: ThreadPool): JettyBuilder[F]
  20. final def withoutBanner: Self

    Disable the banner when the server starts up

    Disable the banner when the server starts up

    Definition Classes
    ServerBuilder