Back to index

lightning-sunbird  0.9+nobinonly
ipcLockProtocol.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 IPC.
00015  *
00016  * The Initial Developer of the Original Code is
00017  * Netscape Communications Corporation.
00018  * Portions created by the Initial Developer are Copyright (C) 2002
00019  * the Initial Developer. All Rights Reserved.
00020  *
00021  * Contributor(s):
00022  *   Darin Fisher <darin@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 ipcLockProtocol_h__
00039 #define ipcLockProtocol_h__
00040 
00041 #include "prtypes.h"
00042 
00043 //
00044 // ipc lock message format:
00045 //
00046 //   +----------------------------------+
00047 //   | opcode : 4 bits                  |
00048 //   +----------------------------------+
00049 //   | flags  : 4 bits                  |
00050 //   +----------------------------------+
00051 //   | key    : null terminated string  |
00052 //   +----------------------------------+
00053 //
00054 
00055 // lock opcodes
00056 #define IPC_LOCK_OP_ACQUIRE          1
00057 #define IPC_LOCK_OP_RELEASE          2
00058 #define IPC_LOCK_OP_STATUS_ACQUIRED  3
00059 #define IPC_LOCK_OP_STATUS_FAILED    4
00060 #define IPC_LOCK_OP_STATUS_BUSY      5
00061 
00062 // lock flags
00063 #define IPC_LOCK_FL_NONBLOCKING 1
00064 
00065 // data structure for representing lock request message
00066 struct ipcLockMsg
00067 {
00068     PRUint8      opcode;
00069     PRUint8      flags;
00070     const char * key;
00071 };
00072 
00073 //
00074 // flatten a lock message
00075 //
00076 // returns a malloc'd buffer containing the flattened message.  on return,
00077 // bufLen contains the length of the flattened message.
00078 //
00079 PRUint8 *IPC_FlattenLockMsg(const ipcLockMsg *msg, PRUint32 *bufLen);
00080 
00081 //
00082 // unflatten a lock message.  upon return, msg->key points into buf, so
00083 // buf must not be deallocated until after msg is no longer needed.
00084 //
00085 void IPC_UnflattenLockMsg(const PRUint8 *buf, PRUint32 bufLen, ipcLockMsg *msg);
00086 
00087 //
00088 // TargetID for message passing
00089 //
00090 #define IPC_LOCK_TARGETID \
00091 { /* 703ada8a-2d38-4d5d-9d39-03d1ccceb567 */         \
00092     0x703ada8a,                                      \
00093     0x2d38,                                          \
00094     0x4d5d,                                          \
00095     {0x9d, 0x39, 0x03, 0xd1, 0xcc, 0xce, 0xb5, 0x67} \
00096 }
00097 
00098 #endif // !ipcLockProtocol_h__