PRUint32 available ( )

Returns:

number of bytes currently available in the stream

void close ( )

Close the stream.

PRBool isNonBlocking ( )

Returns:

true if stream is non-blocking

PRUint32 read ( charPtr* buf , PRUint32 count )

Read data from the stream.

Arguments:

buf: the buffer into which the data is to be read

count: the maximum number of bytes to be read

Returns:

0 if reached end of file

PRUint32 readSegments ( nsWriteSegmentFun writer , voidPtr* closure , PRUint32 count )

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.

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

Arguments:

writer: the "consumer" of the data to be read

closure: opaque parameter passed to writer

count: the maximum number of bytes to be read

Returns:

0 if reached end of file (or if aWriter refused to consume data)