mozilla

nsIProtocolProxyFilter

This interface is used to apply filters to the proxies selected for a given URI.
1.0
30
Introduced
Gecko 1.8
Inherits from: nsISupports Last changed in Gecko 1.8 (Firefox 1.5 / Thunderbird 1.5 / SeaMonkey 1.0)

This interface is used to apply filters to the proxies selected for a given URI. Use nsIProtocolProxyService.registerFilter() to hook up instances of this interface.

Method overview

nsIProxyInfo applyFilter(in nsIProtocolProxyService aProxyService, in nsIURI aURI, in nsIProxyInfo aProxy);

Methods

applyFilter()

This method is called to apply proxy filter rules for the given URI and proxy object (or list of proxy objects).

nsIProxyInfo applyFilter(
  in nsIProtocolProxyService aProxyService,
  in nsIURI aURI,
  in nsIProxyInfo aProxy
);
Parameters
aProxyService
A reference to the Protocol Proxy Service. This is passed so that implementations may easily access methods such as newProxyInfo.
aURI
The URI for which these proxy settings apply.
aProxy
The proxy (or list of proxies) that would be used by default for the given URI. This may be null.
Return value

The proxy (or list of proxies) that should be used in place of aProxy. This can be just be aProxy if the filter chooses not to modify the proxy. It can also be null to indicate that a direct connection should be used. Use aProxyService.newProxyInfo to construct nsIProxyInfo objects.

See also

Document Tags and Contributors

Contributors to this page: Sheppy, trevorh, Smi, def00111
Last updated by: def00111,