ZCom_ConnGroupManager Class Reference

List of all members.

---

Detailed Description

A manager for connection groups.

Each ZCom_Control instance holds it's own group manager. Each group from this manager is valid to the control instance itself and to all ZCom_Node objects registered to it.

Note that groups are not synchronised currently. Groups created on one host can be used on this host only.

ZCOM_CONNGROUP_ALL is a special group id always representing a group which contains all connections of a current ZCom_Control.

Public Member Functions
bool	addConnection (ZCom_GroupID _gid, ZCom_ConnID _cid)
	Add connection to a group.
bool	checkGroupExists (ZCom_GroupID _gid)
	Check if group exists.
void	Clear ()
	Clean everything up.
ZCom_GroupID	createGroup (zU32 _size_hint)
	Create a new group.
void	destroyGroup (ZCom_GroupID _gid)
	Destroy a group.
ZCom_ConnID	getFirstConnection (ZCom_GroupID _gid, zU32 &_iterator)
	Get first connection from a group.
zU32	getGroupSize (ZCom_GroupID _gid)
	Get size of a group.
ZCom_ConnID	getNextConnection (ZCom_GroupID _gid, zU32 &_iterator)
	Get next connection from a group.
bool	removeConnection (ZCom_GroupID _gid, ZCom_ConnID _cid)
	Remove connection from a group.
	ZCom_ConnGroupManager ()
	Constructor.
	~ZCom_ConnGroupManager ()
	Destructor.

---

Constructor & Destructor Documentation

ZCom_ConnGroupManager::ZCom_ConnGroupManager (   )

Constructor.

ZCom_ConnGroupManager::~ZCom_ConnGroupManager (   )

Destructor.

---

Member Function Documentation

void ZCom_ConnGroupManager::Clear (   )

Clean everything up.

ZCom_GroupID ZCom_ConnGroupManager::createGroup (  zU32  _size_hint  )

Create a new group. Parameters: _size_hint  How much space should be reserved? Exceeding this value later on will result in reallocations. Returns: A new group ID.

void ZCom_ConnGroupManager::destroyGroup (  ZCom_GroupID  _gid  )

Destroy a group. Parameters: _gid  ID of group to destroy.

bool ZCom_ConnGroupManager::checkGroupExists (  ZCom_GroupID  _gid  )

Check if group exists. Parameters: _gid  ID of group to check. Returns: 'true' if group exists.

bool ZCom_ConnGroupManager::addConnection (  ZCom_GroupID  _gid, ZCom_ConnID  _cid )

Add connection to a group. Parameters: _gid  ID of group. _cid  ID of connection. Returns: 'true' on success.

bool ZCom_ConnGroupManager::removeConnection (  ZCom_GroupID  _gid, ZCom_ConnID  _cid )

Remove connection from a group. Parameters: _gid  ID of group. _cid  ID of connection. Returns: 'true' on success.

ZCom_ConnID ZCom_ConnGroupManager::getFirstConnection (  ZCom_GroupID  _gid, zU32 &  _iterator )

Get first connection from a group. Parameters: _gid  ID of group. _iterator  will be initialised with call to this method Returns: ID of connection or ZCom_Invalid_ID if empty

ZCom_ConnID ZCom_ConnGroupManager::getNextConnection (  ZCom_GroupID  _gid, zU32 &  _iterator )

Get next connection from a group. Parameters: _gid  ID of group. _iterator  iterator used in previous call to getFirstConnection() Returns: ID of connection or ZCom_Invalid_ID if no more connection IDs are available

zU32 ZCom_ConnGroupManager::getGroupSize (  ZCom_GroupID  _gid  )

Get size of a group. Parameters: _gid  ID of group. Returns: Number of elements in group.

---