Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions
nsIBufferedInputStream Interface Reference

An input stream that reads ahead and keeps a buffer coming from another input stream so that fewer accesses to the underlying stream are necessary. More...

import "nsIBufferedStreams.idl";

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

List of all members.

Public Member Functions

void init (in nsIInputStream fillFromStream, in unsigned long bufferSize)
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 ()

Detailed Description

An input stream that reads ahead and keeps a buffer coming from another input stream so that fewer accesses to the underlying stream are necessary.

Definition at line 9 of file nsIBufferedStreams.idl.


Member Function Documentation

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

Close the stream.

void nsIBufferedInputStream::init ( in nsIInputStream  fillFromStream,
in unsigned long  bufferSize 
)
Parameters:
fillFromStream- add buffering to this stream
bufferSize- specifies the maximum buffer size
Returns:
true if stream is non-blocking
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).


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