eq::net::StaticMasterCM Class Reference
An object change manager handling a static master instance. More...
#include <staticMasterCM.h>
Public Member Functions | |
| StaticMasterCM (Object *object) | |
| virtual void | makeThreadSafe () |
| Make this object thread safe. | |
| virtual bool | isMaster () const |
| virtual uint32_t | getMasterInstanceID () const |
| virtual uint32_t | addSlave (Command &command) |
| 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 |
Detailed Description
An object change manager handling a static master instance.
For internal use only.
Definition at line 37 of file staticMasterCM.h.
Member Function Documentation
| virtual void eq::net::StaticMasterCM::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.
Definition at line 43 of file staticMasterCM.h.
| virtual uint32_t eq::net::StaticMasterCM::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 49 of file staticMasterCM.h.
| virtual uint32_t eq::net::StaticMasterCM::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 50 of file staticMasterCM.h.
| virtual void eq::net::StaticMasterCM::obsolete | ( | const uint32_t | version | ) | [inline, virtual] |
Explicitily obsolete all versions.
- Parameters:
-
version the version to obsolete
Implements eq::net::ObjectCM.
Definition at line 53 of file staticMasterCM.h.
| virtual void eq::net::StaticMasterCM::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 55 of file staticMasterCM.h.
| virtual uint32_t eq::net::StaticMasterCM::getAutoObsoleteCount | ( | ) | const [inline, virtual] |
- Returns:
- get the number of versions this object retains.
Implements eq::net::ObjectCM.
Definition at line 58 of file staticMasterCM.h.
| virtual uint32_t eq::net::StaticMasterCM::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 61 of file staticMasterCM.h.
| virtual uint32_t eq::net::StaticMasterCM::getHeadVersion | ( | ) | const [inline, virtual] |
- Returns:
- the latest available (head) version.
Implements eq::net::ObjectCM.
Definition at line 64 of file staticMasterCM.h.
| virtual uint32_t eq::net::StaticMasterCM::getVersion | ( | ) | const [inline, virtual] |
- Returns:
- the current version.
Implements eq::net::ObjectCM.
Definition at line 65 of file staticMasterCM.h.
| virtual uint32_t eq::net::StaticMasterCM::getOldestVersion | ( | ) | const [inline, virtual] |
- Returns:
- the oldest available version.
Implements eq::net::ObjectCM.
Definition at line 66 of file staticMasterCM.h.
| virtual bool eq::net::StaticMasterCM::isMaster | ( | ) | const [inline, virtual] |
- Returns:
- if this instance is the master version.
Implements eq::net::ObjectCM.
Definition at line 69 of file staticMasterCM.h.
| virtual uint32_t eq::net::StaticMasterCM::getMasterInstanceID | ( | ) | const [inline, virtual] |
- Returns:
- the instance identifier of the master object.
Implements eq::net::ObjectCM.
Definition at line 70 of file staticMasterCM.h.
| uint32_t eq::net::StaticMasterCM::addSlave | ( | Command & | command | ) | [virtual] |
Add a subscribed slave to the managed object.
- Parameters:
-
command the subscribe command initiating the add.
- Returns:
- the first version the slave has to use from its cache.
Implements eq::net::ObjectCM.
Definition at line 42 of file staticMasterCM.cpp.
References eq::net::DataOStream::disable(), eq::net::DataOStream::enable(), eq::net::Object::getInstanceData(), and eq::net::Object::getInstanceID().
| virtual void eq::net::StaticMasterCM::removeSlave | ( | NodePtr | node | ) | [inline, virtual] |
Remove a subscribed slave.
- Parameters:
-
node the slave node.
Implements eq::net::ObjectCM.
Definition at line 73 of file staticMasterCM.h.
| virtual void eq::net::StaticMasterCM::addOldMaster | ( | NodePtr | node, | |
| const uint32_t | instanceID | |||
| ) | [inline, virtual] |
Add the old master as a slave.
Implements eq::net::ObjectCM.
Definition at line 74 of file staticMasterCM.h.
| virtual void eq::net::StaticMasterCM::applyMapData | ( | ) | [inline, virtual] |
Apply the initial data after mapping.
Implements eq::net::ObjectCM.
Definition at line 77 of file staticMasterCM.h.
The documentation for this class was generated from the following files:
