Module ringo/httpserver
A wrapper for the Jetty HTTP server.
Functions
Class Context
Instance Methods
- addServlet(servletPath, servlet, initParams)
- addWebSocket(path, onconnect)
- serveApplication(app, engine)
- serveStatic(dir)
Class Server
Instance Methods
- destroy()
- getContext(path, virtualHosts, options)
- getDefaultContext()
- getJetty()
- isRunning()
- start()
- stop()
Context
Not exported as constructor by this module.
Context.prototype. addServlet (servletPath, servlet, initParams)
Map a request path within this context to the given servlet.
Parameters
| string | servletPath | the servlet path |
| Servlet | servlet | a java object implementing the javax.servlet.Servlet interface. |
| Object | initParams | optional object containing servlet init parameters |
Context.prototype. addWebSocket (path, onconnect)
Start accepting WebSocket connections in this context context.
Parameters
| String | path | The URL path on which to accept WebSocket connections |
| Function | onconnect | a function called for each new WebSocket connection with the WebSocket object as argument. |
See
Context.prototype. serveApplication (app, engine)
Map this context to a JSGI application.
Parameters
| function|object | app | a JSGI application, either as a function
or an object with properties { appModule: 'main', appName: 'app' } |
| RhinoEngine | engine | optional RhinoEngine instance for multi-engine setups |
Context.prototype. serveStatic (dir)
Map this context to a directory containing static resources.
Parameters
| string | dir | the directory from which to serve static resources |
Server (options)
Create a Jetty HTTP server with the given options. The options may either define properties to be used with the default jetty.xml, or define a custom configuration file.
Parameters
| Object | options | A javascript object with any of the following properties (default values in parentheses):
For convenience, the constructor supports the definition of a JSGI application and static resource mapping in the options object using the following properties:
|
Server.prototype. destroy ()
Destroy the HTTP server, freeing its resources.
Server.prototype. getContext (path, virtualHosts, options)
Get a servlet application [context][#Context] for the given path and virtual hosts, creating it if it doesn't exist.
Parameters
| string | path | the context root path such as "/" or "/app" |
| string|array | virtualHosts | optional single or multiple virtual host names. A virtual host may start with a "*." wildcard. |
| Object | options | may have the following properties: sessions: true to enable sessions for this context, false otherwise security: true to enable security for this context, false otherwise cookieName: optional cookie name cookieDomain: optional cookie domain cookiePath: optional cookie path httpOnlyCookies: true to enable http-only session cookies secureCookies: true to enable secure session cookies |
Returns
a Context object |
See
Server.prototype. getDefaultContext ()
Get the server's default [context][#Context]. The default context is the context that is created when the server is created.
Returns
the default Context |
See
Server.prototype. isRunning ()
Checks whether this server is currently running.
Returns
true if the server is running, false otherwise. |
Server.prototype. start ()
Start the HTTP server.
Server.prototype. stop ()
Stop the HTTP server.
WebSocket
Provides support for WebSockets in the HTTP server.
WebSocket is an event emitter that supports the following events:
- open: called when a new websocket connection is accepted
- message: Called with a complete text message when all fragments have been received.
- close: called when an established websocket connection closes
WebSocket.prototype. close ()
Closes the WebSocket connection.
WebSocket.prototype. isOpen ()
Check whether the WebSocket is open.
Returns
| Boolean | true if the connection is open |
WebSocket.prototype. sendBinary (bytearray, offset, length)
Send a byte array over the WebSocket.
Parameters
| ByteArray | bytearray | The byte array to send |
| Number | offset | Optional offset (defaults to zero) |
| Number | length | Optional length (defaults to the length of the byte array) |
destroy ()
Daemon life cycle function invoked by init script. Frees any resources
occupied by the Server instance. If the application exports a function
called destroy, it will be invoked with the server as argument.
Returns
| Server | the Server instance. |
init (appPath)
Daemon life cycle function invoked by init script. Creates a new Server with
the application at appPath. If the application exports a function called
init, it will be invoked with the new server as argument.
Parameters
| null | appPath | {string} optional application file name or module id.
If undefined, the first command line argument will be used as application.
If there are no command line arguments, module |
Returns
| Server | the Server instance. |
main (appPath)
Main function to start an HTTP server from the command line.
Parameters
| String | appPath | optional application file name or module id. |
Returns
| Server | the Server instance. |
start ()
Daemon life cycle function invoked by init script. Starts the Server created
by init(). If the application exports a function called start, it will be
invoked with the server as argument immediately after it has started.
Returns
| Server | the Server instance. |
stop ()
Daemon life cycle function invoked by init script. Stops the Server started
by start().
Returns
| Server | the Server instance. If the application exports a function
called |