2001-09-29 00:14:13 +04:00
|
|
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
|
|
|
|
/* ***** BEGIN LICENSE BLOCK *****
|
2004-04-19 02:01:16 +04:00
|
|
|
* Version: MPL 1.1/GPL 2.0/LGPL 2.1
|
2001-09-13 06:21:05 +04:00
|
|
|
*
|
2004-04-19 02:01:16 +04:00
|
|
|
* The contents of this file are subject to the Mozilla Public License Version
|
|
|
|
* 1.1 (the "License"); you may not use this file except in compliance with
|
|
|
|
* the License. You may obtain a copy of the License at
|
|
|
|
* http://www.mozilla.org/MPL/
|
2001-09-13 06:21:05 +04:00
|
|
|
*
|
2001-09-29 00:14:13 +04:00
|
|
|
* Software distributed under the License is distributed on an "AS IS" basis,
|
|
|
|
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
|
|
|
|
* for the specific language governing rights and limitations under the
|
|
|
|
* License.
|
2001-09-13 06:21:05 +04:00
|
|
|
*
|
|
|
|
* The Original Code is mozilla.org code.
|
|
|
|
*
|
2004-04-19 02:01:16 +04:00
|
|
|
* The Initial Developer of the Original Code is
|
2001-09-29 00:14:13 +04:00
|
|
|
* Netscape Communications Corporation.
|
|
|
|
* Portions created by the Initial Developer are Copyright (C) 1998
|
|
|
|
* the Initial Developer. All Rights Reserved.
|
2001-09-13 06:21:05 +04:00
|
|
|
*
|
2001-09-29 00:14:13 +04:00
|
|
|
* Contributor(s):
|
2004-04-19 02:01:16 +04:00
|
|
|
* Bradley Baetz <bbaetz@netscape.com> (Original Developer)
|
2004-12-16 05:46:12 +03:00
|
|
|
* Malcolm Smith <malsmith@cs.rmit.edu.au>
|
2001-09-29 00:14:13 +04:00
|
|
|
*
|
|
|
|
* Alternatively, the contents of this file may be used under the terms of
|
2004-04-19 02:01:16 +04:00
|
|
|
* either the GNU General Public License Version 2 or later (the "GPL"), or
|
2001-09-29 00:14:13 +04:00
|
|
|
* the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
|
|
|
|
* in which case the provisions of the GPL or the LGPL are applicable instead
|
|
|
|
* of those above. If you wish to allow use of your version of this file only
|
|
|
|
* under the terms of either the GPL or the LGPL, and not to allow others to
|
2004-04-19 02:01:16 +04:00
|
|
|
* use your version of this file under the terms of the MPL, indicate your
|
2001-09-29 00:14:13 +04:00
|
|
|
* decision by deleting the provisions above and replace them with the notice
|
|
|
|
* and other provisions required by the GPL or the LGPL. If you do not delete
|
|
|
|
* the provisions above, a recipient may use your version of this file under
|
2004-04-19 02:01:16 +04:00
|
|
|
* the terms of any one of the MPL, the GPL or the LGPL.
|
2001-09-29 00:14:13 +04:00
|
|
|
*
|
|
|
|
* ***** END LICENSE BLOCK ***** */
|
2001-09-13 06:21:05 +04:00
|
|
|
|
|
|
|
#include "nsISupports.idl"
|
|
|
|
|
2004-07-02 03:31:47 +04:00
|
|
|
/**
|
2005-03-25 06:41:33 +03:00
|
|
|
* This interface identifies a proxy server.
|
2001-09-13 06:21:05 +04:00
|
|
|
*/
|
2011-05-13 21:53:27 +04:00
|
|
|
[scriptable, uuid(9e557d99-7af0-4895-95b7-e6dba28c9ad9)]
|
2001-09-13 06:21:05 +04:00
|
|
|
interface nsIProxyInfo : nsISupports
|
|
|
|
{
|
2005-03-25 06:41:33 +03:00
|
|
|
/**
|
|
|
|
* This attribute specifies the hostname of the proxy server.
|
|
|
|
*/
|
|
|
|
readonly attribute AUTF8String host;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* This attribute specifies the port number of the proxy server.
|
|
|
|
*/
|
|
|
|
readonly attribute long port;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* 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
|
2005-06-25 03:58:25 +04:00
|
|
|
* "unknown" unknown proxy (see nsIProtocolProxyService::resolve)
|
2006-03-30 21:31:15 +04:00
|
|
|
*
|
|
|
|
* A future version of this interface may define additional types.
|
2005-03-25 06:41:33 +03:00
|
|
|
*/
|
|
|
|
readonly attribute ACString type;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* 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 attribute unsigned long flags;
|
|
|
|
|
2011-05-13 21:53:27 +04:00
|
|
|
/**
|
|
|
|
* This attribute specifies flags that were used by nsIProxyProtocolService when
|
|
|
|
* creating this ProxyInfo element.
|
|
|
|
*/
|
|
|
|
readonly attribute unsigned long resolveFlags;
|
|
|
|
|
2005-03-25 06:41:33 +03:00
|
|
|
/**
|
|
|
|
* 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 attribute unsigned long failoverTimeout;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* This attribute specifies the proxy to failover to when this proxy fails.
|
|
|
|
*/
|
|
|
|
attribute nsIProxyInfo failoverProxy;
|
|
|
|
|
|
|
|
|
|
|
|
/****************************************************************************
|
2006-03-30 21:31:15 +04:00
|
|
|
* The following "Proxy Flags" may be bit-wise combined to construct the
|
|
|
|
* flags attribute defined on this interface. All unspecified bits are
|
|
|
|
* reserved for future use.
|
2005-03-25 06:41:33 +03:00
|
|
|
*/
|
2004-12-16 05:46:12 +03:00
|
|
|
|
2005-03-25 06:41:33 +03:00
|
|
|
/**
|
|
|
|
* 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.
|
|
|
|
*/
|
|
|
|
const unsigned short TRANSPARENT_PROXY_RESOLVES_HOST = 1 << 0;
|
2001-09-13 06:21:05 +04:00
|
|
|
};
|