Back to index

lightning-sunbird  0.9+nobinonly
ipcIService.idl
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 #include "nsISupports.idl"
00039 
00040 interface ipcIMessageObserver;
00041 interface ipcIClientObserver;
00042 
00072 [scriptable, uuid(53d3e3a7-528f-4b09-9eab-9416272568c0)]
00073 interface ipcIService : nsISupports
00074 {
00075     /**************************************************************************
00076      * properties of this process
00077      */
00078 
00084     readonly attribute unsigned long ID;
00085 
00097     void addName(in string aName);
00098     void removeName(in string aName);
00099 
00103     void addClientObserver(in ipcIClientObserver aObserver);
00104 
00108     void removeClientObserver(in ipcIClientObserver aObserver);
00109 
00110     /**************************************************************************
00111      * client query methods
00112      */
00113 
00119     unsigned long resolveClientName(in string aName);
00120 
00121 
00125     boolean clientExists(in unsigned long aClientID);
00126 
00127 
00128     // XXX need other functions to enumerate clients, clients implementing targets, etc.
00129     // enumerator getClients();
00130     // enumerator getClientsSupportingTarget(in nsIDRef aTarget);
00131     // enumerator getClientNames(in unsigned long aClientID);
00132     // enumerator getClientTargets(in unsigned long aClientID);
00133 
00134 
00135     /**************************************************************************
00136      * message methods
00137      */
00138 
00153     void defineTarget(in nsIDRef             aTarget,
00154                       in ipcIMessageObserver aObserver,
00155                       in boolean             aOnCurrentThread);
00156 
00172     void sendMessage(in unsigned long aReceiverID,
00173                      in nsIDRef       aTarget,
00174                     [array, const, size_is(aDataLen)]
00175                      in octet         aData,
00176                      in unsigned long aDataLen);
00177 
00207     void waitMessage(in unsigned long       aSenderID,
00208                      in nsIDRef             aTarget,
00209                      in ipcIMessageObserver aObserver,
00210                      in unsigned long       aTimeout);
00211 
00215     void disableMessageObserver(in nsIDRef aTarget);
00216 
00220     void enableMessageObserver(in nsIDRef aTarget);
00221 };
00222 
00223 %{C++
00224 // category and observer event defines (XXX not yet implemented)
00225 #define IPC_SERVICE_STARTUP_CATEGORY "ipc-startup-category"
00226 #define IPC_SERVICE_STARTUP_TOPIC    "ipc-startup"
00227 #define IPC_SERVICE_SHUTDOWN_TOPIC   "ipc-shutdown"
00228 %}