eq::net::NullCM Class Reference

#include <nullCM.h>

Inheritance diagram for eq::net::NullCM:

[legend]

Collaboration diagram for eq::net::NullCM:

[legend]

List of all members.

---

Detailed Description

The object change manager doing nothing, for unmapped objects.

Definition at line 21 of file nullCM.h.

Public Member Functions
virtual void	notifyAttached ()
	Notification that the object is attached to a session.
virtual void	makeThreadSafe ()
	Make this object thread safe.
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
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	applyMapData ()
	Apply the initial data after mapping.

---

Member Function Documentation

virtual void eq::net::NullCM::notifyAttached

(

)

[inline, virtual]

Notification that the object is attached to a session.

Implements eq::net::ObjectCM.

Definition at line 27 of file nullCM.h.

virtual void eq::net::NullCM::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 instanciation.

See also:

Session::getObject().

Implements eq::net::ObjectCM.

Definition at line 28 of file nullCM.h.

virtual uint32_t eq::net::NullCM::commitNB

(

)

[inline, virtual]

Start committing a new version.

Returns:

the commit identifier to be passed to commitSync

See also:

commitSync

Implements eq::net::ObjectCM.

Definition at line 34 of file nullCM.h.

virtual uint32_t eq::net::NullCM::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.

Definition at line 35 of file nullCM.h.

virtual void eq::net::NullCM::obsolete

(

const uint32_t

version

)

[inline, virtual]

Explicitily obsolete all versions.

Parameters:

version

the version to obsolete

Implements eq::net::ObjectCM.

Definition at line 38 of file nullCM.h.

virtual void eq::net::NullCM::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.

Definition at line 40 of file nullCM.h.

virtual uint32_t eq::net::NullCM::getAutoObsoleteCount

(

)

const [inline, virtual]

Returns:

get the number of versions this object retains.

Implements eq::net::ObjectCM.

Definition at line 42 of file nullCM.h.

virtual uint32_t eq::net::NullCM::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.

Definition at line 45 of file nullCM.h.

virtual uint32_t eq::net::NullCM::getHeadVersion

(

)

const [inline, virtual]

Returns:

the latest available (head) version.

Implements eq::net::ObjectCM.

Definition at line 48 of file nullCM.h.

virtual uint32_t eq::net::NullCM::getVersion

(

)

const [inline, virtual]

Returns:

the current version.

Implements eq::net::ObjectCM.

Definition at line 49 of file nullCM.h.

virtual uint32_t eq::net::NullCM::getOldestVersion

(

)

const [inline, virtual]

Returns:

the oldest available version.

Implements eq::net::ObjectCM.

Definition at line 50 of file nullCM.h.

virtual bool eq::net::NullCM::isMaster

(

)

const [inline, virtual]

Returns:

if this instance is the master version.

Implements eq::net::ObjectCM.

Definition at line 53 of file nullCM.h.

virtual uint32_t eq::net::NullCM::getMasterInstanceID

(

)

const [inline, virtual]

Returns:

the instance identifier of the master object.

Implements eq::net::ObjectCM.

Definition at line 54 of file nullCM.h.

virtual void eq::net::NullCM::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.

Definition at line 57 of file nullCM.h.

virtual void eq::net::NullCM::removeSlave

(

NodePtr

node

)

[inline, virtual]

Remove a subscribed slave.

Parameters:

node

the slave node.

Implements eq::net::ObjectCM.

Definition at line 59 of file nullCM.h.

virtual void eq::net::NullCM::applyMapData

(

)

[inline, virtual]

Apply the initial data after mapping.

Implements eq::net::ObjectCM.

Definition at line 61 of file nullCM.h.

---

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

• nullCM.h