Interface nsIProxiedProtocolHandlerType

Hierarchy

Properties

scheme: string

The scheme of this protocol (e.g., "file").

Methods

  • 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

  • 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

  • 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

  • Allows a protocol to override blacklisted ports.

    This method will be called when there is an attempt to connect to a port that is blacklisted. For example, for most protocols, port 25 (Simple Mail Transfer) is banned. When a URI containing this "known-to-do-bad-things" port number is encountered, this function will be called to ask if the protocol handler wants to override the ban.

    Parameters

    • port: number
    • scheme: string

    Returns boolean

  • Constructs a new channel from the given URI for this protocol handler and sets the loadInfo for the constructed channel.

    Parameters

    • aURI: nsIURI
    • aLoadinfo: nsILoadInfo

    Returns nsIChannel

  • Create a new channel with the given proxyInfo

    Parameters

    • uri: nsIURI

      the channel uri

    • proxyInfo: nsIProxyInfo

      any proxy information that has already been determined, or null if channel should later determine the proxy on its own using proxyResolveFlags/proxyURI

    • proxyResolveFlags: number

      used if the proxy is later determined from nsIProtocolProxyService::asyncResolve

    • proxyURI: nsIURI

      used if the proxy is later determined from nsIProtocolProxyService::asyncResolve with this as the proxyURI name. Generally this is the same as uri (or null which has the same effect), except in the case of websockets which wants to bootstrap to an http:// channel but make its proxy determination based on a ws:// uri.

    • aLoadInfo: nsILoadInfo

      used to evaluate who initated the resource request.

    Returns nsIChannel

Generated using TypeDoc