eq::net::StaticSlaveCM Class Reference

An object change manager handling static object slave instances. More...

#include <staticSlaveCM.h>

Inheritance diagram for eq::net::StaticSlaveCM:

[legend]

Collaboration diagram for eq::net::StaticSlaveCM:

[legend]

List of all members.

Public Member Functions
	StaticSlaveCM (Object *object)
virtual void	makeThreadSafe ()
	Make this object thread safe.
virtual bool	isMaster () const
virtual uint32_t	getMasterInstanceID () const
virtual void	addSlave (NodePtr slave, const uint32_t instanceID, const uint32_t version)
	Add a subscribed slave to the managed object.
virtual void	removeSlave (NodePtr node)
	Remove a subscribed slave.
virtual void	addOldMaster (NodePtr node, const uint32_t instanceID)
	Add the old master as a slave.
virtual void	applyMapData ()
	Apply the initial data after mapping.
Versioning
virtual uint32_t	commitNB ()
	Start committing a new version.
virtual uint32_t	commitSync (const uint32_t commitID)
	Finalize a commit transaction.
virtual void	obsolete (const uint32_t version)
	Explicitily obsolete all versions.
virtual void	setAutoObsolete (const uint32_t count, const uint32_t flags)
	Automatically obsolete old versions.
virtual uint32_t	getAutoObsoleteCount () const
virtual uint32_t	sync (const uint32_t version)
	Sync to a given version.
virtual uint32_t	getHeadVersion () const
virtual uint32_t	getVersion () const
virtual uint32_t	getOldestVersion () const
Protected Attributes
Object *	_object
	The managed object.
ObjectDataIStream *	_currentIStream
	istream for receiving the current version

---

Detailed Description

An object change manager handling static object slave instances.

For internal use only.

Definition at line 38 of file staticSlaveCM.h.

---

Member Function Documentation

virtual void eq::net::StaticSlaveCM::makeThreadSafe

(

)

[inline, virtual]

Make this object thread safe.

The caller has to ensure that no other thread is using this object when this function is called. It is primarily used by the session during object instantiation.

See also:

Session::getObject().

Implements eq::net::ObjectCM.

Reimplemented in eq::net::FullSlaveCM.

Definition at line 44 of file staticSlaveCM.h.

virtual uint32_t eq::net::StaticSlaveCM::commitNB

(

)

[inline, virtual]

Start committing a new version.

Returns:

the commit identifier to be passed to commitSync

See also:

commitSync

Implements eq::net::ObjectCM.

Reimplemented in eq::net::FullSlaveCM.

Definition at line 50 of file staticSlaveCM.h.

virtual uint32_t eq::net::StaticSlaveCM::commitSync

(

const uint32_t

commitID

)

[inline, virtual]

Finalize a commit transaction.

Parameters:

commitID

the commit identifier returned from commitNB

Returns:

the new head version.

Implements eq::net::ObjectCM.

Reimplemented in eq::net::FullSlaveCM.

Definition at line 51 of file staticSlaveCM.h.

virtual void eq::net::StaticSlaveCM::obsolete

(

const uint32_t

version

)

[inline, virtual]

Explicitily obsolete all versions.

Parameters:

version

the version to obsolete

Implements eq::net::ObjectCM.

Reimplemented in eq::net::FullSlaveCM.

Definition at line 54 of file staticSlaveCM.h.

virtual void eq::net::StaticSlaveCM::setAutoObsolete	(	const uint32_t	count,
		const uint32_t	flags
	)			[inline, virtual]

Automatically obsolete old versions.

Parameters:

	count	the number of versions to retain, excluding the head version.
	flags	additional flags for the auto-obsoletion mechanism

Implements eq::net::ObjectCM.

Reimplemented in eq::net::FullSlaveCM.

Definition at line 56 of file staticSlaveCM.h.

virtual uint32_t eq::net::StaticSlaveCM::getAutoObsoleteCount

(

)

const [inline, virtual]

Returns:

get the number of versions this object retains.

Implements eq::net::ObjectCM.

Reimplemented in eq::net::FullSlaveCM.

Definition at line 58 of file staticSlaveCM.h.

virtual uint32_t eq::net::StaticSlaveCM::sync

(

const uint32_t

version

)

[inline, virtual]

Sync to a given version.

Parameters:

version

the version to synchronize, must be bigger than the current version.

Returns:

the version of the object after the operation.

Implements eq::net::ObjectCM.

Reimplemented in eq::net::FullSlaveCM.

Definition at line 61 of file staticSlaveCM.h.

virtual uint32_t eq::net::StaticSlaveCM::getHeadVersion

(

)

const [inline, virtual]

Returns:

the latest available (head) version.

Implements eq::net::ObjectCM.

Reimplemented in eq::net::FullSlaveCM.

Definition at line 64 of file staticSlaveCM.h.

virtual uint32_t eq::net::StaticSlaveCM::getVersion

(

)

const [inline, virtual]

Returns:

the current version.

Implements eq::net::ObjectCM.

Reimplemented in eq::net::FullSlaveCM.

Definition at line 65 of file staticSlaveCM.h.

virtual uint32_t eq::net::StaticSlaveCM::getOldestVersion

(

)

const [inline, virtual]

Returns:

the oldest available version.

Implements eq::net::ObjectCM.

Reimplemented in eq::net::FullSlaveCM.

Definition at line 66 of file staticSlaveCM.h.

virtual bool eq::net::StaticSlaveCM::isMaster

(

)

const [inline, virtual]

Returns:

if this instance is the master version.

Implements eq::net::ObjectCM.

Reimplemented in eq::net::FullSlaveCM.

Definition at line 69 of file staticSlaveCM.h.

virtual uint32_t eq::net::StaticSlaveCM::getMasterInstanceID

(

)

const [inline, virtual]

Returns:

the instance identifier of the master object.

Implements eq::net::ObjectCM.

Reimplemented in eq::net::FullSlaveCM.

Definition at line 70 of file staticSlaveCM.h.

virtual void eq::net::StaticSlaveCM::addSlave	(	NodePtr	node,
		const uint32_t	instanceID,
		const uint32_t	version
	)			[inline, virtual]

Add a subscribed slave to the managed object.

Parameters:

	node	the slave node.
	instanceID	the object instance identifier on the slave node.
	version	the initial version.

Implements eq::net::ObjectCM.

Reimplemented in eq::net::FullSlaveCM.

Definition at line 72 of file staticSlaveCM.h.

virtual void eq::net::StaticSlaveCM::removeSlave

(

NodePtr

node

)

[inline, virtual]

Remove a subscribed slave.

Parameters:

node

the slave node.

Implements eq::net::ObjectCM.

Reimplemented in eq::net::FullSlaveCM.

Definition at line 74 of file staticSlaveCM.h.

virtual void eq::net::StaticSlaveCM::addOldMaster	(	NodePtr	node,
		const uint32_t	instanceID
	)			[inline, virtual]

Add the old master as a slave.

Implements eq::net::ObjectCM.

Reimplemented in eq::net::FullSlaveCM.

Definition at line 75 of file staticSlaveCM.h.

void eq::net::StaticSlaveCM::applyMapData

(

)

[virtual]

Apply the initial data after mapping.

Implements eq::net::ObjectCM.

Reimplemented in eq::net::FullSlaveCM.

Definition at line 78 of file staticSlaveCM.cpp.

References _currentIStream, _object, eq::net::Object::applyInstanceData(), EQLOG, eq::net::Object::getID(), eq::net::Object::getInstanceID(), and eq::net::ObjectDataIStream::waitReady().

Here is the call graph for this function:

---

Member Data Documentation

Object* eq::net::StaticSlaveCM::_object [protected]

The managed object.

Definition at line 82 of file staticSlaveCM.h.

Referenced by eq::net::FullSlaveCM::_unpackOneVersion(), applyMapData(), eq::net::FullSlaveCM::applyMapData(), and eq::net::FullSlaveCM::sync().

---

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

• staticSlaveCM.h
• staticSlaveCM.cpp