Back to index

lightning-sunbird  0.9+nobinonly
tmTransactionService.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 Transaction Manager.
00015  *
00016  * The Initial Developer of the Original Code is
00017  * Netscape Communications Corp.
00018  * Portions created by the Initial Developer are Copyright (C) 2003
00019  * the Initial Developer. All Rights Reserved.
00020  *
00021  * Contributor(s):
00022  *   John Gaunt <jgaunt@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 _tmTransactionService_H_
00039 #define _tmTransactionService_H_
00040 
00041 #include "ipcdclient.h"
00042 #include "ipcILockService.h"
00043 #include "ipcIMessageObserver.h"
00044 #include "ipcITransactionService.h"
00045 #include "nsString.h"
00046 #include "nsVoidArray.h"
00047 #include "plhash.h"
00048 #include "tmTransaction.h"
00049 #include "tmVector.h"
00050 
00051 struct tm_queue_mapping;
00052 
00070 class tmTransactionService : public ipcITransactionService,
00071                              public ipcIMessageObserver
00072 {
00073 
00074 public:
00075 
00077   // Constructor & Destructor
00078   tmTransactionService() : mObservers(0) {};
00079 
00083   virtual ~tmTransactionService();
00084 
00086   // Interface Declarations
00087 
00088   // for API docs, see the respective *.idl files
00089   NS_DECL_ISUPPORTS
00090   NS_DECL_IPCITRANSACTIONSERVICE
00091   NS_DECL_IPCIMESSAGEOBSERVER
00092 
00093 protected:
00094 
00096   // Protected Member Functions
00097 
00109   void SendMessage(tmTransaction *aTrans, PRBool aSync);
00110 
00111   // handlers for reply messages from TransactionManager
00112 
00119   void OnAttachReply(tmTransaction *aTrans);
00120 
00125   void OnDetachReply(tmTransaction *aTrans);
00126 
00130   void OnFlushReply(tmTransaction *aTrans);
00131 
00135   void OnPost(tmTransaction *aTrans);
00136 
00137   // other helper functions
00138 
00144   void DispatchStoredMessages(tm_queue_mapping *aQMapping);
00145 
00146   // helper methods for accessing the void arrays
00147 
00152   PRInt32 GetQueueID(const nsACString & aDomainName);
00153 
00159   char* GetJoinedQueueName(PRUint32 aQueueID);
00160 
00166   char* GetJoinedQueueName(const nsACString & aDomainName);
00167 
00172   tm_queue_mapping* GetQueueMap(PRUint32 aQueueID);
00173 
00177   nsresult SendDetachOrFlush(PRUint32 aQueueID,
00178                              PRUint32 aAction,
00179                              PRBool aSync);
00180 
00182   // Protected Member Variables
00183 
00184   nsCString mNamespace;               // limit domains to the namespace
00185   PLHashTable *mObservers;            // maps qName -> ipcITransactionObserver
00186 
00187   tmVector mQueueMaps;                // queue - name - domain mappings
00188   tmVector mWaitingMessages;          // messages sent before ATTACH_REPLY
00189 
00190   nsCOMPtr<ipcILockService> lockService;  // cache the lock service
00191 
00192 private:
00193 
00194 };
00195 
00196 #endif