Back to index

lightning-sunbird  0.9+nobinonly
nsFtpProtocolHandler.h
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 2; 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.org code.
00016  *
00017  * The Initial Developer of the Original Code is
00018  * Netscape Communications Corporation.
00019  * Portions created by the Initial Developer are Copyright (C) 1998
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *   Bradley Baetz <bbaetz@cs.mcgill.ca>
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 nsFtpProtocolHandler_h__
00040 #define nsFtpProtocolHandler_h__
00041 
00042 #include "nsFtpControlConnection.h"
00043 #include "nsIServiceManager.h"
00044 #include "nsIProxiedProtocolHandler.h"
00045 #include "nsVoidArray.h"
00046 #include "nsIIOService.h"
00047 #include "nsITimer.h"
00048 #include "nsIObserverService.h"
00049 #include "nsICacheSession.h"
00050 #include "nsIObserver.h"
00051 #include "nsWeakReference.h"
00052 #include "nsCRT.h"
00053 
00054 class nsITimer;
00055 class nsIStreamListener;
00056 
00057 //-----------------------------------------------------------------------------
00058 
00059 class nsFtpProtocolHandler : public nsIProxiedProtocolHandler
00060                            , public nsIObserver
00061                            , public nsSupportsWeakReference
00062 {
00063 public:
00064     NS_DECL_ISUPPORTS
00065     NS_DECL_NSIPROTOCOLHANDLER
00066     NS_DECL_NSIPROXIEDPROTOCOLHANDLER
00067     NS_DECL_NSIOBSERVER
00068     
00069     nsFtpProtocolHandler();
00070     virtual ~nsFtpProtocolHandler();
00071     
00072     nsresult Init();
00073 
00074     // FTP Connection list access
00075     nsresult InsertConnection(nsIURI *aKey, nsFtpControlConnection *aConn);
00076     nsresult RemoveConnection(nsIURI *aKey, nsFtpControlConnection **aConn);
00077 
00078 private:
00079     // Stuff for the timer callback function
00080     struct timerStruct {
00081         nsCOMPtr<nsITimer>      timer;
00082         nsFtpControlConnection *conn;
00083         char                   *key;
00084         
00085         timerStruct() : conn(nsnull), key(nsnull) {}
00086         
00087         ~timerStruct() {
00088             if (timer)
00089                 timer->Cancel();
00090             if (key)
00091                 nsMemory::Free(key);
00092             if (conn) {
00093                 conn->Disconnect(NS_ERROR_ABORT);
00094                 NS_RELEASE(conn);
00095             }
00096         }
00097     };
00098 
00099     static void Timeout(nsITimer *aTimer, void *aClosure);
00100 
00101     nsVoidArray mRootConnectionList;
00102 
00103     nsCOMPtr<nsICacheSession> mCacheSession;
00104     PRInt32 mIdleTimeout;
00105 };
00106 
00107 //-----------------------------------------------------------------------------
00108 
00109 extern nsFtpProtocolHandler *gFtpHandler;
00110 
00111 #endif // !nsFtpProtocolHandler_h__