Interface nsIRequestObserverProxyType

A request observer proxy is used to ship data over to another thread specified by the thread's dispatch target. The "true" request observer's methods are invoked on the other thread.

This interface only provides the initialization needed after construction. Otherwise, these objects are used simply as nsIRequestObserver's.

Hierarchy

Methods

AddRef QueryInterface Release init onStartRequest onStopRequest

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

init

  • Initializes an nsIRequestObserverProxy.

    Parameters

    • observer: nsIRequestObserver

      receives observer notifications on the main thread

    • context: nsISupports

      the context argument that will be passed to OnStopRequest and OnStartRequest. This has to be stored permanently on initialization because it sometimes can't be AddRef/Release'd off-main-thread.

    Returns void

onStartRequest

  • Called to signify the beginning of an asynchronous request.

    Parameters

    • aRequest: nsIRequest

      request being observed

      An exception thrown from onStartRequest has the side-effect of causing the request to be canceled.

    Returns void

onStopRequest

  • Called to signify the end of an asynchronous request. This call is always preceded by a call to onStartRequest.

    Parameters

    • aRequest: nsIRequest

      request being observed

    • aStatusCode: number

      reason for stopping (NS_OK if completed successfully)

      An exception thrown from onStopRequest is generally ignored.

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc