netwerk/base/public/nsIProxyInfo.idl@6474c204b198 (annotated)
netwerk/base/public/nsIProxyInfo.idl
Wed, 31 Dec 2014 06:09:35 +0100
- author
- Michael Schloh von Bennewitz <michael@schloh.com>
- date
- Wed, 31 Dec 2014 06:09:35 +0100
- changeset 0
- 6474c204b198
- permissions
- -rw-r--r--
Cloned upstream origin tor-browser at tor-browser-31.3.0esr-4.5-1-build1
revision ID fc1c9ff7c1b2defdbc039f12214767608f46423f for hacking purpose.
| michael@0 | 1 | /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ |
| michael@0 | 2 | /* This Source Code Form is subject to the terms of the Mozilla Public |
| michael@0 | 3 | * License, v. 2.0. If a copy of the MPL was not distributed with this |
| michael@0 | 4 | * file, You can obtain one at http://mozilla.org/MPL/2.0/. */ |
| michael@0 | 5 | |
| michael@0 | 6 | #include "nsISupports.idl" |
| michael@0 | 7 | |
| michael@0 | 8 | /** |
| michael@0 | 9 | * This interface identifies a proxy server. |
| michael@0 | 10 | */ |
| michael@0 | 11 | [scriptable, uuid(63fff172-2564-4138-96c6-3ae7d245fbed)] |
| michael@0 | 12 | interface nsIProxyInfo : nsISupports |
| michael@0 | 13 | { |
| michael@0 | 14 | /** |
| michael@0 | 15 | * This attribute specifies the hostname of the proxy server. |
| michael@0 | 16 | */ |
| michael@0 | 17 | readonly attribute AUTF8String host; |
| michael@0 | 18 | |
| michael@0 | 19 | /** |
| michael@0 | 20 | * This attribute specifies the port number of the proxy server. |
| michael@0 | 21 | */ |
| michael@0 | 22 | readonly attribute long port; |
| michael@0 | 23 | |
| michael@0 | 24 | /** |
| michael@0 | 25 | * This attribute specifies the type of the proxy server as an ASCII string. |
| michael@0 | 26 | * |
| michael@0 | 27 | * Some special values for this attribute include (but are not limited to) |
| michael@0 | 28 | * the following: |
| michael@0 | 29 | * "http" HTTP proxy (or SSL CONNECT for HTTPS) |
| michael@0 | 30 | * "socks" SOCKS v5 proxy |
| michael@0 | 31 | * "socks4" SOCKS v4 proxy |
| michael@0 | 32 | * "direct" no proxy |
| michael@0 | 33 | * "unknown" unknown proxy (see nsIProtocolProxyService::resolve) |
| michael@0 | 34 | * |
| michael@0 | 35 | * A future version of this interface may define additional types. |
| michael@0 | 36 | */ |
| michael@0 | 37 | readonly attribute ACString type; |
| michael@0 | 38 | |
| michael@0 | 39 | /** |
| michael@0 | 40 | * This attribute specifies flags that modify the proxy type. The value of |
| michael@0 | 41 | * this attribute is the bit-wise combination of the Proxy Flags defined |
| michael@0 | 42 | * below. Any undefined bits are reserved for future use. |
| michael@0 | 43 | */ |
| michael@0 | 44 | readonly attribute unsigned long flags; |
| michael@0 | 45 | |
| michael@0 | 46 | /** |
| michael@0 | 47 | * This attribute specifies flags that were used by nsIProxyProtocolService when |
| michael@0 | 48 | * creating this ProxyInfo element. |
| michael@0 | 49 | */ |
| michael@0 | 50 | readonly attribute unsigned long resolveFlags; |
| michael@0 | 51 | |
| michael@0 | 52 | /** |
| michael@0 | 53 | * Specifies a SOCKS5 username. |
| michael@0 | 54 | */ |
| michael@0 | 55 | readonly attribute ACString username; |
| michael@0 | 56 | |
| michael@0 | 57 | /** |
| michael@0 | 58 | * Specifies a SOCKS5 password. |
| michael@0 | 59 | */ |
| michael@0 | 60 | readonly attribute ACString password; |
| michael@0 | 61 | |
| michael@0 | 62 | /** |
| michael@0 | 63 | * This attribute specifies the failover timeout in seconds for this proxy. |
| michael@0 | 64 | * If a nsIProxyInfo is reported as failed via nsIProtocolProxyService:: |
| michael@0 | 65 | * getFailoverForProxy, then the failed proxy will not be used again for this |
| michael@0 | 66 | * many seconds. |
| michael@0 | 67 | */ |
| michael@0 | 68 | readonly attribute unsigned long failoverTimeout; |
| michael@0 | 69 | |
| michael@0 | 70 | /** |
| michael@0 | 71 | * This attribute specifies the proxy to failover to when this proxy fails. |
| michael@0 | 72 | */ |
| michael@0 | 73 | attribute nsIProxyInfo failoverProxy; |
| michael@0 | 74 | |
| michael@0 | 75 | |
| michael@0 | 76 | /**************************************************************************** |
| michael@0 | 77 | * The following "Proxy Flags" may be bit-wise combined to construct the |
| michael@0 | 78 | * flags attribute defined on this interface. All unspecified bits are |
| michael@0 | 79 | * reserved for future use. |
| michael@0 | 80 | */ |
| michael@0 | 81 | |
| michael@0 | 82 | /** |
| michael@0 | 83 | * This flag is set if the proxy is to perform name resolution itself. If |
| michael@0 | 84 | * this is the case, the hostname is used in some fashion, and we shouldn't |
| michael@0 | 85 | * do any form of DNS lookup ourselves. |
| michael@0 | 86 | */ |
| michael@0 | 87 | const unsigned short TRANSPARENT_PROXY_RESOLVES_HOST = 1 << 0; |
| michael@0 | 88 | }; |
