Back to index

lightning-sunbird  0.9+nobinonly
ipcd.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 IPCD_H__
00039 #define IPCD_H__
00040 
00041 #include "ipcModule.h"
00042 #include "ipcMessage.h"
00043 
00044 //-----------------------------------------------------------------------------
00045 // IPC daemon methods (see struct ipcDaemonMethods)
00046 //
00047 // these functions may only be called directly from within the daemon.  plug-in
00048 // modules must access these through the ipcDaemonMethods structure.
00049 //-----------------------------------------------------------------------------
00050 
00051 PRStatus        IPC_DispatchMsg          (ipcClientHandle client, const nsID &target, const void *data, PRUint32 dataLen);
00052 PRStatus        IPC_SendMsg              (ipcClientHandle client, const nsID &target, const void *data, PRUint32 dataLen);
00053 ipcClientHandle IPC_GetClientByID        (PRUint32 id);
00054 ipcClientHandle IPC_GetClientByName      (const char *name);
00055 void            IPC_EnumClients          (ipcClientEnumFunc func, void *closure);
00056 PRUint32        IPC_GetClientID          (ipcClientHandle client);
00057 PRBool          IPC_ClientHasName        (ipcClientHandle client, const char *name);
00058 PRBool          IPC_ClientHasTarget      (ipcClientHandle client, const nsID &target);
00059 void            IPC_EnumClientNames      (ipcClientHandle client, ipcClientNameEnumFunc func, void *closure);
00060 void            IPC_EnumClientTargets    (ipcClientHandle client, ipcClientTargetEnumFunc func, void *closure);
00061 
00062 //-----------------------------------------------------------------------------
00063 // other internal IPCD methods
00064 //-----------------------------------------------------------------------------
00065 
00066 //
00067 // dispatch message
00068 //
00069 PRStatus IPC_DispatchMsg(ipcClientHandle client, const ipcMessage *msg);
00070 
00071 //
00072 // send message, takes ownership of |msg|.
00073 //
00074 PRStatus IPC_SendMsg(ipcClientHandle client, ipcMessage *msg);
00075 
00076 //
00077 // dispatch notifications about client connects and disconnects
00078 //
00079 void IPC_NotifyClientUp(ipcClientHandle client);
00080 void IPC_NotifyClientDown(ipcClientHandle client);
00081 
00082 #endif // !IPCD_H__