eq::net::DeltaMasterCM Class Reference

#include <deltaMasterCM.h>

Inheritance diagram for eq::net::DeltaMasterCM:

Inheritance graph
[legend]
Collaboration diagram for eq::net::DeltaMasterCM:

Collaboration graph
[legend]

List of all members.

Detailed Description

An object change manager handling full versions and deltas for the master instance.

Definition at line 27 of file deltaMasterCM.h.


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 node, 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.

Public Member Functions

 DeltaMasterCM (Object *object)
virtual void notifyAttached ()
 Notification that the object is attached to a session.
virtual void makeThreadSafe ()
 Make this object thread safe.

Classes

struct  InstanceData

Member Function Documentation

void eq::net::DeltaMasterCM::notifyAttached (  )  [virtual]

Notification that the object is attached to a session.

Implements eq::net::ObjectCM.

Definition at line 79 of file deltaMasterCM.cpp.

References eq::net::Session::getCommandThreadQueue(), eq::net::Object::getSession(), and eq::net::Base::registerCommand().

Here is the call graph for this function:

virtual void eq::net::DeltaMasterCM::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 34 of file deltaMasterCM.h.

uint32_t eq::net::DeltaMasterCM::commitNB (  )  [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 97 of file deltaMasterCM.cpp.

References eq::net::Object::_instanceID, eq::net::Object::DELTA, eq::net::Object::getChangeType(), eq::net::Object::getLocalNode(), eq::base::RequestHandler::registerRequest(), and eq::net::Object::send().

Here is the call graph for this function:

uint32_t eq::net::DeltaMasterCM::commitSync ( const uint32_t  commitID  )  [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 110 of file deltaMasterCM.cpp.

References eq::base::RequestHandler::waitRequest().

Here is the call graph for this function:

virtual void eq::net::DeltaMasterCM::obsolete ( const uint32_t  version  )  [inline, virtual]

Explicitily obsolete all versions.

Parameters:
version the version to obsolete

Implements eq::net::ObjectCM.

Definition at line 43 of file deltaMasterCM.h.

virtual void eq::net::DeltaMasterCM::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 45 of file deltaMasterCM.h.

virtual uint32_t eq::net::DeltaMasterCM::getAutoObsoleteCount (  )  const [inline, virtual]

Returns:
get the number of versions this object retains.

Implements eq::net::ObjectCM.

Definition at line 49 of file deltaMasterCM.h.

virtual uint32_t eq::net::DeltaMasterCM::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 51 of file deltaMasterCM.h.

virtual uint32_t eq::net::DeltaMasterCM::getHeadVersion (  )  const [inline, virtual]

Returns:
the latest available (head) version.

Implements eq::net::ObjectCM.

Definition at line 54 of file deltaMasterCM.h.

virtual uint32_t eq::net::DeltaMasterCM::getVersion (  )  const [inline, virtual]

Returns:
the current version.

Implements eq::net::ObjectCM.

Definition at line 55 of file deltaMasterCM.h.

uint32_t eq::net::DeltaMasterCM::getOldestVersion (  )  const [virtual]

Returns:
the oldest available version.

Implements eq::net::ObjectCM.

Definition at line 153 of file deltaMasterCM.cpp.

Referenced by addSlave().

Here is the caller graph for this function:

virtual bool eq::net::DeltaMasterCM::isMaster (  )  const [inline, virtual]

Returns:
if this instance is the master version.

Implements eq::net::ObjectCM.

Definition at line 59 of file deltaMasterCM.h.

virtual uint32_t eq::net::DeltaMasterCM::getMasterInstanceID (  )  const [inline, virtual]

Returns:
the instance identifier of the master object.

Implements eq::net::ObjectCM.

Definition at line 60 of file deltaMasterCM.h.

void eq::net::DeltaMasterCM::addSlave ( NodePtr  node,
const uint32_t  instanceID,
const uint32_t  version 
) [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 161 of file deltaMasterCM.cpp.

References eq::net::Object::_id, getOldestVersion(), eq::net::ObjectDataOStream::getVersion(), eq::net::DataOStream::resend(), and eq::net::ObjectDataOStream::setInstanceID().

Here is the call graph for this function:

void eq::net::DeltaMasterCM::removeSlave ( NodePtr  node  )  [virtual]

Remove a subscribed slave.

Parameters:
node the slave node.

Implements eq::net::ObjectCM.

Definition at line 211 of file deltaMasterCM.cpp.

virtual void eq::net::DeltaMasterCM::applyMapData (  )  [inline, virtual]

Apply the initial data after mapping.

Implements eq::net::ObjectCM.

Definition at line 66 of file deltaMasterCM.h.

The documentation for this class was generated from the following files:
Generated on Sat Dec 6 12:01:51 2008 for Equalizer 0.6 by  doxygen 1.5.5