Back to index

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

List of all members.

Public Member Functions

 nsProxyLoadStream (void)
virtual ~nsProxyLoadStream (void)
NS_DECL_ISUPPORTS NS_IMETHOD Close (void)
NS_IMETHOD Available (PRUint32 *aLength)
NS_IMETHOD Read (char *aBuf, PRUint32 aCount, PRUint32 *aReadCount)
NS_IMETHOD ReadSegments (nsWriteSegmentFun writer, void *closure, PRUint32 count, PRUint32 *_retval)
NS_IMETHOD IsNonBlocking (PRBool *aNonBlocking)
void SetBuffer (const char *aBuffer, PRUint32 aSize)
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 Attributes

const char * mBuffer
PRUint32 mSize
PRUint32 mIndex

Detailed Description

Definition at line 172 of file nsXULDocument.cpp.


Constructor & Destructor Documentation

Definition at line 180 of file nsXULDocument.cpp.

                            : mBuffer(nsnull)
    {
    }
virtual nsProxyLoadStream::~nsProxyLoadStream ( void  ) [inline, virtual]

Definition at line 184 of file nsXULDocument.cpp.

    {
    }

Member Function Documentation

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

Definition at line 198 of file nsXULDocument.cpp.

    {
        *aLength = mSize - mIndex;
        return NS_OK;
    }
void nsIInputStream::close ( ) [inherited]

Close the stream.

Definition at line 192 of file nsXULDocument.cpp.

    {
        return NS_OK;
    }
Returns:
true if stream is non-blocking
NS_IMETHOD nsProxyLoadStream::IsNonBlocking ( PRBool aNonBlocking) [inline]

Definition at line 225 of file nsXULDocument.cpp.

    {
        *aNonBlocking = PR_TRUE;
        return NS_OK;
    }
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
NS_IMETHOD nsProxyLoadStream::Read ( char *  aBuf,
PRUint32  aCount,
PRUint32 aReadCount 
) [inline]

Definition at line 204 of file nsXULDocument.cpp.

    {
        PRUint32 readCount = 0;
        while (mIndex < mSize && aCount > 0) {
            *aBuf = mBuffer[mIndex];
            ++aBuf;
            ++mIndex;
            readCount++;
            --aCount;
        }
        *aReadCount = readCount;
        return NS_OK;
    }
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).

NS_IMETHOD nsProxyLoadStream::ReadSegments ( nsWriteSegmentFun  writer,
void closure,
PRUint32  count,
PRUint32 _retval 
) [inline]

Definition at line 218 of file nsXULDocument.cpp.

    {
        NS_NOTREACHED("ReadSegments");
        return NS_ERROR_NOT_IMPLEMENTED;
    }
void nsProxyLoadStream::SetBuffer ( const char *  aBuffer,
PRUint32  aSize 
) [inline]

Definition at line 232 of file nsXULDocument.cpp.

    {
        mBuffer = aBuffer;
        mSize = aSize;
        mIndex = 0;
    }

Member Data Documentation

Definition at line 175 of file nsXULDocument.cpp.

Definition at line 177 of file nsXULDocument.cpp.

Definition at line 176 of file nsXULDocument.cpp.


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