Back to index

lightning-sunbird  0.9+nobinonly
nsIInputStream.idl
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
00002 /* ***** BEGIN LICENSE BLOCK *****
00003  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00004  *
00005  * The contents of this file are subject to the Mozilla Public License Version
00006  * 1.1 (the "License"); you may not use this file except in compliance with
00007  * the License. You may obtain a copy of the License at
00008  * http://www.mozilla.org/MPL/
00009  *
00010  * Software distributed under the License is distributed on an "AS IS" basis,
00011  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00012  * for the specific language governing rights and limitations under the
00013  * License.
00014  *
00015  * The Original Code is mozilla.org code.
00016  *
00017  * The Initial Developer of the Original Code is
00018  * Netscape Communications Corporation.
00019  * Portions created by the Initial Developer are Copyright (C) 1998
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *   Warren Harris <warren@netscape.com>
00024  *   Darin Fisher <darin@netscape.com>
00025  *
00026  * Alternatively, the contents of this file may be used under the terms of
00027  * either of the GNU General Public License Version 2 or later (the "GPL"),
00028  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00029  * in which case the provisions of the GPL or the LGPL are applicable instead
00030  * of those above. If you wish to allow use of your version of this file only
00031  * under the terms of either the GPL or the LGPL, and not to allow others to
00032  * use your version of this file under the terms of the MPL, indicate your
00033  * decision by deleting the provisions above and replace them with the notice
00034  * and other provisions required by the GPL or the LGPL. If you do not delete
00035  * the provisions above, a recipient may use your version of this file under
00036  * the terms of any one of the MPL, the GPL or the LGPL.
00037  *
00038  * ***** END LICENSE BLOCK ***** */
00039 
00040 #include "nsISupports.idl"
00041 
00042 interface nsIInputStream;
00043 
00044 %{C++
00067 typedef NS_CALLBACK(nsWriteSegmentFun)(nsIInputStream *aInStream,
00068                                        void *aClosure,
00069                                        const char *aFromSegment,
00070                                        PRUint32 aToOffset,
00071                                        PRUint32 aCount,
00072                                        PRUint32 *aWriteCount);
00073 %}
00074 
00075 native nsWriteSegmentFun(nsWriteSegmentFun);
00076 
00082 [scriptable, uuid(fa9c7f6c-61b3-11d4-9877-00c04fa0cf4a)]
00083 interface nsIInputStream : nsISupports
00084 {
00088     void close();
00089 
00093     unsigned long available();
00094 
00108     [noscript] unsigned long read(in charPtr aBuf, in unsigned long aCount);
00109 
00131     [noscript] unsigned long readSegments(in nsWriteSegmentFun aWriter,
00132                                           in voidPtr aClosure,
00133                                           in unsigned long aCount);
00134 
00138     boolean isNonBlocking();
00139 };