Interface nsIThreadRetargetableRequestType

nsIThreadRetargetableRequest

Should be implemented by requests that support retargeting delivery of data off the main thread.

Hierarchy

Properties

deliveryTarget

Methods

AddRef QueryInterface Release retargetDeliveryTo

Properties

Readonly deliveryTarget

deliveryTarget: nsIEventTarget

Returns the event target where OnDataAvailable events will be dispatched.

This is only valid after OnStartRequest has been called. Any time before that point, the value may be changed by retargetDeliveryTo calls.

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

retargetDeliveryTo

  • Called to retarget delivery of OnDataAvailable to another thread. Should only be called before AsyncOpen for nsIWebsocketChannels, or during OnStartRequest for nsIChannels. Note: For nsIChannels, OnStartRequest and OnStopRequest will still be delivered on the main thread.

    Parameters

    • aNewTarget: nsIEventTarget

      New event target, e.g. thread or threadpool.

      Note: no return value is given. If the retargeting cannot be handled, normal delivery to the main thread will continue. As such, listeners should be ready to deal with OnDataAvailable on either the main thread or the new target thread.

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc