netwerk/base/public/nsISystemProxySettings.idl@b8a032363ba2 (annotated)
netwerk/base/public/nsISystemProxySettings.idl
Thu, 22 Jan 2015 13:21:57 +0100
- author
- Michael Schloh von Bennewitz <michael@schloh.com>
- date
- Thu, 22 Jan 2015 13:21:57 +0100
- branch
- TOR_BUG_9701
- changeset 15
- b8a032363ba2
- permissions
- -rw-r--r--
Incorporate requested changes from Mozilla in review:
https://bugzilla.mozilla.org/show_bug.cgi?id=1123480#c6
| michael@0 | 1 | /* -*- Mode: IDL; 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 allows the proxy code to use platform-specific proxy |
| michael@0 | 10 | * settings when the proxy preference is set to "automatic discovery". This service |
| michael@0 | 11 | * acts like a PAC parser to netwerk, but it will actually read the system settings and |
| michael@0 | 12 | * either return the proper proxy data from the autoconfig URL specified in the system proxy, |
| michael@0 | 13 | * or generate proxy data based on the system's manual proxy settings. |
| michael@0 | 14 | */ |
| michael@0 | 15 | [scriptable, uuid(971591cd-277e-409a-bbf6-0a79879cd307)] |
| michael@0 | 16 | interface nsISystemProxySettings : nsISupports |
| michael@0 | 17 | { |
| michael@0 | 18 | /** |
| michael@0 | 19 | * Whether or not it is appropriate to execute getProxyForURI off the main thread. |
| michael@0 | 20 | * If that method can block (e.g. for WPAD as windows does) then it must be |
| michael@0 | 21 | * not mainThreadOnly to avoid creating main thread jank. The main thread only option is |
| michael@0 | 22 | * provided for implementations that do not block but use other main thread only |
| michael@0 | 23 | * functions such as dbus. |
| michael@0 | 24 | */ |
| michael@0 | 25 | readonly attribute bool mainThreadOnly; |
| michael@0 | 26 | |
| michael@0 | 27 | /** |
| michael@0 | 28 | * If non-empty, use this PAC file. If empty, call getProxyForURI instead. |
| michael@0 | 29 | */ |
| michael@0 | 30 | readonly attribute AUTF8String PACURI; |
| michael@0 | 31 | |
| michael@0 | 32 | /** |
| michael@0 | 33 | * See ProxyAutoConfig::getProxyForURI; this function behaves similarly except |
| michael@0 | 34 | * a more relaxed return string is allowed that includes full urls instead of just |
| michael@0 | 35 | * host:port syntax. e.g. "PROXY http://www.foo.com:8080" instead of |
| michael@0 | 36 | * "PROXY www.foo.com:8080" |
| michael@0 | 37 | */ |
| michael@0 | 38 | AUTF8String getProxyForURI(in AUTF8String testSpec, |
| michael@0 | 39 | in AUTF8String testScheme, |
| michael@0 | 40 | in AUTF8String testHost, |
| michael@0 | 41 | in int32_t testPort); |
| michael@0 | 42 | }; |
