Readonly identityRepresents the locations at which this server is reachable.
Optional aInstancePtr: objectA run time mechanism for interface discovery.
NS_OK if the interface is supported by the associated instance, NS_NOINTERFACE if it is not.
aInstancePtr must not be null.
[in] A requested interface IID
[out] A pointer to an interface pointer to receive the result.
Retrieves the string associated with the given key in this, in entire-server saved state. All keys are initially associated with the empty string.
Associates files with the given extension with the given Content-Type when served by this server, in the absence of any file-specific information about the desired Content-Type. If type is empty, removes any extant mapping, if one is present.
NS_ERROR_INVALID_ARG if the given type is not a valid header field value, i.e. if it doesn't match the field-value production in RFC 2616
No syntax checking is done of the given type, beyond ensuring that it is a valid header field value. Behavior when not given a string matching the media-type production in RFC 2616 section 3.7 is undefined. Implementations may choose to define specific behavior for types which do not match the production, such as for CGI functionality.
Implementations MAY treat type as a trusted argument; users who fail to generate this string from trusted data risk security vulnerabilities.
Maps all requests to paths beneath path to the corresponding file beneath dir.
NS_ERROR_INVALID_ARG if dir is non-null and does not exist or is not a directory, or if path does not begin with and end with a forward slash
the absolute path on the server against which requests will be served from dir (e.g., "/", "/foo/", etc.); must begin and end with a forward slash
the directory to be used to serve all requests for paths underneath path (except those further overridden by another, deeper path registered with another directory); if null, any current mapping for the given path is removed
Registers a custom error page handler.
If the error handler handles HTTP 500 and throws, behavior is undefined.
the error code which is to be handled by handler
an object which will handle any requests which generate the given status code, or null to remove any existing handler. If the handler throws an exception during server operation, fallback is to the genericized error handler (the x00 version), then to 500, using a user-defined error handler if one exists or the server default handler otherwise. Fallback will never occur from a user-provided handler that throws to the same handler as provided by the server, e.g. a throwing user 404 falls back to 400, not a server-provided 404 that might not throw.
Associates the local file represented by the string file with all requests which match request.
the path which is to be mapped to the given file; must begin with "/" and be a valid URI path (i.e., no query string, hash reference, etc.)
the file to serve for the given path, or null to remove any mapping that might exist; this file must exist for the lifetime of the server
an optional object which can be used to handle any further changes.
Registers a custom path handler.
NS_ERROR_INVALID_ARG if path does not begin with a "/"
the path on the server (beginning with a "/") which is to be handled by handler; this path must not include a query string or hash component; it also should usually be canonicalized, since most browsers will do so before sending otherwise-matching requests
an object which will handle any requests for the given path, or null to remove any existing handler; if while the server is running the handler throws an exception while responding to a request, an HTTP 500 response will be returned
Registers a custom prefix handler.
NS_ERROR_INVALID_ARG if path does not begin with a "/" or does not end with a "/"
the path on the server (beginning and ending with "/") which is to be handled by handler; this path must not include a query string or hash component. All requests that start with this prefix will be directed to the given handler.
an object which will handle any requests for the given path, or null to remove any existing handler; if while the server is running the handler throws an exception while responding to a request, an HTTP 500 response will be returned
Sets the handler used to display the contents of a directory if the directory contains no index page.
an object which will handle any requests for directories which do not contain index pages, or null to reset to the default index handler; if while the server is running the handler throws an exception while responding to a request, an HTTP 500 response will be returned. An nsIFile corresponding to the directory is available from the metadata object passed to the handler, under the key "directory".
Sets the string associated with the given key in this, in entire-server saved state.
Starts up this server, listening upon the given port.
NS_ERROR_ALREADY_INITIALIZED if this server is already started
NS_ERROR_NOT_AVAILABLE if the server is not started and cannot be started on the desired port (perhaps because the port is already in use or because the process does not have privileges to do so)
Behavior is undefined if this method is called after stop() has been called on this but before the provided callback function has been called.
the port upon which listening should happen, or -1 if no specific port is desired
Starts up this server, listening upon the given port on a ipv6 adddress.
NS_ERROR_ALREADY_INITIALIZED if this server is already started
NS_ERROR_NOT_AVAILABLE if the server is not started and cannot be started on the desired port (perhaps because the port is already in use or because the process does not have privileges to do so)
Behavior is undefined if this method is called after stop() has been called on this but before the provided callback function has been called.
the port upon which listening should happen, or -1 if no specific port is desired
Shuts down this server if it is running (including the period of time after stop() has been called but before the provided callback has been called).
NS_ERROR_NULL_POINTER if callback is null
NS_ERROR_UNEXPECTED if this server is not running
an asynchronous callback used to notify the user when this server is stopped and all pending requests have been fully served
Generated using TypeDoc
An interface which represents an HTTP server.