Interface nsIChannelEventSinkType

Implement this interface to receive control over various channel events. Channels will try to get this interface from a channel's notificationCallbacks or, if not available there, from the loadGroup's notificationCallbacks.

These methods are called before onStartRequest.

Hierarchy

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

  • Called when a redirect occurs. This may happen due to an HTTP 3xx status code. The purpose of this method is to notify the sink that a redirect is about to happen, but also to give the sink the right to veto the redirect by throwing or passing a failure-code in the callback.

    Note that vetoing the redirect simply means that |newChannel| will not be opened. It is important to understand that |oldChannel| will continue loading as if it received a HTTP 200, which includes notifying observers and possibly display or process content attached to the HTTP response. If the sink wants to prevent this loading it must explicitly deal with it, e.g. by calling |oldChannel->Cancel()|

    There is a certain freedom in implementing this method:

    If the return-value indicates success, a callback on |callback| is required. This callback can be done from within asyncOnChannelRedirect (effectively making the call synchronous) or at some point later (making the call asynchronous). Repeat: A callback must be done if this method returns successfully.

    If the return value indicates error (method throws an exception) the redirect is vetoed and no callback must be done. Repeat: No callback must be done if this method throws!

    NOTE: originalURI isn't yet set on the new channel when asyncOnChannelRedirect is called.

    See

    nsIAsyncVerifyRedirectCallback::onRedirectVerifyCallback()

    Throw

    Throwing an exception will cause the redirect to be cancelled

    Parameters

    • oldChannel: nsIChannel

      The channel that's being redirected.

    • newChannel: nsIChannel

      The new channel. This channel is not opened yet.

    • flags: number

      Flags indicating the type of redirect. A bitmask consisting of flags from above. One of REDIRECT_TEMPORARY and REDIRECT_PERMANENT will always be set.

    • callback: nsIAsyncVerifyRedirectCallback

      Object to inform about the async result of this method

    Returns void

Generated using TypeDoc