Back to index

lightning-sunbird  0.9+nobinonly
nsHttpPipeline.h
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 4; 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.
00016  *
00017  * The Initial Developer of the Original Code is
00018  * Netscape Communications.
00019  * Portions created by the Initial Developer are Copyright (C) 2001
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *   Darin Fisher <darin@netscape.com> (original author)
00024  *
00025  * Alternatively, the contents of this file may be used under the terms of
00026  * either the GNU General Public License Version 2 or later (the "GPL"), or
00027  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00028  * in which case the provisions of the GPL or the LGPL are applicable instead
00029  * of those above. If you wish to allow use of your version of this file only
00030  * under the terms of either the GPL or the LGPL, and not to allow others to
00031  * use your version of this file under the terms of the MPL, indicate your
00032  * decision by deleting the provisions above and replace them with the notice
00033  * and other provisions required by the GPL or the LGPL. If you do not delete
00034  * the provisions above, a recipient may use your version of this file under
00035  * the terms of any one of the MPL, the GPL or the LGPL.
00036  *
00037  * ***** END LICENSE BLOCK ***** */
00038 
00039 #ifndef nsHttpPipeline_h__
00040 #define nsHttpPipeline_h__
00041 
00042 #include "nsHttp.h"
00043 #include "nsAHttpConnection.h"
00044 #include "nsAHttpTransaction.h"
00045 #include "nsIInputStream.h"
00046 #include "nsIOutputStream.h"
00047 #include "nsVoidArray.h"
00048 #include "nsCOMPtr.h"
00049 
00050 class nsHttpPipeline : public nsAHttpConnection
00051                      , public nsAHttpTransaction
00052                      , public nsAHttpSegmentReader
00053 {
00054 public:
00055     NS_DECL_ISUPPORTS
00056     NS_DECL_NSAHTTPCONNECTION
00057     NS_DECL_NSAHTTPTRANSACTION
00058     NS_DECL_NSAHTTPSEGMENTREADER
00059 
00060     nsHttpPipeline();
00061     virtual ~nsHttpPipeline();
00062 
00063     nsresult AddTransaction(nsAHttpTransaction *);
00064 
00065 private:
00066     nsresult FillSendBuf();
00067     
00068     static NS_METHOD ReadFromPipe(nsIInputStream *, void *, const char *,
00069                                   PRUint32, PRUint32, PRUint32 *);
00070 
00071     // convenience functions
00072     nsAHttpTransaction *Request(PRInt32 i)
00073     {
00074         if (mRequestQ.Count() == 0)
00075             return nsnull;
00076 
00077         return (nsAHttpTransaction *) mRequestQ[i];
00078     }
00079     nsAHttpTransaction *Response(PRInt32 i)
00080     {
00081         if (mResponseQ.Count() == 0)
00082             return nsnull;
00083 
00084         return (nsAHttpTransaction *) mResponseQ[i];
00085     }
00086 
00087     nsAHttpConnection *mConnection;
00088     nsVoidArray        mRequestQ;  // array of transactions
00089     nsVoidArray        mResponseQ; // array of transactions
00090     nsresult           mStatus;
00091 
00092     // these flags indicate whether or not the first request or response
00093     // is partial.  a partial request means that Request(0) has been 
00094     // partially written out to the socket.  a partial response means
00095     // that Response(0) has been partially read in from the socket.
00096     PRPackedBool mRequestIsPartial;
00097     PRPackedBool mResponseIsPartial;
00098 
00099     // indicates whether or not the pipeline has been explicitly closed.
00100     PRPackedBool mClosed;
00101 
00102     // used when calling ReadSegments/WriteSegments on a transaction.
00103     nsAHttpSegmentReader *mReader;
00104     nsAHttpSegmentWriter *mWriter;
00105 
00106     // send buffer
00107     nsCOMPtr<nsIInputStream>  mSendBufIn;
00108     nsCOMPtr<nsIOutputStream> mSendBufOut;
00109 
00110     // the push back buffer.  not exceeding NS_HTTP_SEGMENT_SIZE bytes.
00111     char     *mPushBackBuf;
00112     PRUint32  mPushBackLen;
00113     PRUint32  mPushBackMax;
00114 };
00115 
00116 #endif // nsHttpPipeline_h__