Readonly isPACLoadingTrue if there is a PAC download in progress.
Readonly proxyThis attribute specifies the current type of proxy configuration.
Optional aInstancePtr: objectA run time mechanism for interface discovery.
NS_OK if the interface is supported by the associated instance, NS_NOINTERFACE if it is not.
aInstancePtr must not be null.
[in] A requested interface IID
[out] A pointer to an interface pointer to receive the result.
This method returns via callback a nsIProxyInfo instance that identifies a proxy to be used for the given channel. Otherwise, this method returns null indicating that a direct connection should be used.
An object that can be used to cancel the asychronous operation. If canceled, the cancelation status (aReason) will be forwarded to the callback's onProxyAvailable method via the aStatus param.
NOTE: If this proxy is unavailable, getFailoverForProxy may be called to determine the correct secondary proxy to be used.
NOTE: If the protocol handler for the given URI supports nsIProxiedProtocolHandler, then the nsIProxyInfo instance returned from resolve may be passed to the newProxiedChannel method to create a nsIChannel to the given URI that uses the specified proxy.
NOTE: However, if the nsIProxyInfo type is "http", then it means that the given URI should be loaded using the HTTP protocol handler, which also supports nsIProxiedProtocolHandler.
nsIProxiedProtocolHandler::newProxiedChannel
The channel for which a proxy is to be found, or, if no channel is available, a URI indicating the same. This method will return NS_ERROR_NOINTERFACE if this argument isn't either an nsIURI or an nsIChannel.
A bit-wise combination of the RESOLVE_ flags defined above. Pass 0 to specify the default behavior. Any additional bits that do not correspond to a RESOLVE_ flag are reserved for future use.
The object to be notified when the result is available.
A labelled event target for dispatching runnables to main thread.
If the proxy identified by aProxyInfo is unavailable for some reason, this method may be called to access an alternate proxy that may be used instead. As a side-effect, this method may affect future result values from resolve/asyncResolve as well as from getFailoverForProxy.
NS_ERROR_NOT_AVAILABLE if there is no alternate proxy available.
The proxy that was unavailable.
The URI that was originally passed to resolve/asyncResolve.
The error code corresponding to the proxy failure. This value may be used to tune the delay before this proxy is used again.
This method may be called to construct a nsIProxyInfo instance from the given parameters. This method may be useful in conjunction with nsISocketTransportService::createTransport for creating, for example, a SOCKS connection.
The proxy type. This is a string value that identifies the proxy type. Standard values include: "http" - specifies a HTTP proxy "https" - specifies HTTP proxying over TLS connection to proxy "socks" - specifies a SOCKS version 5 proxy "socks4" - specifies a SOCKS version 4 proxy "direct" - specifies a direct connection (useful for failover) The type name is case-insensitive. Other string values may be possible, and new types may be defined by a future version of this interface.
The proxy hostname or IP address.
The proxy port.
Flags associated with this connection. See nsIProxyInfo.idl for currently defined flags.
Specifies the length of time (in seconds) to ignore this proxy if this proxy fails. Pass UINT32_MAX to specify the default timeout value, causing nsIProxyInfo::failoverTimeout to be assigned the default value.
Specifies the next proxy to try if this proxy fails. This parameter may be null.
This method may be called to construct a nsIProxyInfo instance for with the specified username and password. Currently implemented for SOCKS proxies only.
The proxy type. This is a string value that identifies the proxy type. Standard values include: "socks" - specifies a SOCKS version 5 proxy "socks4" - specifies a SOCKS version 4 proxy The type name is case-insensitive. Other string values may be possible, and new types may be defined by a future version of this interface.
The proxy hostname or IP address.
The proxy port.
The proxy username
The proxy password
Flags associated with this connection. See nsIProxyInfo.idl for currently defined flags.
Specifies the length of time (in seconds) to ignore this proxy if this proxy fails. Pass UINT32_MAX to specify the default timeout value, causing nsIProxyInfo::failoverTimeout to be assigned the default value.
Specifies the next proxy to try if this proxy fails. This parameter may be null.
Similar to registerFilter, but accepts an nsIProtocolProxyChannelFilter, which selects proxies according to channel rather than URI.
The nsIProtocolProxyChannelFilter instance to be registered.
The position of the filter.
This method may be used to register a proxy filter instance. Each proxy filter is registered with an associated position that determines the order in which the filters are applied (starting from position 0). When resolve/asyncResolve is called, it generates a list of proxies for the given URI, and then it applies the proxy filters. The filters have the opportunity to modify the list of proxies.
If two filters register for the same position, then the filters will be visited in the order in which they were registered.
If the filter is already registered, then its position will be updated.
After filters have been run, any disabled or disallowed proxies will be removed from the list. A proxy is disabled if it had previously failed- over to another proxy (see getFailoverForProxy). A proxy is disallowed, for example, if it is a HTTP proxy and the nsIProtocolHandler for the queried URI does not permit proxying via HTTP.
If a nsIProtocolHandler disallows all proxying, then filters will never have a chance to intercept proxy requests for such URLs.
The nsIProtocolProxyFilter instance to be registered.
The position of the filter.
NOTE: It is possible to construct filters that compete with one another in undesirable ways. This API does not attempt to protect against such problems. It is recommended that any extensions that choose to call this method make their position value configurable at runtime (perhaps via the preferences service).
This method may be used to unregister a proxy channel filter instance. All filters will be automatically unregistered at XPCOM shutdown.
The nsIProtocolProxyChannelFilter instance to be unregistered.
Generated using TypeDoc
nsIProtocolProxyService provides methods to access information about various network proxies.