pjs/xpcom/io/nsIAsyncInputStream.idl

81 строка
3.2 KiB
Plaintext

/* ***** BEGIN LICENSE BLOCK *****
* Version: MPL 1.1/GPL 2.0/LGPL 2.1
*
* The contents of this file are subject to the Mozilla Public License Version
* 1.1 (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
* http://www.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
* for the specific language governing rights and limitations under the
* License.
*
* The Original Code is Mozilla.
*
* The Initial Developer of the Original Code is
* Netscape Communications Corporation.
* Portions created by the Initial Developer are Copyright (C) 2002
* the Initial Developer. All Rights Reserved.
*
* Contributor(s):
* Darin Fisher <darin@netscape.com>
*
* Alternatively, the contents of this file may be used under the terms of
* either the GNU General Public License Version 2 or later (the "GPL"), or
* the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
* in which case the provisions of the GPL or the LGPL are applicable instead
* of those above. If you wish to allow use of your version of this file only
* under the terms of either the GPL or the LGPL, and not to allow others to
* use your version of this file under the terms of the MPL, indicate your
* decision by deleting the provisions above and replace them with the notice
* and other provisions required by the GPL or the LGPL. If you do not delete
* the provisions above, a recipient may use your version of this file under
* the terms of any one of the MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
#include "nsIInputStream.idl"
interface nsIInputStreamNotify;
interface nsIEventQueue;
[scriptable, uuid(cc911e09-2a02-4d2d-ba4b-b2afb173e96d)]
interface nsIAsyncInputStream : nsIInputStream
{
/**
* This function extends nsIInputStream::close, allowing the caller to
* specify the reason for closing the stream. Any future attempts to
* access the stream (e.g., nsIInputStream::read) will result in an
* exception with the value given by |reason|.
*
* close() is equivalent to closeEx(NS_BASE_STREAM_CLOSED).
*
* Any pending asyncWait will be notified.
*/
void closeEx(in nsresult reason);
/**
* Asynchronously wait for the stream to be readable or closed.
*
* @param aNotify
* This object is notified when the stream becomes ready.
* @param aRequestedCount
* Wait until at least this many bytes may be read. This is only
* a suggestion to the underlying stream; it may be ignored.
* @param aEventQ
* Specify NULL to receive notification on ANY thread, or specify
* that notification be delivered to a specific event queue. Caller
* must pass a "resolved" event queue (see nsIEventQueueService).
*/
void asyncWait(in nsIInputStreamNotify aNotify,
in unsigned long aRequestedCount,
in nsIEventQueue aEventQ);
};
[scriptable, uuid(20c665a3-0ebf-4ebb-97ba-794248bfa8fe)]
interface nsIInputStreamNotify : nsISupports
{
void onInputStreamReady(in nsIAsyncInputStream aStream);
};