Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions
nsIProtocolProxyFilter Interface Reference

This interface is used to apply filters to the proxies selected for a given URI. More...

import "nsIProtocolProxyFilter.idl";

Inheritance diagram for nsIProtocolProxyFilter:
Inheritance graph
[legend]
Collaboration diagram for nsIProtocolProxyFilter:
Collaboration graph
[legend]

List of all members.

Public Member Functions

nsIProxyInfo applyFilter (in nsIProtocolProxyService aProxyService, in nsIURI aURI, in nsIProxyInfo aProxy)
 This method is called to apply proxy filter rules for the given URI and proxy object (or list of proxy objects).

Detailed Description

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.

UNDER_REVIEW

Definition at line 53 of file nsIProtocolProxyFilter.idl.


Member Function Documentation

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

Parameters:
aProxyServiceA reference to the Protocol Proxy Service. This is passed so that implementations may easily access methods such as newProxyInfo.
aURIThe URI for which these proxy settings apply.
aProxyThe proxy (or list of proxies) that would be used by default for the given URI. This may be null.
Returns:
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.

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