Back to index

lightning-sunbird  0.9+nobinonly
nsPACMan.h
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
00002 /* vim:set ts=2 sw=2 sts=2 et cindent: */
00003 /* ***** BEGIN LICENSE BLOCK *****
00004  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00005  *
00006  * The contents of this file are subject to the Mozilla Public License Version
00007  * 1.1 (the "License"); you may not use this file except in compliance with
00008  * the License. You may obtain a copy of the License at
00009  * http://www.mozilla.org/MPL/
00010  *
00011  * Software distributed under the License is distributed on an "AS IS" basis,
00012  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00013  * for the specific language governing rights and limitations under the
00014  * License.
00015  *
00016  * The Original Code is mozilla.org code.
00017  *
00018  * The Initial Developer of the Original Code is Google Inc.
00019  * Portions created by the Initial Developer are Copyright (C) 2005
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *  Darin Fisher <darin@meer.net>
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 nsPACMan_h__
00040 #define nsPACMan_h__
00041 
00042 #include "nsIStreamLoader.h"
00043 #include "nsIInterfaceRequestor.h"
00044 #include "nsIChannelEventSink.h"
00045 #include "nsIProxyAutoConfig.h"
00046 #include "nsIURI.h"
00047 #include "nsCOMPtr.h"
00048 #include "nsString.h"
00049 #include "prclist.h"
00050 #include "plevent.h"
00051 
00055 class NS_NO_VTABLE nsPACManCallback : public nsISupports
00056 {
00057 public:
00067   virtual void OnQueryComplete(nsresult status, const nsCString &pacString) = 0;
00068 };
00069 
00074 class nsPACMan : public nsIStreamLoaderObserver
00075                , public nsIInterfaceRequestor
00076                , public nsIChannelEventSink
00077 {
00078 public:
00079   NS_DECL_ISUPPORTS
00080 
00081   nsPACMan();
00082 
00088   void Shutdown();
00089 
00101   nsresult GetProxyForURI(nsIURI *uri, nsACString &result);
00102 
00114   nsresult AsyncGetProxyForURI(nsIURI *uri, nsPACManCallback *callback);
00115 
00124   nsresult LoadPACFromURI(nsIURI *pacURI);
00125 
00129   PRBool IsLoading() { return mLoader != nsnull; }
00130 
00131 private:
00132   NS_DECL_NSISTREAMLOADEROBSERVER
00133   NS_DECL_NSIINTERFACEREQUESTOR
00134   NS_DECL_NSICHANNELEVENTSINK
00135 
00136   ~nsPACMan();
00137 
00141   void CancelExistingLoad();
00142 
00148   void ProcessPendingQ(nsresult status);
00149 
00153   nsresult StartLoading();
00154 
00158   void MaybeReloadPAC();
00159 
00163   void OnLoadFailure();
00164 
00168   PRBool IsPACURI(nsIURI *uri) {
00169     PRBool result;
00170     return mPACURI && NS_SUCCEEDED(mPACURI->Equals(uri, &result)) && result;
00171   }
00172 
00176   PR_STATIC_CALLBACK(void *) LoadEvent_Handle(PLEvent *);
00177   PR_STATIC_CALLBACK(void) LoadEvent_Destroy(PLEvent *);
00178 
00179 private:
00180   nsCOMPtr<nsIProxyAutoConfig> mPAC;
00181   nsCOMPtr<nsIURI>             mPACURI;
00182   PRCList                      mPendingQ;
00183   nsCOMPtr<nsIStreamLoader>    mLoader;
00184   PLEvent                     *mLoadEvent;
00185   PRBool                       mShutdown;
00186   PRTime                       mScheduledReload;
00187   PRUint32                     mLoadFailureCount;
00188 };
00189 
00190 #endif  // nsPACMan_h__