WARNING: Most of this content (with the exception of the Mozilla 1.9 XPCOM reference) is very old, and can be expected to be out of date and possibly obsolete. For better XUL documentation, please visit the XUL hub at the Mozilla Developer Center.

nsIProxyInfo

IID:3fe9308b-1608-4fa0-933c-c5ec2c6175fd
Inherits From:nsISupports
Status:UNDER_REVIEW

This interface identifies a proxy server.

Constants

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.
PRUint16 TRANSPARENT_PROXY_RESOLVES_HOST = 1

Properties

nsIProxyInfo failoverProxy

This attribute specifies the proxy to failover to when this proxy fails.

readonly PRUint32 failoverTimeout

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.

readonly PRUint32 flags

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.

readonly AUTF8String host

This attribute specifies the hostname of the proxy server.

readonly PRInt32 port

This attribute specifies the port number of the proxy server.

readonly ACString type

This attribute specifies the type of the proxy server as an 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.

References

This interface is the type of the following properties:

nsIProxiedChannel.proxyInfo, nsIProxyInfo.failoverProxy

This interface is passed as an argument to the following methods:

nsIProtocolProxyCallback.onProxyAvailable, nsIProtocolProxyFilter.applyFilter, nsIProtocolProxyService.getFailoverForProxy, nsIProtocolProxyService.newProxyInfo, nsIProxiedProtocolHandler.newProxiedChannel, nsISocketTransportService.createTransport

This interface is returned from the following methods:

nsIProtocolProxyFilter.applyFilter, nsIProtocolProxyService.getFailoverForProxy, nsIProtocolProxyService.newProxyInfo, nsIProtocolProxyService.resolve

Reference documentation is generated from Mozilla's source.