Interface nsIInputChannelThrottleQueueType

An instance of this interface can be used to throttle the uploads of a group of associated channels.

Hierarchy

Properties

maxBytesPerSecond meanBytesPerSecond

Methods

AddRef QueryInterface Release available bytesProcessed init recordRead wrapStream

Properties

Readonly maxBytesPerSecond

maxBytesPerSecond: number

Readonly meanBytesPerSecond

meanBytesPerSecond: number

Internal use only. Get the values set by init method.

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

available

  • Return the number of bytes that are available to the caller in this time slice.

    Returns

    the number of bytes allowed to be processed during this time slice; this will never be greater than aRemaining.

    Parameters

    • aRemaining: number

      The number of bytes available to be processed

    Returns number

bytesProcessed

  • Return the number of bytes allowed through this queue. This is the sum of all the values passed to recordRead. This method is primarily useful for testing.

    Returns number

init

  • Initialize this object with the mean and maximum bytes per second that will be allowed. Neither value may be zero, and the maximum must not be less than the mean.

    Parameters

    • aMeanBytesPerSecond: number

      Mean number of bytes per second.

    • aMaxBytesPerSecond: number

      Maximum number of bytes per second.

    Returns void

recordRead

  • Record a successful read.

    Parameters

    • aBytesRead: number

      The number of bytes actually read.

    Returns void

wrapStream

  • Wrap the given input stream in a new input stream which throttles the incoming data.

    Returns

    a new input stream that throttles the data.

    Parameters

    • aInputStream: nsIInputStream

      the input stream to wrap

    Returns nsIAsyncInputStream

Settings

Member Visibility

Theme

Generated using TypeDoc