netwerk/base/src/nsInputStreamPump.h

   1 /* -*- Mode: C++; tab-width: 2; 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.org code.
  16  *
  17  * The Initial Developer of the Original Code is
  18  * Netscape Communications Corporation.
  19  * Portions created by the Initial Developer are Copyright (C) 1998
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  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 #ifndef nsInputStreamPump_h__
  39 #define nsInputStreamPump_h__
  40
  41 #include "nsIInputStreamPump.h"
  42 #include "nsIInputStream.h"
  43 #include "nsIURI.h"
  44 #include "nsILoadGroup.h"
  45 #include "nsIStreamListener.h"
  46 #include "nsIInterfaceRequestor.h"
  47 #include "nsIProgressEventSink.h"
  48 #include "nsIAsyncInputStream.h"
  49 #include "nsIThread.h"
  50 #include "nsCOMPtr.h"
  51
  52 class nsInputStreamPump : public nsIInputStreamPump
  53                         , public nsIInputStreamCallback
  54 {
  55 public:
  56     NS_DECL_ISUPPORTS
  57     NS_DECL_NSIREQUEST
  58     NS_DECL_NSIINPUTSTREAMPUMP
  59     NS_DECL_NSIINPUTSTREAMCALLBACK
  60
  61     nsInputStreamPump();
  62     ~nsInputStreamPump();
  63
  64     static NS_HIDDEN_(nsresult)
  65                       Create(nsInputStreamPump  **result,
  66                              nsIInputStream      *stream,
  67                              PRInt64              streamPos = -1,
  68                              PRInt64              streamLen = -1,
  69                              PRUint32             segsize = 0,
  70                              PRUint32             segcount = 0,
  71                              PRBool               closeWhenDone = PR_FALSE);
  72
  73     typedef void (*PeekSegmentFun)(void *closure, const PRUint8 *buf,
  74                                    PRUint32 bufLen);
  75     /**
  76      * Peek into the first chunk of data that's in the stream. Note that this
  77      * method will not call the callback when there is no data in the stream.
  78      * The callback will be called at most once.
  79      *
  80      * The data from the stream will not be consumed, i.e. the pump's listener
  81      * can still read all the data.
  82      *
  83      * Do not call before asyncRead. Do not call after onStopRequest.
  84      */
  85     NS_HIDDEN_(nsresult) PeekStream(PeekSegmentFun callback, void *closure);
  86
  87 protected:
  88
  89     enum {
  90         STATE_IDLE,
  91         STATE_START,
  92         STATE_TRANSFER,
  93         STATE_STOP
  94     };
  95
  96     nsresult EnsureWaiting();
  97     PRUint32 OnStateStart();
  98     PRUint32 OnStateTransfer();
  99     PRUint32 OnStateStop();
 100
 101     PRUint32                      mState;
 102     nsCOMPtr<nsILoadGroup>        mLoadGroup;
 103     nsCOMPtr<nsIStreamListener>   mListener;
 104     nsCOMPtr<nsISupports>         mListenerContext;
 105     nsCOMPtr<nsIThread>           mTargetThread;
 106     nsCOMPtr<nsIInputStream>      mStream;
 107     nsCOMPtr<nsIAsyncInputStream> mAsyncStream;
 108     PRUint64                      mStreamOffset;
 109     PRUint64                      mStreamLength;
 110     PRUint32                      mSegSize;
 111     PRUint32                      mSegCount;
 112     nsresult                      mStatus;
 113     PRUint32                      mSuspendCount;
 114     PRUint32                      mLoadFlags;
 115     PRPackedBool                  mIsPending;
 116     PRPackedBool                  mWaiting; // true if waiting on async source
 117     PRPackedBool                  mCloseWhenDone;
 118 };
 119
 120 #endif // !nsInputStreamChannel_h__