Back to index

lightning-sunbird  0.9+nobinonly
ipcModuleReg.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 ipcModuleReg_h__
00039 #define ipcModuleReg_h__
00040 
00041 #include "ipcModule.h"
00042 
00043 //
00044 // called to init the module registry.  this may only be called once at
00045 // startup or once after calling IPC_ShutdownModuleReg.
00046 //
00047 // params:
00048 //   exePath - path to the daemon executable.  modules are loaded from a
00049 //             directory relative to the daemon executable.
00050 //
00051 void IPC_InitModuleReg(const char *exePath);
00052 
00053 //
00054 // called to shutdown the module registry.  this may be called more than
00055 // once and need not follow a call to IPC_InitModuleReg.
00056 //
00057 void IPC_ShutdownModuleReg();
00058 
00059 //
00060 // returns the ipcModuleMethods for the given target.
00061 //
00062 ipcModuleMethods *IPC_GetModuleByTarget(const nsID &target);
00063 
00064 //
00065 // notifies all modules of client connect/disconnect
00066 //
00067 void IPC_NotifyModulesClientUp(ipcClient *);
00068 void IPC_NotifyModulesClientDown(ipcClient *);
00069 
00070 #endif // !ipcModuleReg_h__