Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions | Public Attributes
nsIMultiplexInputStream Interface Reference

The multiplex stream concatinates a list of input streams into a single stream. More...

import "nsIMultiplexInputStream.idl";

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

List of all members.

Public Member Functions

void appendStream (in nsIInputStream stream)
 Appends a stream to the end of the streams.
void insertStream (in nsIInputStream stream, in unsigned long index)
 Insert a stream at specified index.
void removeStream (in unsigned long index)
 Remove stream at specified index.
nsIInputStream getStream (in unsigned long index)
 Get stream at specified index.
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 ()

Public Attributes

readonly attribute unsigned long count
 Number of streams in this multiplex-stream.

Detailed Description

The multiplex stream concatinates a list of input streams into a single stream.

Definition at line 47 of file nsIMultiplexInputStream.idl.


Member Function Documentation

Appends a stream to the end of the streams.

The cursor of the stream should be located at the beginning of the stream if the implementation of this nsIMultiplexInputStream also is used as an nsISeekableStream.

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

Close the stream.

Get stream at specified index.

Parameters:
indexreturn stream at this index, must be < count
Returns:
stream at specified index

Insert a stream at specified index.

If the cursor of this stream is at the beginning of the stream at index, the cursor will be placed at the beginning of the inserted stream instead. The cursor of the new stream should be located at the beginning of the stream if the implementation of this nsIMultiplexInputStream also is used as an nsISeekableStream.

Parameters:
streamstream to insert
indexindex to insert stream at, must be <= count
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).

Remove stream at specified index.

If this stream is the one currently being read the readcursor is moved to the beginning of the next stream

Parameters:
indexremove stream at this index, must be < count

Member Data Documentation

Number of streams in this multiplex-stream.

Definition at line 52 of file nsIMultiplexInputStream.idl.


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