Scurry/scurry.http/HttpServer

HttpServer

class HttpServer extends Router

Defines HTTP server.

class Router
class Object
trait Matchable
class Any

Value members

Constructors

def this(settings: Map[String, AnyRef])

Creates HTTP server using supplied settings.

Creates HTTP server using supplied settings.

Server Settings

The following provides example settings:

[
 host: 'localhost',
 port: 8443,
 ssl: [
   key: '/private/ssl/server.key',
   certificate: '/private/ssl/server.crt'
 ],
 logger: 'HttpServer', // i.e., logger name
 backlogSize: 50,
 queueSize: 32,
 poolSize: 8,
 bufferSize: 8192,
 readTimeout: 1000,
 headerLimit: 100,
 keepAlive: [
  timeout: 30,
  max: 5
 ]
]
Value parameters:
settings

server settings

Concrete methods

def getSettings(): ServerSettings

Gets server settings.

Gets server settings.

Note:

If server is not running, the returned settings do not necessarily represent the settings when server is started. That is, values that are not explicitly provided are eventually given default values.

def isRunning(): Boolean

Tests for running.

Tests for running.

def start(): Unit

Starts server.

Starts server.

def stop(): Unit

Stops server.

Stops server.

Inherited methods

def delete(path: String, handler: HttpRequest => AnyRef): HttpServer

Adds request handler for DELETE requests at specified path.

Adds request handler for DELETE requests at specified path.

Value parameters:
handler

request handler

path

request path

Returns:

this

Inherited from:
Router
@varargs
def files(path: String, source: AnyRef, defaults: String*): HttpServer

Mounts file server at specified path.

Mounts file server at specified path.

Value parameters:
defaults

default file names

path

request path

source

source directory

Returns:

this

Inherited from:
Router
def get(path: String, handler: HttpRequest => AnyRef): HttpServer

Adds request handler for GET requests at specified path.

Adds request handler for GET requests at specified path.

Value parameters:
handler

request handler

path

request path

Returns:

this

Inherited from:
Router
def incoming(path: String, methods: AnyRef, handler: HttpRequest => AnyRef): HttpServer

Adds request handler at specified path and request methods.

Adds request handler at specified path and request methods.

Value parameters:
handler

request handler

methods

request methods

path

request path

Returns:

this

Inherited from:
Router
def incoming(handler: HttpRequest => AnyRef): HttpServer

Adds request handler.

Adds request handler.

Value parameters:
handler

request handler

Returns:

this

Inherited from:
Router
def mountPath: String

Gets mount path.

Gets mount path.

Inherited from:
Router
def outgoing(filter: HttpResponse => AnyRef): HttpServer

Adds response filter.

Adds response filter.

Value parameters:
filter

response filter

Returns:

this

Inherited from:
Router
def post(path: String, handler: HttpRequest => AnyRef): HttpServer

Adds request handler for POST requests at specified path.

Adds request handler for POST requests at specified path.

Value parameters:
handler

request handler

path

request path

Returns:

this

Inherited from:
Router
def put(path: String, handler: HttpRequest => AnyRef): HttpServer

Adds request handler for PUT requests at specified path.

Adds request handler for PUT requests at specified path.

Value parameters:
handler

request handler

path

request path

Returns:

this

Inherited from:
Router
def recover(handler: (HttpRequest, Throwable) => AnyRef): HttpServer

Adds error handler.

Adds error handler.

Value parameters:
handler

error handler

Returns:

this

Inherited from:
Router
def route(path: String, module: Router => AnyRef): HttpServer

Mounts routing module at specified path.

Mounts routing module at specified path.

Value parameters:
module

routing module

path

request path

Returns:

this

Inherited from:
Router
def toAbsolutePath(path: String): String

Resolves router path to its absolute path.

Resolves router path to its absolute path.

Value parameters:
path

router path

Inherited from:
Router
def trigger[T](hook: AnyRef => T): HttpServer

Adds lifecycle hook.

Adds lifecycle hook.

Value parameters:
hook

lifecycle hook

Returns:

this

Inherited from:
Router
def websocket[T](path: String, handler: WebSocket => T): HttpServer

Adds websocket handler for requests at specified path.

Adds websocket handler for requests at specified path.

Value parameters:
handler

websocket handler

path

request path

Returns:

this

Inherited from:
Router