| 1 | /* -*- Mode: IDL; 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 Mozilla Communicator client code, released
|
|---|
| 16 | * March 31, 1998.
|
|---|
| 17 | *
|
|---|
| 18 | * The Initial Developer of the Original Code is
|
|---|
| 19 | * Netscape Communications Corporation.
|
|---|
| 20 | * Portions created by the Initial Developer are Copyright (C) 1998-1999
|
|---|
| 21 | * the Initial Developer. All Rights Reserved.
|
|---|
| 22 | *
|
|---|
| 23 | * Contributor(s):
|
|---|
| 24 | *
|
|---|
| 25 | * Alternatively, the contents of this file may be used under the terms of
|
|---|
| 26 | * either of the GNU General Public License Version 2 or later (the "GPL"),
|
|---|
| 27 | * or 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 "nsISupports.idl"
|
|---|
| 40 |
|
|---|
| 41 | interface nsIInputStream;
|
|---|
| 42 |
|
|---|
| 43 | /**
|
|---|
| 44 | * nsIScriptableInputStream provides scriptable access to the nsIInputStream.
|
|---|
| 45 | *
|
|---|
| 46 | * @status FROZEN
|
|---|
| 47 | */
|
|---|
| 48 | [scriptable, uuid(a2a32f90-9b90-11d3-a189-0050041caf44)]
|
|---|
| 49 | interface nsIScriptableInputStream : nsISupports
|
|---|
| 50 | {
|
|---|
| 51 | /**
|
|---|
| 52 | * Closes the stream.
|
|---|
| 53 | */
|
|---|
| 54 | void close();
|
|---|
| 55 |
|
|---|
| 56 | /** Wrap the given nsIInputStream with this nsIScriptableInputStream.
|
|---|
| 57 | * @param aInputStream [in] parameter providing the stream to wrap
|
|---|
| 58 | */
|
|---|
| 59 | void init(in nsIInputStream aInputStream);
|
|---|
| 60 |
|
|---|
| 61 | /** Return the number of bytes currently available in the stream
|
|---|
| 62 | * @param _retval [out] parameter to hold the number of bytes
|
|---|
| 63 | * if an error occurs, the parameter will be undefined
|
|---|
| 64 | * @return error status
|
|---|
| 65 | */
|
|---|
| 66 | unsigned long available();
|
|---|
| 67 |
|
|---|
| 68 | /** Read data from the stream.
|
|---|
| 69 | * @param aCount [in] the maximum number of bytes to read
|
|---|
| 70 | * @param _retval [out] the data
|
|---|
| 71 | */
|
|---|
| 72 | string read(in unsigned long aCount);
|
|---|
| 73 | };
|
|---|
