Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions | Protected Attributes
nsSimpleStreamListener Class Reference

#include <nsSimpleStreamListener.h>

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

List of all members.

Public Member Functions

NS_DECL_ISUPPORTS
NS_DECL_NSIREQUESTOBSERVER
NS_DECL_NSISTREAMLISTENER
NS_DECL_NSISIMPLESTREAMLISTENER 
nsSimpleStreamListener ()
virtual ~nsSimpleStreamListener ()
void init (in nsIOutputStream aSink, in nsIRequestObserver aObserver)
 Initialize the simple stream listener.
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.

Protected Attributes

nsCOMPtr< nsIOutputStreammSink
nsCOMPtr< nsIRequestObservermObserver

Detailed Description

Definition at line 43 of file nsSimpleStreamListener.h.


Constructor & Destructor Documentation

NS_DECL_ISUPPORTS NS_DECL_NSIREQUESTOBSERVER NS_DECL_NSISTREAMLISTENER NS_DECL_NSISIMPLESTREAMLISTENER nsSimpleStreamListener::nsSimpleStreamListener ( ) [inline]

Definition at line 51 of file nsSimpleStreamListener.h.

{ }
virtual nsSimpleStreamListener::~nsSimpleStreamListener ( ) [inline, virtual]

Definition at line 52 of file nsSimpleStreamListener.h.

{}

Member Function Documentation

Initialize the simple stream listener.

Parameters:
aSinkdata will be read from the channel to this output stream. Must implement writeFrom.
aObserveroptional stream observer (can be NULL)
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:


Member Data Documentation

Definition at line 56 of file nsSimpleStreamListener.h.

Definition at line 55 of file nsSimpleStreamListener.h.


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