| 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 Mozilla.
|
|---|
| 16 | *
|
|---|
| 17 | * The Initial Developer of the Original Code is
|
|---|
| 18 | * Netscape Communications Corp.
|
|---|
| 19 | * Portions created by the Initial Developer are Copyright (C) 2002
|
|---|
| 20 | * the Initial Developer. All Rights Reserved.
|
|---|
| 21 | *
|
|---|
| 22 | * Contributor(s): Darin Fisher <[email protected]>
|
|---|
| 23 | *
|
|---|
| 24 | * Alternatively, the contents of this file may be used under the terms of
|
|---|
| 25 | * either the GNU General Public License Version 2 or later (the "GPL"), or
|
|---|
| 26 | * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
|
|---|
| 27 | * in which case the provisions of the GPL or the LGPL are applicable instead
|
|---|
| 28 | * of those above. If you wish to allow use of your version of this file only
|
|---|
| 29 | * under the terms of either the GPL or the LGPL, and not to allow others to
|
|---|
| 30 | * use your version of this file under the terms of the MPL, indicate your
|
|---|
| 31 | * decision by deleting the provisions above and replace them with the notice
|
|---|
| 32 | * and other provisions required by the GPL or the LGPL. If you do not delete
|
|---|
| 33 | * the provisions above, a recipient may use your version of this file under
|
|---|
| 34 | * the terms of any one of the MPL, the GPL or the LGPL.
|
|---|
| 35 | *
|
|---|
| 36 | * ***** END LICENSE BLOCK ***** */
|
|---|
| 37 |
|
|---|
| 38 | #include "nsISupports.idl"
|
|---|
| 39 |
|
|---|
| 40 | interface nsIInputStream;
|
|---|
| 41 | interface nsIInputStreamObserver;
|
|---|
| 42 |
|
|---|
| 43 | [scriptable, uuid(6f489efe-1dd2-11b2-af78-fb84ae21591b)]
|
|---|
| 44 | interface nsIObservableInputStream : nsISupports
|
|---|
| 45 | {
|
|---|
| 46 | /**
|
|---|
| 47 | * Allows users to set an observer on an input stream to receive notifications
|
|---|
| 48 | * about the consumer emptying the input stream's underlying buffer, or closing the
|
|---|
| 49 | * stream. This is necessary for non-blocking streams so that the producer can suspend
|
|---|
| 50 | * itself until more data can be written.
|
|---|
| 51 | */
|
|---|
| 52 | attribute nsIInputStreamObserver observer;
|
|---|
| 53 | };
|
|---|
| 54 |
|
|---|
| 55 | [scriptable, uuid(019d67cc-61b4-11d4-9877-00c04fa0cf4a)]
|
|---|
| 56 | interface nsIInputStreamObserver : nsISupports
|
|---|
| 57 | {
|
|---|
| 58 | /**
|
|---|
| 59 | * Called when the input stream's consumer has read all the existing data from the stream.
|
|---|
| 60 | */
|
|---|
| 61 | void onEmpty(in nsIInputStream inStr);
|
|---|
| 62 |
|
|---|
| 63 | /**
|
|---|
| 64 | * Called when the consumer closes its end of the stream.
|
|---|
| 65 | */
|
|---|
| 66 | void onClose(in nsIInputStream inStr);
|
|---|
| 67 | };
|
|---|
