Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions | Private Member Functions | Private Attributes
nsCacheEntryDescriptor::nsInputStreamWrapper Class Reference
Inheritance diagram for nsCacheEntryDescriptor::nsInputStreamWrapper:
Inheritance graph
[legend]
Collaboration diagram for nsCacheEntryDescriptor::nsInputStreamWrapper:
Collaboration graph
[legend]

List of all members.

Public Member Functions

NS_DECL_ISUPPORTS
NS_DECL_NSIINPUTSTREAM 
nsInputStreamWrapper (nsCacheEntryDescriptor *desc, PRUint32 off)
virtual ~nsInputStreamWrapper ()
void close ()
 Close the stream.
unsigned long available ()
unsigned long read (in charPtr aBuf, in unsigned long aCount)
 Read data from the stream.
unsigned long readSegments (in nsWriteSegmentFun aWriter, in voidPtr aClosure, in unsigned long aCount)
 Low-level read method that has access to the stream's underlying buffer.
boolean isNonBlocking ()

Private Member Functions

nsresult LazyInit ()
nsresult EnsureInit ()

Private Attributes

nsCacheEntryDescriptormDescriptor
nsCOMPtr< nsIInputStreammInput
PRUint32 mStartOffset
PRBool mInitialized

Detailed Description

Definition at line 85 of file nsCacheEntryDescriptor.h.


Constructor & Destructor Documentation

Definition at line 95 of file nsCacheEntryDescriptor.h.

Here is the call graph for this function:

Definition at line 102 of file nsCacheEntryDescriptor.h.


Member Function Documentation

unsigned long nsIInputStream::available ( ) [inherited]
Returns:
number of bytes currently available in the stream
void nsIInputStream::close ( ) [inherited]

Close the stream.

Definition at line 109 of file nsCacheEntryDescriptor.h.

{ return mInitialized ? NS_OK : LazyInit(); }

Here is the call graph for this function:

Returns:
true if stream is non-blocking

Here is the caller graph for this function:

unsigned long nsIInputStream::read ( in charPtr  aBuf,
in unsigned long  aCount 
) [inherited]

Read data from the stream.

Parameters:
aBufthe buffer into which the data is to be read
aCountthe maximum number of bytes to be read
Returns:
number of bytes read (may be less than aCount).
0 if reached end of file
Exceptions:
NS_BASE_STREAM_WOULD_BLOCKif reading from the input stream would block the calling thread (non-blocking mode only)
<other-error>on failure
unsigned long nsIInputStream::readSegments ( in nsWriteSegmentFun  aWriter,
in voidPtr  aClosure,
in unsigned long  aCount 
) [inherited]

Low-level read method that has access to the stream's underlying buffer.

The writer function may be called multiple times for segmented buffers. ReadSegments is expected to keep calling the writer until either there is nothing left to read or the writer returns an error. ReadSegments should not call the writer with zero bytes to consume.

Parameters:
aWriterthe "consumer" of the data to be read
aClosureopaque parameter passed to writer
aCountthe maximum number of bytes to be read
Returns:
number of bytes read (may be less than aCount)
0 if reached end of file (or if aWriter refused to consume data)
Exceptions:
NS_BASE_STREAM_WOULD_BLOCKif reading from the input stream would block the calling thread (non-blocking mode only)
<other-error>on failure

NOTE: this function may be unimplemented if a stream has no underlying buffer (e.g., socket input stream).


Member Data Documentation

Definition at line 87 of file nsCacheEntryDescriptor.h.

Definition at line 90 of file nsCacheEntryDescriptor.h.

Definition at line 88 of file nsCacheEntryDescriptor.h.

Definition at line 89 of file nsCacheEntryDescriptor.h.


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