Interface nsIRequestContextType

The nsIRequestContext is used to maintain state about connections that are in some way associated with each other (often by being part of the same load group) and how they interact with blocking items like HEAD css/js loads.

This used to be known as nsILoadGroupConnectionInfo and nsISchedulingContext.

Hierarchy

Properties

ID blockingTransactionCount spdyPushCache

Methods

AddRef DOMContentLoaded QueryInterface Release addBlockingTransaction addNonTailRequest beginLoad cancelTailPendingRequests cancelTailedRequest isContextTailBlocked removeBlockingTransaction removeNonTailRequest

Properties

Readonly ID

ID: number

A unique identifier for this request context

Readonly blockingTransactionCount

blockingTransactionCount: number

Number of active blocking transactions associated with this context

spdyPushCache

spdyPushCache: SpdyPushCachePtr

This gives out a weak pointer to the push cache. The nsIRequestContext implementation owns the cache and will destroy it when overwritten or when the context ends.

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

DOMContentLoaded

  • Called when the associated document notified the DOMContentLoaded event.

    Returns void

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

addBlockingTransaction

  • Increase the number of active blocking transactions associated with this context by one.

    Returns void

addNonTailRequest

  • Increases/decrease the number of non-tailed requests in this context. If the count drops to zero, all tail-blocked callbacks are notified shortly after that to be unblocked.

    Returns void

beginLoad

  • Called by the associated document when its load starts. This resets context's internal states.

    Returns void

cancelTailPendingRequests

  • This notifies all queued tail-blocked requests, they will be notified aResult and released afterwards. Called by the load group when it's canceled.

    Parameters

    • aResult: number

    Returns void

cancelTailedRequest

  • Called when the request is sitting in the tail queue but has been canceled before untailing. This just removes the request from the queue so that it is not notified on untail and not referenced.

    Parameters

    • request: nsIRequestTailUnblockCallback

    Returns void

isContextTailBlocked

  • If the request context is in tail-blocked state, the callback is queued and result is true. The callback will be notified about tail-unblocking or when the request context is canceled.

    Parameters

    • callback: nsIRequestTailUnblockCallback

    Returns boolean

removeBlockingTransaction

  • Decrease the number of active blocking transactions associated with this context by one. The return value is the number of remaining blockers.

    Returns number

removeNonTailRequest

  • Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc