nsIHttpServer Interface Reference

import "nsIHttpServer.idl";

Inheritance diagram for nsIHttpServer:

Collaboration diagram for nsIHttpServer:

List of all members.

Public Member Functions

void start (in long port)

Starts up this server, listening upon the given port.

void stop ()

Shuts down this server if it is running; if it is not, this method is a no-op.

void registerFile (in string path, in nsILocalFile file)

Associates the local file represented by the string file with all requests which match request.

void registerPathHandler (in string path, in nsIHttpRequestHandler handler)

Registers a custom path handler.

void registerErrorHandler (in unsigned long code, in nsIHttpRequestHandler handler)

Registers a custom error page handler.

void registerDirectory (in string path, in nsILocalFile dir)

Maps all requests to paths beneath path to the corresponding file beneath dir.

void registerContentType (in string extension, in string type)

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.

void setIndexHandler (in nsIHttpRequestHandler handler)

Sets the handler used to display the contents of a directory if the directory contains no index page.

Member Function Documentation

void nsIHttpServer::start ( in long port )

This method may throw if the process does not have sufficient privileges to open a socket for the given port, and it also throws when called upon a server which has already been started.

Parameters:

port

the port upon which listening should happen, or -1 if no specific port is desired

void nsIHttpServer::stop ( )

This method will do its best to return after the socket in this server has been closed and all pending requests have completed being served, but this may or may not actually happen, since in some implementations this may not actually be possible. Implementations which can make this promise should make it explicit in implementation documentation.

void nsIHttpServer::registerFile	(	in string	path,
		in nsILocalFile	file
	)

Parameters:

	path	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.)
	file	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

void nsIHttpServer::registerPathHandler	(	in string	path,
		in nsIHttpRequestHandler	handler
	)

Parameters:

	path	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
	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

Exceptions:

NS_ERROR_INVALID_ARG

if path does not begin with a "/"

void nsIHttpServer::registerErrorHandler	(	in unsigned long	code,
		in nsIHttpRequestHandler	handler
	)

Parameters:

	code	the error code which is to be handled by handler
	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.

Note:: If the error handler handles HTTP 500 and throws, behavior is undefined.

void nsIHttpServer::registerDirectory	(	in string	path,
		in nsILocalFile	dir
	)

Parameters:

	path	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
	dir	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

Exceptions:

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

void nsIHttpServer::registerContentType	(	in string	extension,
		in string	type
	)

If type is empty, removes any extant mapping, if one is present.

Exceptions:

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

Note:: 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.

void nsIHttpServer::setIndexHandler ( in nsIHttpRequestHandler handler )

Parameters:

handler

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".

The documentation for this interface was generated from the following file:

netwerk/test/httpserver/nsIHttpServer.idl


Public Member Functions
void	start (in long port)
	Starts up this server, listening upon the given port.
void	stop ()
	Shuts down this server if it is running; if it is not, this method is a no-op.
void	registerFile (in string path, in nsILocalFile file)
	Associates the local file represented by the string file with all requests which match request.
void	registerPathHandler (in string path, in nsIHttpRequestHandler handler)
	Registers a custom path handler.
void	registerErrorHandler (in unsigned long code, in nsIHttpRequestHandler handler)
	Registers a custom error page handler.
void	registerDirectory (in string path, in nsILocalFile dir)
	Maps all requests to paths beneath path to the corresponding file beneath dir.
void	registerContentType (in string extension, in string type)
	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.
void	setIndexHandler (in nsIHttpRequestHandler handler)
	Sets the handler used to display the contents of a directory if the directory contains no index page.