Server

An HTTP server.

val eventuallyContent = server(Get("/hello")).flatMap { response =>
  response.readAs[String]
}

An HTTP server is a service function. It handles HTTP requests and eventually returns HTTP responses.

The server listen for HTTP connections on the socketAddress TCP socket. If ssl is defined, it supports TLS connections. Calling the stop operation asks for a graceful shutdown.

Linear Supertypes

(Request) ⇒ Future[Response], AnyRef, Any

Abstract Value Members

abstract def apply(v1: Request): Future[Response]

Definition Classes
Function1
abstract def options: ServerOptions

returns
the server options such as the number of IO thread used.
abstract def socketAddress: InetSocketAddress

returns
the underlying server socket.
abstract def ssl: Option[Configuration]

returns
the SSL configuration if enabled.
abstract def stop(quietPeriod: Duration = 2 seconds, timeout: Duration = 15 seconds): Future[Unit]

Stop this server instance gracefully.
Stop this server instance gracefully. It ensures that no requests are handled for 'the quiet period' (usually a couple seconds) before it shuts itself down. If a request is submitted during the quiet period, it is guaranteed to be accepted and the quiet period will start over.
quietPeriod
The quiet period for the graceful shutdown.
timeout
The maximum amount of time to wait until the server is shutdown regardless of the quiet period.
returns
a Future resolved as soon as the server is shutdown.

Concrete Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def andThen[A](g: (Future[Response]) ⇒ A): (Request) ⇒ A

Definition Classes
Function1
Annotations
@unspecialized()
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def compose[A](g: (A) ⇒ Request): (A) ⇒ Future[Response]

Definition Classes
Function1
Annotations
@unspecialized()
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] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def port: Int

returns
the TCP port from the underlying server socket.
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
Server → Function1 → 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
@throws( ... )

Related Docs: object Server | package http

trait Server extends Service

Abstract Value Members

abstract def apply(v1: Request): Future[Response]

abstract def options: ServerOptions

abstract def socketAddress: InetSocketAddress

abstract def ssl: Option[Configuration]

abstract def stop(quietPeriod: Duration = 2 seconds, timeout: Duration = 15 seconds): Future[Unit]

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

def andThen[A](g: (Future[Response]) ⇒ A): (Request) ⇒ A

final def asInstanceOf[T0]: T0

def clone(): AnyRef

def compose[A](g: (A) ⇒ Request): (A) ⇒ Future[Response]

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def port: Int

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

final def wait(): Unit

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

final def wait(arg0: Long): Unit

Inherited from (Request) ⇒ Future[Response]

Inherited from AnyRef

Inherited from Any

Ungrouped