Back to index

lightning-sunbird  0.9+nobinonly
nsStreamUtils.h
Go to the documentation of this file.
00001 /* ***** BEGIN LICENSE BLOCK *****
00002  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00003  *
00004  * The contents of this file are subject to the Mozilla Public License Version
00005  * 1.1 (the "License"); you may not use this file except in compliance with
00006  * the License. You may obtain a copy of the License at
00007  * http://www.mozilla.org/MPL/
00008  *
00009  * Software distributed under the License is distributed on an "AS IS" basis,
00010  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00011  * for the specific language governing rights and limitations under the
00012  * License.
00013  *
00014  * The Original Code is Mozilla.
00015  *
00016  * The Initial Developer of the Original Code is
00017  * Netscape Communications Corporation.
00018  * Portions created by the Initial Developer are Copyright (C) 2002
00019  * the Initial Developer. All Rights Reserved.
00020  *
00021  * Contributor(s):
00022  *   Darin Fisher <darin@netscape.com>
00023  *
00024  * Alternatively, the contents of this file may be used under the terms of
00025  * either the GNU General Public License Version 2 or later (the "GPL"), or
00026  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00027  * in which case the provisions of the GPL or the LGPL are applicable instead
00028  * of those above. If you wish to allow use of your version of this file only
00029  * under the terms of either the GPL or the LGPL, and not to allow others to
00030  * use your version of this file under the terms of the MPL, indicate your
00031  * decision by deleting the provisions above and replace them with the notice
00032  * and other provisions required by the GPL or the LGPL. If you do not delete
00033  * the provisions above, a recipient may use your version of this file under
00034  * the terms of any one of the MPL, the GPL or the LGPL.
00035  *
00036  * ***** END LICENSE BLOCK ***** */
00037 
00038 #ifndef nsStreamUtils_h__
00039 #define nsStreamUtils_h__
00040 
00041 #include "nsStringFwd.h"
00042 #include "nsIInputStream.h"
00043 
00044 class nsIOutputStream;
00045 class nsIInputStreamCallback;
00046 class nsIOutputStreamCallback;
00047 class nsIEventTarget;
00048 
00059 extern NS_COM nsresult
00060 NS_NewInputStreamReadyEvent(nsIInputStreamCallback **aEvent,
00061                             nsIInputStreamCallback  *aNotify,
00062                             nsIEventTarget          *aEventTarget);
00063 
00074 extern NS_COM nsresult
00075 NS_NewOutputStreamReadyEvent(nsIOutputStreamCallback **aEvent,
00076                              nsIOutputStreamCallback  *aNotify,
00077                              nsIEventTarget           *aEventTarget);
00078 
00079 /* ------------------------------------------------------------------------- */
00080 
00081 enum nsAsyncCopyMode {
00082     NS_ASYNCCOPY_VIA_READSEGMENTS,
00083     NS_ASYNCCOPY_VIA_WRITESEGMENTS
00084 };
00085 
00090 typedef void (* nsAsyncCopyCallbackFun)(void *closure, nsresult status);
00091 
00102 extern NS_COM nsresult
00103 NS_AsyncCopy(nsIInputStream         *aSource,
00104              nsIOutputStream        *aSink,
00105              nsIEventTarget         *aEventTarget,
00106              nsAsyncCopyMode         aMode = NS_ASYNCCOPY_VIA_READSEGMENTS,
00107              PRUint32                aChunkSize = 4096,
00108              nsAsyncCopyCallbackFun  aCallbackFun = nsnull,
00109              void                   *aCallbackClosure = nsnull);
00110 
00134 extern NS_COM nsresult
00135 NS_ConsumeStream(nsIInputStream *aSource, PRUint32 aMaxCount,
00136                  nsACString &aBuffer);
00137 
00151 extern NS_COM PRBool
00152 NS_InputStreamIsBuffered(nsIInputStream *aInputStream);
00153 
00167 extern NS_COM PRBool
00168 NS_OutputStreamIsBuffered(nsIOutputStream *aOutputStream);
00169 
00177 extern NS_COM NS_METHOD
00178 NS_CopySegmentToStream(nsIInputStream *aInputStream, void *aClosure,
00179                        const char *aFromSegment, PRUint32 aToOffset,
00180                        PRUint32 aCount, PRUint32 *aWriteCount);
00181 
00190 extern NS_COM NS_METHOD
00191 NS_CopySegmentToBuffer(nsIInputStream *aInputStream, void *aClosure,
00192                        const char *aFromSegment, PRUint32 aToOffset,
00193                        PRUint32 aCount, PRUint32 *aWriteCount);
00194 
00202 extern NS_COM NS_METHOD
00203 NS_DiscardSegment(nsIInputStream *aInputStream, void *aClosure,
00204                   const char *aFromSegment, PRUint32 aToOffset,
00205                   PRUint32 aCount, PRUint32 *aWriteCount);
00206 
00218 extern NS_COM NS_METHOD
00219 NS_WriteSegmentThunk(nsIInputStream *aInputStream, void *aClosure,
00220                      const char *aFromSegment, PRUint32 aToOffset,
00221                      PRUint32 aCount, PRUint32 *aWriteCount);
00222 
00223 struct nsWriteSegmentThunk {
00224   nsIInputStream    *mStream;
00225   nsWriteSegmentFun  mFun;
00226   void              *mClosure;
00227 };
00228 
00229 #endif // !nsStreamUtils_h__