co::ObjectHandler Class Reference

Interface for entities which map and register objects. More...

#include <objectHandler.h>

Inheritance diagram for co::ObjectHandler:

List of all members.

Public Member Functions
	ObjectHandler ()
	Construct a new object handler.
virtual	~ObjectHandler ()
	Destroy this object handler.
virtual bool	registerObject (Object *object)=0
	Register a distributed object.
virtual void	deregisterObject (Object *object)=0
	Deregister a distributed object.
virtual uint32_t	mapObjectNB (Object *object, const UUID &id, const uint128_t &version, NodePtr master)=0
	Start mapping a distributed object.
virtual bool	mapObjectSync (const uint32_t requestID)=0
	Finalize the mapping of a distributed object.
virtual void	unmapObject (Object *object)=0
	Unmap a mapped object.

---

Detailed Description

Interface for entities which map and register objects.

Version:

0.5.1

Definition at line 24 of file objectHandler.h.

---

Constructor & Destructor Documentation

co::ObjectHandler::ObjectHandler

(

)

[inline]

Construct a new object handler.

Version:

0.5.1

Definition at line 28 of file objectHandler.h.

virtual co::ObjectHandler::~ObjectHandler

(

)

[inline, virtual]

Destroy this object handler.

Definition at line 31 of file objectHandler.h.

---

Member Function Documentation

virtual void co::ObjectHandler::deregisterObject

(

Object *

object

)

[pure virtual]

Deregister a distributed object.

Parameters:

object

the object instance.

Implemented in eq::Config, and co::LocalNode.

virtual uint32_t co::ObjectHandler::mapObjectNB	(	Object *	object,
		const UUID &	id,
		const uint128_t &	version,
		NodePtr	master
	)		[pure virtual]

Start mapping a distributed object.

Parameters:

object	the object to map.
id	the object identifier
version	the version to map.
master	the master node, may be invalid/0.

Returns:

the request identifier for mapObjectSync().

Implemented in co::LocalNode, and eq::Config.

virtual bool co::ObjectHandler::mapObjectSync

(

const uint32_t

requestID

)

[pure virtual]

Finalize the mapping of a distributed object.

Implemented in co::LocalNode, and eq::Config.

virtual bool co::ObjectHandler::registerObject

(

Object *

object

)

[pure virtual]

Register a distributed object.

Registering a distributed object makes this object the master version. The object's identifier is used to map slave instances of the object. Master versions of objects are typically writable and can commit new versions of the distributed object.

Parameters:

object

the object instance.

Returns:

true if the object was registered, false otherwise.

Implemented in eq::Config, and co::LocalNode.

virtual void co::ObjectHandler::unmapObject

(

Object *

object

)

[pure virtual]

Unmap a mapped object.

Implemented in co::LocalNode, and eq::Config.

---

The documentation for this class was generated from the following file:

• objectHandler.h