Public Member Functions | Public Attributes

nsIHttpServerIdentity Interface Reference

Represents a set of names for a server, one of which is the primary name for the server and the rest of which are secondary. More...

import "nsIHttpServer.idl";

List of all members.

Public Member Functions

void add (in string scheme, in string host, in long port)
 Adds a location at which this server may be accessed.
PRBool remove (in string scheme, in string host, in long port)
 Removes this name from the list of names by which the corresponding server is known.
PRBool has (in string scheme, in string host, in long port)
 Returns true if the given name is in this, false otherwise.
string getScheme (in string host, in long port)
 Returns the scheme for the name with the given host and port, if one is present; otherwise returns the empty string.
void setPrimary (in string scheme, in string host, in long port)
 Designates the given name as the primary name in this and adds it to this if it is not already present.

Public Attributes

readonly attribute string primaryScheme
 The primary scheme at which the corresponding server is located, defaulting to 'http'.
readonly attribute string primaryHost
 The primary name by which the corresponding server is known, defaulting to 'localhost'.
readonly attribute long primaryPort
 The primary port on which the corresponding server runs, defaulting to the associated server's port.

Detailed Description

Represents a set of names for a server, one of which is the primary name for the server and the rest of which are secondary.

By default every server will contain ("http", "localhost", port) and ("http", "127.0.0.1", port) as names, where port is what was provided to the corresponding server when started; however, except for their being removed when the corresponding server stops they have no special importance.


Member Function Documentation

void nsIHttpServerIdentity::add ( in string  scheme,
in string  host,
in long  port 
)

Adds a location at which this server may be accessed.

Exceptions:
NS_ERROR_ILLEGAL_VALUE if scheme or host do not match the scheme or host productions imported into RFC 2616 from RFC 2396, or if port is not a valid port number
string nsIHttpServerIdentity::getScheme ( in string  host,
in long  port 
)

Returns the scheme for the name with the given host and port, if one is present; otherwise returns the empty string.

Exceptions:
NS_ERROR_ILLEGAL_VALUE if host does not match the host production imported into RFC 2616 from RFC 2396, or if port is not a valid port number
PRBool nsIHttpServerIdentity::has ( in string  scheme,
in string  host,
in long  port 
)

Returns true if the given name is in this, false otherwise.

Exceptions:
NS_ERROR_ILLEGAL_VALUE if scheme or host do not match the scheme or host productions imported into RFC 2616 from RFC 2396, or if port is not a valid port number
PRBool nsIHttpServerIdentity::remove ( in string  scheme,
in string  host,
in long  port 
)

Removes this name from the list of names by which the corresponding server is known.

If name is also the primary name for the server, the primary name reverts to 'http://127.0.0.1' with the associated server's port.

Exceptions:
NS_ERROR_ILLEGAL_VALUE if scheme or host do not match the scheme or host productions imported into RFC 2616 from RFC 2396, or if port is not a valid port number
Returns:
true if the given name was a name for this server, false otherwise
void nsIHttpServerIdentity::setPrimary ( in string  scheme,
in string  host,
in long  port 
)

Designates the given name as the primary name in this and adds it to this if it is not already present.

Exceptions:
NS_ERROR_ILLEGAL_VALUE if scheme or host do not match the scheme or host productions imported into RFC 2616 from RFC 2396, or if port is not a valid port number

Member Data Documentation

readonly attribute string nsIHttpServerIdentity::primaryHost

The primary name by which the corresponding server is known, defaulting to 'localhost'.

This name will be the value of nsIHttpRequest.host for HTTP/1.0 requests.

This value is always set when the corresponding server is running. If the server is not running, this value is set only if it has been set to a non-default name using setPrimary. In this case reading this value will throw NS_ERROR_NOT_INITIALIZED.

readonly attribute long nsIHttpServerIdentity::primaryPort

The primary port on which the corresponding server runs, defaulting to the associated server's port.

This name will be the value of nsIHttpRequest.port for HTTP/1.0 requests.

This value is always set when the corresponding server is running. If the server is not running, this value is set only if it has been set to a non-default name using setPrimary. In this case reading this value will throw NS_ERROR_NOT_INITIALIZED.

readonly attribute string nsIHttpServerIdentity::primaryScheme

The primary scheme at which the corresponding server is located, defaulting to 'http'.

This name will be the value of nsIHttpRequest.scheme for HTTP/1.0 requests.

This value is always set when the corresponding server is running. If the server is not running, this value is set only if it has been set to a non-default name using setPrimary. In this case reading this value will throw NS_ERROR_NOT_INITIALIZED.


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