Back to index

lightning-sunbird  0.9+nobinonly
ipcConnection.h
Go to the documentation of this file.
00001 /* vim:set ts=2 sw=2 et cindent: */
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 IPC.
00016  *
00017  * The Initial Developer of the Original Code is IBM Corporation.
00018  * Portions created by IBM Corporation are Copyright (C) 2003
00019  * IBM Corporation. All Rights Reserved.
00020  *
00021  * Contributor(s):
00022  *   Darin Fisher <darin@meer.net>
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 ipcConnection_h__
00039 #define ipcConnection_h__
00040 
00041 #include "nscore.h"
00042 
00043 class ipcMessage;
00044 
00045 #define IPC_METHOD_PRIVATE_(type)   NS_HIDDEN_(type)
00046 #define IPC_METHOD_PRIVATE          IPC_METHOD_PRIVATE_(nsresult)
00047 
00048 /* ------------------------------------------------------------------------- */
00049 /* Platform specific IPC connection API.
00050  */
00051 
00052 typedef void (* ipcCallbackFunc)(void *);
00053 
00065 IPC_METHOD_PRIVATE IPC_Connect(const char *daemonPath);
00066 
00076 IPC_METHOD_PRIVATE IPC_Disconnect();
00077 
00090 IPC_METHOD_PRIVATE IPC_SendMsg(ipcMessage *msg);
00091 
00104 IPC_METHOD_PRIVATE IPC_DoCallback(ipcCallbackFunc func, void *arg);
00105 
00106 /* ------------------------------------------------------------------------- */
00107 /* Cross-platform IPC connection methods.
00108  */
00109 
00120 IPC_METHOD_PRIVATE IPC_SpawnDaemon(const char *daemonPath);
00121 
00122 /* ------------------------------------------------------------------------- */
00123 /* IPC connection callbacks (not implemented by the connection code).
00124  *
00125  * NOTE: These functions execute on a background thread!!
00126  */
00127 
00136 IPC_METHOD_PRIVATE_(void) IPC_OnConnectionEnd(nsresult error);
00137 
00145 IPC_METHOD_PRIVATE_(void) IPC_OnMessageAvailable(ipcMessage *msg);
00146 
00147 #endif // ipcConnection_h__