xpcom/io/nsIMultiplexInputStream.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /* ***** BEGIN LICENSE BLOCK *****
   3  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   4  *
   5  * The contents of this file are subject to the Mozilla Public License Version
   6  * 1.1 (the "License"); you may not use this file except in compliance with
   7  * the License. You may obtain a copy of the License at
   8  * http://www.mozilla.org/MPL/
   9  *
  10  * Software distributed under the License is distributed on an "AS IS" basis,
  11  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12  * for the specific language governing rights and limitations under the
  13  * License.
  14  *
  15  * The Original Code is frightening to behold.
  16  *
  17  * The Initial Developer of the Original Code is
  18  * Jonas Sicking.
  19  * Portions created by the Initial Developer are Copyright (C) 2001
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *   Jonas Sicking <sicking@bigfoot.com>
  24  *
  25  * Alternatively, the contents of this file may be used under the terms of
  26  * either the GNU General Public License Version 2 or later (the "GPL"), or
  27  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  28  * in which case the provisions of the GPL or the LGPL are applicable instead
  29  * of those above. If you wish to allow use of your version of this file only
  30  * under the terms of either the GPL or the LGPL, and not to allow others to
  31  * use your version of this file under the terms of the MPL, indicate your
  32  * decision by deleting the provisions above and replace them with the notice
  33  * and other provisions required by the GPL or the LGPL. If you do not delete
  34  * the provisions above, a recipient may use your version of this file under
  35  * the terms of any one of the MPL, the GPL or the LGPL.
  36  *
  37  * ***** END LICENSE BLOCK ***** */
  38
  39 #include "nsIInputStream.idl"
  40
  41 /**
  42  * The multiplex stream concatenates a list of input streams into a single
  43  * stream.
  44  */
  45
  46 [scriptable, uuid(a076fd12-1dd1-11b2-b19a-d53b5dffaade)]
  47 interface nsIMultiplexInputStream : nsIInputStream
  48 {
  49     /**
  50      * Number of streams in this multiplex-stream
  51      */
  52     readonly attribute unsigned long count;
  53
  54     /**
  55      * Appends a stream to the end of the streams. The cursor of the stream
  56      * should be located at the beginning of the stream if the implementation
  57      * of this nsIMultiplexInputStream also is used as an nsISeekableStream.
  58      * @param stream  stream to append
  59      */
  60     void appendStream(in nsIInputStream stream);
  61
  62     /**
  63      * Insert a stream at specified index.  If the cursor of this stream is at
  64      * the beginning of the stream at index, the cursor will be placed at the
  65      * beginning of the inserted stream instead.
  66      * The cursor of the new stream should be located at the beginning of the
  67      * stream if the implementation of this nsIMultiplexInputStream also is
  68      * used as an nsISeekableStream.
  69      * @param stream  stream to insert
  70      * @param index   index to insert stream at, must be <= count
  71      */
  72     void insertStream(in nsIInputStream stream, in unsigned long index);
  73
  74     /**
  75      * Remove stream at specified index. If this stream is the one currently
  76      * being read the readcursor is moved to the beginning of the next
  77      * stream
  78      * @param index   remove stream at this index, must be < count
  79      */
  80     void removeStream(in unsigned long index);
  81
  82     /**
  83      * Get stream at specified index.
  84      * @param index   return stream at this index, must be < count
  85      * @return        stream at specified index
  86      */
  87     nsIInputStream getStream(in unsigned long index);
  88 };