Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions
nsIStreamListenerProxy Interface Reference

A stream listener proxy is used to ship data over to another thread specified by the thread's event queue. More...

import "nsIStreamListenerProxy.idl";

Inheritance diagram for nsIStreamListenerProxy:
Inheritance graph
[legend]
Collaboration diagram for nsIStreamListenerProxy:
Collaboration graph
[legend]

List of all members.

Public Member Functions

void init (in nsIStreamListener aListener, in nsIEventQueue aEventQ, in unsigned long aBufferSegmentSize, in unsigned long aBufferMaxSize)
 Initializes an nsIStreamListenerProxy.
void onDataAvailable (in nsIRequest aRequest, in nsISupports aContext, in nsIInputStream aInputStream, in unsigned long aOffset, in unsigned long aCount)
 Called when the next chunk of data (corresponding to the request) may be read without blocking the calling thread.
void onStartRequest (in nsIRequest aRequest, in nsISupports aContext)
 Called to signify the beginning of an asynchronous request.
void onStopRequest (in nsIRequest aRequest, in nsISupports aContext, in nsresult aStatusCode)
 Called to signify the end of an asynchronous request.

Detailed Description

A stream listener proxy is used to ship data over to another thread specified by the thread's event queue.

The "true" stream listener's methods are invoked on the other thread.

This interface only provides the initialization needed after construction. Otherwise, these objects are used as nsIStreamListener.

Definition at line 51 of file nsIStreamListenerProxy.idl.


Member Function Documentation

void nsIStreamListenerProxy::init ( in nsIStreamListener  aListener,
in nsIEventQueue  aEventQ,
in unsigned long  aBufferSegmentSize,
in unsigned long  aBufferMaxSize 
)

Initializes an nsIStreamListenerProxy.

Parameters:
aListenerreceives listener notifications on the other thread
aEventQmay be NULL indicating the calling thread's event queue
aBufferSegmentSizepassing zero indicates the default
aBufferMaxSizepassing zero indicates the default
void nsIStreamListener::onDataAvailable ( in nsIRequest  aRequest,
in nsISupports  aContext,
in nsIInputStream  aInputStream,
in unsigned long  aOffset,
in unsigned long  aCount 
) [inherited]

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:
aRequestrequest corresponding to the source of the data
aContextuser defined context
aInputStreaminput stream containing the data chunk
aOffsetNumber of bytes that were sent in previous onDataAvailable calls for this request. In other words, the sum of all previous count parameters. If that number is greater than or equal to 2^32, this parameter will be PR_UINT32_MAX (2^32 - 1).
aCountnumber 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.

void nsIRequestObserver::onStartRequest ( in nsIRequest  aRequest,
in nsISupports  aContext 
) [inherited]

Called to signify the beginning of an asynchronous request.

Parameters:
aRequestrequest being observed
aContextuser defined context

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

Here is the caller graph for this function:

void nsIRequestObserver::onStopRequest ( in nsIRequest  aRequest,
in nsISupports  aContext,
in nsresult  aStatusCode 
) [inherited]

Called to signify the end of an asynchronous request.

This call is always preceded by a call to onStartRequest.

Parameters:
aRequestrequest being observed
aContextuser defined context
aStatusCodereason for stopping (NS_OK if completed successfully)

An exception thrown from onStopRequest is generally ignored.

Here is the caller graph for this function:


The documentation for this interface was generated from the following file: