/usr/include/gnelib/ObjectBroker.h is in libgnelib-dev 0.75+svn20091130-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 | #ifndef _OBJECTBROKER_H_234jf4
#define _OBJECTBROKER_H_234jf4
/* GNE - Game Networking Engine, a portable multithreaded networking library.
* Copyright (C) 2001-2006 Jason Winnebeck
* Project website: http://www.gillius.org/gne/
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
#include <map>
#include <gnelib/Mutex.h>
namespace GNE {
class Packet;
class NetworkObject;
/**
* @ingroup highlevel
*
* The function type used to create an object from a given packet.
*/
typedef NetworkObject* (*ObjCreationFunc)( int objectId, const Packet& );
/**
* @ingroup highlevel
*
* Serves as a base class for ObjectBrokerServer and ObjectBrokerClient and
* contains common functionality. This class is abstract, so you cannot
* instantiate it.
*/
class ObjectBroker {
public:
/**
* Returns the number of objects currently being managed by this
* ObjectBroker.
*/
int numObjects() const;
/**
* Returns the NetworkObject currently registered with the given object
* ID. Returns NULL if there is no object with that ID.
*/
NetworkObject* getObjectById( int objId );
/**
* Deregisters the given object entirely from the ObjectBroker. The
* ID of the object is set to an invalid ID, and the onDeregistration event
* is called. Once deregistered, an object must be reregistered before it
* can be used with the ObjectBroker again.
*
* Note that in ObjectBrokerClient, processing an ObjectDeathPacket
* automatically deregisteres an object, so this method is most useful with
* ObjectBrokerServer.
*
* @param obj a valid NetworkObject (one that has been assigned a valid ID).
*
* @see NetworkObject::onDeregistration
*/
void deregisterObject( NetworkObject& obj );
protected:
ObjectBroker() {}
/**
* Returns true if the object ID given exists. The mutex sync must be locked
* when this method is called.
*/
bool exists( int objId );
/**
* Assigns the given ID to the object.
*/
void assignId( NetworkObject& o, int newId );
mutable Mutex sync;
typedef std::map<int, NetworkObject*> ObjectsMap;
typedef std::map<int, NetworkObject*>::iterator ObjectsIter;
/**
* Associates an integer object ID to a NetworkObject.
*/
ObjectsMap objects;
};
} //namespace GNE
#endif
|