Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions | Private Attributes
nsURLFetcherStreamConsumer Class Reference

Stream consumer used for handling special content type like multipart/x-mixed-replace. More...

#include <nsURLFetcher.h>

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

List of all members.

Public Member Functions

 nsURLFetcherStreamConsumer (nsURLFetcher *urlFetcher)
 Stream consumer used for handling special content type like multipart/x-mixed-replace.
virtual ~nsURLFetcherStreamConsumer ()
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.

Private Attributes

nsURLFetchermURLFetcher

Detailed Description

Stream consumer used for handling special content type like multipart/x-mixed-replace.

Definition at line 114 of file nsURLFetcher.h.


Constructor & Destructor Documentation

Stream consumer used for handling special content type like multipart/x-mixed-replace.

Definition at line 447 of file nsURLFetcher.cpp.

                                                                               :
  mURLFetcher(urlFetcher)
{
#if defined(DEBUG_ducarroz)
  printf("CREATE nsURLFetcherStreamConsumer: %x\n", this);
#endif
}

Definition at line 455 of file nsURLFetcher.cpp.

{
#if defined(DEBUG_ducarroz)
  printf("DISPOSE nsURLFetcherStreamConsumer: %x\n", this);
#endif
}

Member Function Documentation

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 126 of file nsURLFetcher.h.


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