WARNING: Most of this content (with the exception of the Mozilla 1.9 XPCOM reference) is very old, and can be expected to be out of date and possibly obsolete. For better XUL documentation, please visit the XUL hub at the Mozilla Developer Center.

nsIMultiplexInputStream

IID:a076fd12-1dd1-11b2-b19a-d53b5dffaade
Inherits From:nsIInputStream

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

This interface is intended to be used as an instance. To create an object implementing this interface: 

var obj = Components.classes["@mozilla.org/io/multiplex-input-stream;1"].
            createInstance(Components.interfaces.nsIMultiplexInputStream);

This interface is implemented by the following components:

Properties

readonly PRUint32 count

Number of streams in this multiplex-stream

Methods

void appendStream ( nsIInputStream stream ) nsIInputStream getStream ( PRUint32 index ) void insertStream ( nsIInputStream stream , PRUint32 index ) void removeStream ( PRUint32 index )

void appendStream ( nsIInputStream stream )

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.

Arguments:
stream: stream to append

nsIInputStream getStream ( PRUint32 index )

Get stream at specified index.

Arguments:
index: return stream at this index, must be < count
Returns:
stream at specified index

void insertStream ( nsIInputStream stream , PRUint32 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.

Arguments:
stream: stream to insert
index: index to insert stream at, must be <= count

void removeStream ( PRUint32 index )

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

Arguments:
index: remove stream at this index, must be < count

Reference documentation is generated from Mozilla's source.