This interface identifies a proxy server.

Please add a summary to this article.
  Last changed in Gecko 1.8 (Firefox 1.5 / Thunderbird 1.5 / SeaMonkey 1.0)

Inherits from: nsISupports


Attribute Type Description
failoverProxy nsIProxyInfo This attribute specifies the proxy to failover to when this proxy fails.
failoverTimeout unsigned long This attribute specifies the failover timeout in seconds for this proxy. If a nsIProxyInfo is reported as failed via nsIProtocolProxyService.getFailoverForProxy(), then the failed proxy will not be used again for this many seconds. Read only.
flags unsigned long This attribute specifies flags that modify the proxy type. The value of this attribute is the bit-wise combination of the Proxy Flags defined below. Any undefined bits are reserved for future use. Read only.
host AUTF8String This attribute specifies the hostname of the proxy server. Read only.

Note:  Prior to Gecko 1.8 host was available by the host method.

next nsIProxyInfo Proxy info objects may be chained if several proxies could be treated equivalently. This is used to support proxy failover. Read only. Obsolete since Gecko 1.8
port long This attribute specifies the port number of the proxy server. Read only.

Note:  Prior to Gecko 1.8 port was available by the port method.

type ACString

This attribute specifies the type of the proxy server as a case insensitive ASCII string.

Some special values for this attribute include (but are not limited to) the following:

  • "http" - HTTP proxy (or SSL CONNECT for HTTPS)
  • "socks" - SOCKS v5 proxy
  • "socks4" - SOCKS v4 proxy
  • "direct" - no proxy
  • "unknown" - unknown proxy (see nsIProtocolProxyService.resolve())
A future version of this interface may define additional types. Read only.

Note: Prior to Gecko 1.8 type was available by the type method.


The following "Proxy Flags" may be bit-wise combined to construct the flags attribute defined on this interface. All unspecified bits are reserved for future use.

Constant Value Description
TRANSPARENT_PROXY_RESOLVES_HOST 1 << 0 This flag is set if the proxy is to perform name resolution itself. If this is the case, the hostname is used in some fashion, and we shouldn't do any form of DNS lookup ourselves.

See also