Packages

t

org.http4s.server

ServerApp

trait ServerApp extends AnyRef

Starts a server and gracefully terminates at shutdown. The server is terminated and the shutdown task is run either by a JVM shutdown hook or an invocation of requestShutdown().

If the server fails to start, the shutdown task is not invoked. More robust resource management is possible through ProcessApp or StreamApp, which are introduced in http4s-0.16 and http4s-0.17, respectively.

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ServerApp
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def server(args: List[String]): Task[Server]

    Return a server to run

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. final def main(args: Array[String]): Unit
  13. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. final def notify(): Unit
    Definition Classes
    AnyRef
  15. final def notifyAll(): Unit
    Definition Classes
    AnyRef
  16. def requestShutdown(): Unit

    Explicitly request a graceful shutdown of the service.

    Explicitly request a graceful shutdown of the service.

    There is no operational standard for this, but some common implementations include:

    • an admin port receiving a connection
    • a JMX command
    • monitoring a file
    • console input in an interactive session
  17. def shutdown(server: Server): Task[Unit]

    Return a task to shutdown the application.

    Return a task to shutdown the application.

    This task is run as a JVM shutdown hook, or when org.http4s.server.ServerApp.requestShutdown is explicitly called.

    The default implementation shuts down the server, and waits for it to finish. Other resources may shutdown by flatMapping this task.

  18. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  19. def toString(): String
    Definition Classes
    AnyRef → Any
  20. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  21. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  22. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped