Interface nsISystemProxySettingsType

This interface allows the proxy code to use platform-specific proxy settings when the proxy preference is set to "automatic discovery". This service acts like a PAC parser to netwerk, but it will actually read the system settings and either return the proper proxy data from the autoconfig URL specified in the system proxy, or generate proxy data based on the system's manual proxy settings.

Hierarchy

Properties

PACURI mainThreadOnly

Methods

AddRef QueryInterface Release getProxyForURI

Properties

Readonly PACURI

PACURI: string

If non-empty, use this PAC file. If empty, call getProxyForURI instead.

Readonly mainThreadOnly

mainThreadOnly: bool

Whether or not it is appropriate to execute getProxyForURI off the main thread. If that method can block (e.g. for WPAD as windows does) then it must be not mainThreadOnly to avoid creating main thread jank. The main thread only option is provided for implementations that do not block but use other main thread only functions such as dbus.

Methods

AddRef

  • Increases the reference count for this interface. The associated instance will not be deleted unless the reference count is returned to zero.

    Returns

    The resulting reference count.

    Returns number

QueryInterface

  • Parameters

    • aIID: object
    • Optional aInstancePtr: object

    Returns any

  • A run time mechanism for interface discovery.

    Returns

    NS_OK if the interface is supported by the associated instance, NS_NOINTERFACE if it is not.

    aInstancePtr must not be null.

    Parameters

    • aIID: object

      [in] A requested interface IID

    • aInstancePtr: object

      [out] A pointer to an interface pointer to receive the result.

    Returns void

Release

  • Decreases the reference count for this interface. Generally, if the reference count returns to zero, the associated instance is deleted.

    Returns

    The resulting reference count.

    Returns number

getProxyForURI

  • See ProxyAutoConfig::getProxyForURI; this function behaves similarly except a more relaxed return string is allowed that includes full urls instead of just host:port syntax. e.g. "PROXY http://www.foo.com:8080" instead of "PROXY www.foo.com:8080"

    Parameters

    • testSpec: string
    • testScheme: string
    • testHost: string
    • testPort: int32_t

    Returns string

Settings

Member Visibility

Theme

Generated using TypeDoc