Back to index

lightning-sunbird  0.9+nobinonly
nsAHttpConnection.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 nsAHttpConnection_h__
00039 #define nsAHttpConnection_h__
00040 
00041 #include "nsISupports.h"
00042 
00043 class nsAHttpTransaction;
00044 class nsHttpRequestHead;
00045 class nsHttpResponseHead;
00046 class nsHttpConnectionInfo;
00047 
00048 //-----------------------------------------------------------------------------
00049 // Abstract base class for a HTTP connection
00050 //-----------------------------------------------------------------------------
00051 
00052 class nsAHttpConnection : public nsISupports
00053 {
00054 public:
00055     //-------------------------------------------------------------------------
00056     // NOTE: these methods may only be called on the socket thread.
00057     //-------------------------------------------------------------------------
00058 
00059     //
00060     // called by a transaction when the response headers have all been read.
00061     // the connection can force the transaction to reset it's response headers,
00062     // and prepare for a new set of response headers, by setting |*reset=TRUE|.
00063     //
00064     // @return failure code to close the transaction.
00065     //
00066     virtual nsresult OnHeadersAvailable(nsAHttpTransaction *,
00067                                         nsHttpRequestHead *,
00068                                         nsHttpResponseHead *,
00069                                         PRBool *reset) = 0;
00070 
00071     //
00072     // called by a transaction to resume either sending or receiving data
00073     // after a transaction returned NS_BASE_STREAM_WOULD_BLOCK from its
00074     // ReadSegments/WriteSegments methods.
00075     //
00076     virtual nsresult ResumeSend() = 0;
00077     virtual nsresult ResumeRecv() = 0;
00078 
00079     //
00080     // called by the connection manager to close a transaction being processed
00081     // by this connection.
00082     //
00083     // @param transaction
00084     //        the transaction being closed.
00085     // @param reason
00086     //        the reason for closing the transaction.  NS_BASE_STREAM_CLOSED
00087     //        is equivalent to NS_OK.
00088     //
00089     virtual void CloseTransaction(nsAHttpTransaction *transaction,
00090                                   nsresult reason) = 0;
00091 
00092     // get a reference to the connection's connection info object.
00093     virtual void GetConnectionInfo(nsHttpConnectionInfo **) = 0;
00094 
00095     // called by a transaction to get the security info from the socket.
00096     virtual void GetSecurityInfo(nsISupports **) = 0;
00097 
00098     // called by a transaction to determine whether or not the connection is
00099     // persistent... important in determining the end of a response.
00100     virtual PRBool IsPersistent() = 0;
00101 
00102     // called to determine if a connection has been reused.
00103     virtual PRBool IsReused() = 0;
00104     
00105     // called by a transaction when the transaction reads more from the socket
00106     // than it should have (eg. containing part of the next pipelined response).
00107     virtual nsresult PushBack(const char *data, PRUint32 length) = 0;
00108 };
00109 
00110 #define NS_DECL_NSAHTTPCONNECTION \
00111     nsresult OnHeadersAvailable(nsAHttpTransaction *, nsHttpRequestHead *, nsHttpResponseHead *, PRBool *reset); \
00112     nsresult ResumeSend(); \
00113     nsresult ResumeRecv(); \
00114     void CloseTransaction(nsAHttpTransaction *, nsresult); \
00115     void GetConnectionInfo(nsHttpConnectionInfo **); \
00116     void GetSecurityInfo(nsISupports **); \
00117     PRBool IsPersistent(); \
00118     PRBool IsReused(); \
00119     nsresult PushBack(const char *, PRUint32);
00120 
00121 #endif // nsAHttpConnection_h__