ipcClient.h

/* ***** BEGIN LICENSE BLOCK ***** * Version: MPL 1.1/GPL 2.0/LGPL 2.1 * * The contents of this file are subject to the Mozilla Public License Version * 1.1 (the "License"); you may not use this file except in compliance with * the License. You may obtain a copy of the License at * http://www.mozilla.org/MPL/ * * Software distributed under the License is distributed on an "AS IS" basis, * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License * for the specific language governing rights and limitations under the * License. * * The Original Code is Mozilla IPC. * * The Initial Developer of the Original Code is * Netscape Communications Corporation. * Portions created by the Initial Developer are Copyright (C) 2002 * the Initial Developer. All Rights Reserved. * * Contributor(s): * Darin Fisher <darin@netscape.com> * * Alternatively, the contents of this file may be used under the terms of * either the GNU General Public License Version 2 or later (the "GPL"), or * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"), * in which case the provisions of the GPL or the LGPL are applicable instead * of those above. If you wish to allow use of your version of this file only * under the terms of either the GPL or the LGPL, and not to allow others to * use your version of this file under the terms of the MPL, indicate your * decision by deleting the provisions above and replace them with the notice * and other provisions required by the GPL or the LGPL. If you do not delete * the provisions above, a recipient may use your version of this file under * the terms of any one of the MPL, the GPL or the LGPL. * * ***** END LICENSE BLOCK ***** */#ifndef ipcClientUnix_h__#define ipcClientUnix_h__#include "prio.h"#include "ipcMessageQ.h"#include "ipcStringList.h"#include "ipcIDList.h"#ifdef XP_WIN#include <windows.h>#endif//-----------------------------------------------------------------------------// ipcClient//// NOTE: this class is an implementation detail of the IPC daemon. IPC daemon// modules (other than the built-in IPCM module) must not access methods on// this class directly. use the API provided via ipcd.h instead.//-----------------------------------------------------------------------------class ipcClient
{
public:
void Init();
void Finalize();
PRUint32 ID() const { return mID; }
void AddName(constchar *name);
PRBool DelName(constchar *name);
PRBool HasName(constchar *name) const { return mNames.Find(name) != NULL; }
void AddTarget(constnsID &target);
PRBool DelTarget(constnsID &target);
PRBool HasTarget(constnsID &target) const { return mTargets.Find(target) != NULL; }
// list iteratorsconst ipcStringNode *Names() const { return mNames.First(); }
const ipcIDNode *Targets() const { return mTargets.First(); }
// returns primary client name (the one specified in the "client hello" message)constchar *PrimaryName() const { return mNames.First() ? mNames.First()->Value() : NULL; }
void SetExpectsSyncReply(PRBool val) { mExpectsSyncReply = val; }
PRBool GetExpectsSyncReply() const { return mExpectsSyncReply; }
#ifdef XP_WIN PRUint32 PID() const { return mPID; }
void SetPID(PRUint32 pid) { mPID = pid; }
HWND Hwnd() const { return mHwnd; }
void SetHwnd(HWND hwnd) { mHwnd = hwnd; }
#endif#if defined(XP_UNIX) || defined(XP_OS2)//// called to process a client file descriptor. the value of pollFlags// indicates the state of the socket.//// returns:// 0 - to cancel client connection// PR_POLL_READ - to poll for a readable socket// PR_POLL_WRITE - to poll for a writable socket// (both flags) - to poll for either a readable or writable socket//// the socket is non-blocking.//intProcess(PRFileDesc *sockFD, int pollFlags);
//// on success or failure, this function takes ownership of |msg| and will// delete it when appropriate.//void EnqueueOutboundMsg(ipcMessage *msg) { mOutMsgQ.Append(msg); }
#endifprivate:
static PRUint32 gLastID;
PRUint32 mID;
ipcStringList mNames;
ipcIDList mTargets;
PRBool mExpectsSyncReply;
#ifdef XP_WIN// on windows, we store the PID of the client process to help us determine// the client from which a message originated. each message has the PID// encoded in it.
PRUint32 mPID;
// the hwnd of the client's message window.
HWND mHwnd;
#endif#if defined(XP_UNIX) || defined(XP_OS2) ipcMessage mInMsg; // buffer for incoming message
ipcMessageQ mOutMsgQ; // outgoing message queue// keep track of the amount of the first message sent
PRUint32 mSendOffset;
// utility function for writing out messages.int WriteMsgs(PRFileDesc *fd);
#endif};
#endif // !ipcClientUnix_h__