diff options
Diffstat (limited to 'netwerk/base/nsIProtocolProxyFilter.idl')
-rw-r--r-- | netwerk/base/nsIProtocolProxyFilter.idl | 74 |
1 files changed, 74 insertions, 0 deletions
diff --git a/netwerk/base/nsIProtocolProxyFilter.idl b/netwerk/base/nsIProtocolProxyFilter.idl new file mode 100644 index 000000000..8798a49b4 --- /dev/null +++ b/netwerk/base/nsIProtocolProxyFilter.idl @@ -0,0 +1,74 @@ +/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */ +/* vim:set ts=2 sw=2 sts=2 et cindent: */ +/* This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. */ + +#include "nsISupports.idl" + +interface nsIChannel; +interface nsIProtocolProxyService; +interface nsIProxyInfo; +interface nsIURI; + +/** + * 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. See also nsIProtocolProxyChannelFilter. + */ +[scriptable, uuid(f424abd3-32b4-456c-9f45-b7e3376cb0d1)] +interface nsIProtocolProxyFilter : nsISupports +{ + /** + * This method is called to apply proxy filter rules for the given URI + * and proxy object (or list of proxy objects). + * + * @param aProxyService + * A reference to the Protocol Proxy Service. This is passed so that + * implementations may easily access methods such as newProxyInfo. + * @param aURI + * The URI for which these proxy settings apply. + * @param aProxy + * The proxy (or list of proxies) that would be used by default for + * the given URI. This may be null. + * + * @return 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. + */ + nsIProxyInfo applyFilter(in nsIProtocolProxyService aProxyService, + in nsIURI aURI, in nsIProxyInfo aProxy); +}; + +/** + * This interface is used to apply filters to the proxies selected for a given + * channel. Use nsIProtocolProxyService::registerChannelFilter to hook up instances of + * this interface. See also nsIProtocolProxyFilter. + */ +[scriptable, uuid(245b0880-82c5-4e6e-be6d-bc586aa55a90)] +interface nsIProtocolProxyChannelFilter : nsISupports +{ + /** + * This method is called to apply proxy filter rules for the given channel + * and proxy object (or list of proxy objects). + * + * @param aProxyService + * A reference to the Protocol Proxy Service. This is passed so that + * implementations may easily access methods such as newProxyInfo. + * @param aChannel + * The channel for which these proxy settings apply. + * @param aProxy + * The proxy (or list of proxies) that would be used by default for + * the given channel. This may be null. + * + * @return 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. + */ + nsIProxyInfo applyFilter(in nsIProtocolProxyService aProxyService, + in nsIChannel aChannel, in nsIProxyInfo aProxy); +}; |