Back to index

lightning-sunbird  0.9+nobinonly
nsHttpConnectionInfo.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 nsHttpConnectionInfo_h__
00040 #define nsHttpConnectionInfo_h__
00041 
00042 #include "nsHttp.h"
00043 #include "nsProxyInfo.h"
00044 #include "nsCOMPtr.h"
00045 #include "nsDependentString.h"
00046 #include "nsString.h"
00047 #include "plstr.h"
00048 #include "nsCRT.h"
00049 
00050 //-----------------------------------------------------------------------------
00051 // nsHttpConnectionInfo - holds the properties of a connection
00052 //-----------------------------------------------------------------------------
00053 
00054 class nsHttpConnectionInfo
00055 {
00056 public:
00057     nsHttpConnectionInfo(const nsACString &host, PRInt32 port,
00058                          nsProxyInfo* proxyInfo,
00059                          PRBool usingSSL=PR_FALSE)
00060         : mRef(0)
00061         , mProxyInfo(proxyInfo)
00062         , mUsingSSL(usingSSL) 
00063     {
00064         LOG(("Creating nsHttpConnectionInfo @%x\n", this));
00065 
00066         mUsingHttpProxy = (proxyInfo && !nsCRT::strcmp(proxyInfo->Type(), "http"));
00067 
00068         SetOriginServer(host, port);
00069     }
00070     
00071    ~nsHttpConnectionInfo()
00072     {
00073         LOG(("Destroying nsHttpConnectionInfo @%x\n", this));
00074     }
00075 
00076     nsrefcnt AddRef()
00077     {
00078         return PR_AtomicIncrement((PRInt32 *) &mRef);
00079     }
00080 
00081     nsrefcnt Release()
00082     {
00083         nsrefcnt n = PR_AtomicDecrement((PRInt32 *) &mRef);
00084         if (n == 0)
00085             delete this;
00086         return n;
00087     }
00088 
00089     const nsAFlatCString &HashKey() const { return mHashKey; }
00090 
00091     void SetOriginServer(const nsACString &host, PRInt32 port);
00092 
00093     void SetOriginServer(const char *host, PRInt32 port)
00094     {
00095         SetOriginServer(nsDependentCString(host), port);
00096     }
00097 
00098     const char *ProxyHost() const { return mProxyInfo ? mProxyInfo->Host().get() : nsnull; }
00099     PRInt32     ProxyPort() const { return mProxyInfo ? mProxyInfo->Port() : -1; }
00100     const char *ProxyType() const { return mProxyInfo ? mProxyInfo->Type() : nsnull; }
00101 
00102     // Compare this connection info to another...
00103     // Two connections are 'equal' if they end up talking the same
00104     // protocol to the same server. This is needed to properly manage
00105     // persistent connections to proxies
00106     // Note that we don't care about transparent proxies - 
00107     // it doesn't matter if we're talking via socks or not, since
00108     // a request will end up at the same host.
00109     PRBool Equals(const nsHttpConnectionInfo *info)
00110     {
00111         return mHashKey.Equals(info->HashKey());
00112     }
00113 
00114     const char   *Host() const           { return mHost.get(); }
00115     PRInt32       Port() const           { return mPort; }
00116     nsProxyInfo  *ProxyInfo()            { return mProxyInfo; }
00117     PRBool        UsingHttpProxy() const { return mUsingHttpProxy; }
00118     PRBool        UsingSSL() const       { return mUsingSSL; }
00119     PRInt32       DefaultPort() const    { return mUsingSSL ? NS_HTTPS_DEFAULT_PORT : NS_HTTP_DEFAULT_PORT; }
00120             
00121 private:
00122     nsrefcnt               mRef;
00123     nsCString              mHashKey;
00124     nsCString              mHost;
00125     PRInt32                mPort;
00126     nsCOMPtr<nsProxyInfo>  mProxyInfo;
00127     PRPackedBool           mUsingHttpProxy;
00128     PRPackedBool           mUsingSSL;
00129 };
00130 
00131 #endif // nsHttpConnectionInfo_h__