Interface nsIBackgroundChannelRegistrarType

Registrar for pairing HttpChannelParent and HttpBackgroundChannelParent via channel Id. HttpChannelParent::OnBackgroundParentReady and HttpBackgroundChannelParent::LinkToChannel will be invoked to notify the existence of associated channel object.

Hierarchy

Methods

AddRef QueryInterface Release deleteChannel linkBackgroundChannel linkHttpChannel

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

deleteChannel

  • Delete previous stored HttpChannelParent or HttpBackgroundChannelParent if no need to wait for the paired channel object, e.g. background channel is destroyed before pairing is completed.

    Parameters

    • aKey: uint64_t

      the channel Id

    Returns void

linkBackgroundChannel

  • Link the provided background channel with the given channel Id. callbacks will be invoked immediately when the HttpChannelParent associated with the same channel Id is found. Store the HttpBackgroundChannelParent until a matched linkHttpChannel is invoked.

    Parameters

    • aKey: uint64_t

      the channel Id

    • aBgChannel: HttpBackgroundChannelParent

      the background channel to be paired

    Returns void

linkHttpChannel

  • Link the provided channel parent actor with the given channel Id. callbacks will be invoked immediately when the HttpBackgroundChannelParent associated with the same channel Id is found. Store the HttpChannelParent until a matched linkBackgroundChannel is invoked.

    Parameters

    • aKey: uint64_t

      the channel Id

    • aChannel: HttpChannelParent

      the channel parent actor to be paired

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc