Back to index

lightning-sunbird  0.9+nobinonly
tmUtils.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 _tmUtils_H_
00039 #define _tmUtils_H_
00040 
00041 #include "nscore.h"
00042 #include "nsError.h"
00043 #include "nsID.h"
00044 #include "prlog.h"
00045 #include <stdio.h>
00046 
00047 // UUID used to identify the Transaction Module in both daemon and client
00048 // not part of the XPCOM hooks, but rather a means of identifying
00049 // modules withing the IPC daemon.
00050 #define TRANSACTION_MODULE_ID                         \
00051 { /* c3dfbcd5-f51d-420b-abf4-3bae445b96a9 */          \
00052     0xc3dfbcd5,                                       \
00053     0xf51d,                                           \
00054     0x420b,                                           \
00055     {0xab, 0xf4, 0x3b, 0xae, 0x44, 0x5b, 0x96, 0xa9}  \
00056 }
00057 
00058 //static const nsID kTransModuleID = TRANSACTION_MODULE_ID;
00059 
00061 // match NS_ERROR_FOO error code formats
00062 //
00063 // only create new errors for those errors that are specific to TM
00064 
00065 #define NS_ERROR_MODULE_TM       27   /* XXX goes in nserror.h -- integrating with ns error codes */
00066 
00067 #define TM_ERROR                          NS_ERROR_GENERATE_FAILURE(NS_ERROR_MODULE_TM, 1)
00068 #define TM_ERROR_WRONG_QUEUE              NS_ERROR_GENERATE_FAILURE(NS_ERROR_MODULE_TM, 2)
00069 #define TM_ERROR_NOT_POSTED               NS_ERROR_GENERATE_FAILURE(NS_ERROR_MODULE_TM, 3)
00070 #define TM_ERROR_QUEUE_EXISTS             NS_ERROR_GENERATE_FAILURE(NS_ERROR_MODULE_TM, 4)
00071 #define TM_SUCCESS_DELETE_QUEUE           NS_ERROR_GENERATE_FAILURE(NS_ERROR_MODULE_TM, 6)
00072 
00073 
00074 // XXX clean up:
00075 #define TM_INVALID_ID 0xFFFFFFFF
00076 #define TM_INVALID 0xFFFFFFFF
00077 #define TM_NO_ID 0xFFFFFFFE
00078 
00079 // Transaction Actions
00080 enum {
00081   TM_ATTACH = 0, 
00082   TM_ATTACH_REPLY,
00083   TM_POST,
00084   TM_POST_REPLY,
00085   TM_NOTIFY,
00086   TM_FLUSH,
00087   TM_FLUSH_REPLY,
00088   TM_DETACH,
00089   TM_DETACH_REPLY 
00090 };
00091 
00092 #endif
00093