nsIHttpRequestHandler Interface Reference

import "nsIHttpServer.idl";

Inheritance diagram for nsIHttpRequestHandler:

[legend]

Collaboration diagram for nsIHttpRequestHandler:

[legend]

List of all members.

---

Detailed Description

The handler is used by calling its .handle method with data for an incoming request; it is the handler's job to use that data as it sees fit to make the desired response.

Note:

This interface uses the [function] attribute, so you can pass a script-defined function with the functionality of handle() to any method which has a nsIHttpRequestHandler parameter, instead of wrapping it in an otherwise empty object.

Public Member Functions
void	handle (in nsIHttpRequestMetadata metadata, in nsIHttpResponse response)
	Processes the HTTP request represented by metadata and initializes the passed-in response to reflect the correct HTTP response.

---

Member Function Documentation

void nsIHttpRequestHandler::handle	(	in nsIHttpRequestMetadata	metadata,
		in nsIHttpResponse	response
	)

Note that in some uses of nsIHttpRequestHandler, this method is required to not throw an exception; in the general case, however, this method may throw an exception (causing an HTTP 500 response to occur).

Parameters:

	metadata	data representing an HTTP request
	response	an initially-empty response which must be modified to reflect the data which should be sent as the response to the request described by metadata

---

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

• netwerk/test/httpserver/nsIHttpServer.idl