Back to index

lightning-sunbird  0.9+nobinonly
nsInputStreamPump.h
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  *
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 nsInputStreamPump_h__
00039 #define nsInputStreamPump_h__
00040 
00041 #include "nsIInputStreamPump.h"
00042 #include "nsIInputStream.h"
00043 #include "nsIURI.h"
00044 #include "nsILoadGroup.h"
00045 #include "nsIStreamListener.h"
00046 #include "nsIInterfaceRequestor.h"
00047 #include "nsIProgressEventSink.h"
00048 #include "nsIAsyncInputStream.h"
00049 #include "nsIEventQueue.h"
00050 #include "nsCOMPtr.h"
00051 #include "nsInt64.h"
00052 
00053 class nsInputStreamPump : public nsIInputStreamPump
00054                         , public nsIInputStreamCallback
00055 {
00056 public:
00057     NS_DECL_ISUPPORTS
00058     NS_DECL_NSIREQUEST
00059     NS_DECL_NSIINPUTSTREAMPUMP
00060     NS_DECL_NSIINPUTSTREAMCALLBACK
00061 
00062     nsInputStreamPump(); 
00063     ~nsInputStreamPump();
00064 
00065     static NS_HIDDEN_(nsresult)
00066                       Create(nsInputStreamPump  **result,
00067                              nsIInputStream      *stream,
00068                              PRInt64              streamPos = -1,
00069                              PRInt64              streamLen = -1,
00070                              PRUint32             segsize = 0,
00071                              PRUint32             segcount = 0,
00072                              PRBool               closeWhenDone = PR_FALSE);
00073 
00074     typedef void (*PeekSegmentFun)(void *closure, const PRUint8 *buf,
00075                                    PRUint32 bufLen);
00086     NS_HIDDEN_(void) PeekStream(PeekSegmentFun callback, void *closure);
00087 
00088 protected:
00089 
00090     enum {
00091         STATE_IDLE,
00092         STATE_START,
00093         STATE_TRANSFER,
00094         STATE_STOP
00095     };
00096 
00097     nsresult EnsureWaiting();
00098     PRUint32 OnStateStart();
00099     PRUint32 OnStateTransfer();
00100     PRUint32 OnStateStop();
00101 
00102     PRUint32                      mState;
00103     nsCOMPtr<nsILoadGroup>        mLoadGroup;
00104     nsCOMPtr<nsIStreamListener>   mListener;
00105     nsCOMPtr<nsISupports>         mListenerContext;
00106     nsCOMPtr<nsIEventQueue>       mEventQ;
00107     nsCOMPtr<nsIInputStream>      mStream;
00108     nsCOMPtr<nsIAsyncInputStream> mAsyncStream;
00109     nsUint64                      mStreamOffset;
00110     nsUint64                      mStreamLength;
00111     PRUint32                      mSegSize;
00112     PRUint32                      mSegCount;
00113     nsresult                      mStatus;
00114     PRUint32                      mSuspendCount;
00115     PRUint32                      mLoadFlags;
00116     PRPackedBool                  mIsPending;
00117     PRPackedBool                  mWaiting; // true if waiting on async source
00118     PRPackedBool                  mCloseWhenDone;
00119 };
00120 
00121 #endif // !nsInputStreamChannel_h__