import"nsIHttpServer.idl";
Public Member Functions | |
| string | getHeader (in string fieldName) |
| boolean | hasHeader (in string fieldName) |
Public Attributes | |
| readonly attribute string | method |
| readonly attribute string | scheme |
| readonly attribute string | host |
| readonly attribute unsigned long | port |
| readonly attribute string | path |
| readonly attribute string | queryString |
| readonly attribute string | httpVersion |
| readonly attribute nsISimpleEnumerator | headers |
| readonly attribute nsIInputStream | bodyInputStream |
A representation of the data included in an HTTP request.
Definition at line 412 of file nsIHttpServer.idl.
Returns the value for the header in this request specified by fieldName.
| fieldName | the name of the field whose value is to be gotten; note that since HTTP header field names are case-insensitive, this method produces equivalent results for "HeAdER" and "hEADer" as fieldName |
| NS_ERROR_INVALID_ARG | if fieldName does not constitute a valid header field name |
| NS_ERROR_NOT_AVAILABLE | if the given header does not exist in this |
| boolean nsIHttpRequestMetadata::hasHeader | ( | in string | fieldName | ) |
Returns true if a header with the given field name exists in this, false otherwise.
| fieldName | the field name whose existence is to be determined in this; note that since HTTP header field names are case-insensitive, this method produces equivalent results for "HeAdER" and "hEADer" as fieldName |
| NS_ERROR_INVALID_ARG | if fieldName does not constitute a valid header field name |
| readonly attribute nsIInputStream nsIHttpRequestMetadata::bodyInputStream |
A stream from which data appearing in the body of this request can be read.
Definition at line 505 of file nsIHttpServer.idl.
| readonly attribute nsISimpleEnumerator nsIHttpRequestMetadata::headers |
An nsISimpleEnumerator of nsISupportsStrings over the names of the headers in this request. The header field names in the enumerator may not necessarily have the same case as they do in the request itself.
Definition at line 500 of file nsIHttpServer.idl.
| readonly attribute string nsIHttpRequestMetadata::host |
The host of the data being requested (e.g. "localhost" for the http://localhost:8080/file resource). Note that the relevant port on the host is specified in this.port. This value is in the ASCII character encoding.
Definition at line 434 of file nsIHttpServer.idl.
| readonly attribute string nsIHttpRequestMetadata::httpVersion |
A string containing the HTTP version of the request (i.e., "1.1"). Leading zeros for either component of the version will be omitted. (In other words, if the request contains the version "1.01", this attribute will be "1.1"; see RFC 2616, section 3.1.)
Definition at line 460 of file nsIHttpServer.idl.
| readonly attribute string nsIHttpRequestMetadata::method |
The request type for this request (see RFC 2616, section 5.1.1).
Definition at line 417 of file nsIHttpServer.idl.
| readonly attribute string nsIHttpRequestMetadata::path |
The requested path, without any query string (e.g. "/dir/file.txt"). It is guaranteed to begin with a "/". The individual components in this string are URL-encoded.
Definition at line 446 of file nsIHttpServer.idl.
| readonly attribute unsigned long nsIHttpRequestMetadata::port |
The port on the server on which the request was received.
Definition at line 439 of file nsIHttpServer.idl.
| readonly attribute string nsIHttpRequestMetadata::queryString |
The URL-encoded query string associated with this request, not including the initial "?", or "" if no query string was present.
Definition at line 452 of file nsIHttpServer.idl.
| readonly attribute string nsIHttpRequestMetadata::scheme |
The scheme of the requested path, usually 'http' but might possibly be 'https' if some form of SSL tunneling is in use. Note that this value cannot be accurately determined unless the incoming request used the absolute-path form of the request line; it defaults to 'http', so only if it is something else can you be entirely certain it's correct.
Definition at line 426 of file nsIHttpServer.idl.
