Interface nsIStreamLoaderType

Asynchronously loads a channel into a memory buffer.

To use this interface, first call init() with a nsIStreamLoaderObserver that will be notified when the data has been loaded. Then call asyncOpen() on the channel with the nsIStreamLoader as the listener. The context argument in the asyncOpen() call will be passed to the onStreamComplete() callback.

XXX define behaviour for sizes >4 GB

Hierarchy

Properties

numBytesRead: number

Gets the number of bytes read so far.

request: nsIRequest

Gets the request that loaded this file. null after the request has finished loading.

Methods

  • 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

  • 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

  • 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

  • Initialize this stream loader, and start loading the data.

    Parameters

    • aStreamObserver: nsIStreamLoaderObserver

      An observer that will be notified when the data is complete.

    • aRequestObserver: nsIRequestObserver

      An optional observer that will be notified when the request has started or stopped.

    Returns void

  • Called when the next chunk of data (corresponding to the request) may be read without blocking the calling thread. The onDataAvailable impl must read exactly |aCount| bytes of data before returning.

    Parameters

    • aRequest: nsIRequest

      request corresponding to the source of the data

    • aInputStream: nsIInputStream

      input stream containing the data chunk

    • aOffset: number

      Number of bytes that were sent in previous onDataAvailable calls for this request. In other words, the sum of all previous count parameters.

    • aCount: number

      number of bytes available in the stream

      NOTE: The aInputStream parameter must implement readSegments.

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

    Returns void

  • 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

  • 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

Generated using TypeDoc