xpcom/io/nsIMultiplexInputStream.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /* This Source Code Form is subject to the terms of the Mozilla Public
   3  * License, v. 2.0. If a copy of the MPL was not distributed with this
   4  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   5
   6 #include "nsIInputStream.idl"
   7
   8 /**
   9  * The multiplex stream concatenates a list of input streams into a single
  10  * stream.
  11  */
  12
  13 [scriptable, builtinclass, uuid(a076fd12-1dd1-11b2-b19a-d53b5dffaade)]
  14 interface nsIMultiplexInputStream : nsISupports
  15 {
  16     /**
  17      * Number of streams in this multiplex-stream
  18      */
  19     [infallible] readonly attribute unsigned long count;
  20
  21     /**
  22      * Appends a stream to the end of the streams. The cursor of the stream
  23      * should be located at the beginning of the stream if the implementation
  24      * of this nsIMultiplexInputStream also is used as an nsISeekableStream.
  25      * @param stream  stream to append
  26      */
  27     void appendStream(in nsIInputStream stream);
  28
  29     /**
  30      * Get stream at specified index.
  31      * @param index   return stream at this index, must be < count
  32      * @return        stream at specified index
  33      */
  34     nsIInputStream getStream(in unsigned long index);
  35 };