libglass::_Shared Class Reference
#include <shared.h>
Inheritance diagram for libglass::_Shared:
Public Types | |
| enum | UpdateMode { NEVER, NEXT_ONLY, CHANGED, FORCED } |
Public Member Functions | |
| void | setUpdateMode (UpdateMode updatemode) |
| UpdateMode | getUpdateMode (void) const |
| bool | hasChanged (void) const |
| bool | sendUpdate (void) |
| bool | getUpdate (void) |
Static Public Member Functions | |
| static bool | sendUpdateAll (void) |
Protected Member Functions | |
| _Shared (const string &name) throw (Exception) | |
| virtual | ~_Shared () |
| virtual chain | pack (void) |
| virtual bool | unpack (chain &s, unsigned int &used) |
Protected Attributes | |
| SharedBase * | sb |
| string | name |
| bool | changed |
| UpdateMode | updatemode |
| boost::condition_variable | trigger |
| nodeId | lastchanged |
| std::set< nodeId > | owners |
| chain | currentdata |
| chain | nextdata |
Friends | |
| class | SharedBase |
| class | SharedPacket |
Detailed Description
Abstract base class for shared variables.
- Todo:
- Prefetch new values, presend updates.
Definition at line 139 of file shared.h.
Member Enumeration Documentation
Constructor & Destructor Documentation
Constructor.
- Parameters:
-
name The variable name.
- Exceptions:
-
Exception.
| virtual libglass::_Shared::~_Shared | ( | ) | [protected, virtual] |
Destructor.
Member Function Documentation
| bool libglass::_Shared::getUpdate | ( | void | ) |
Synchronizes this variable.
- Return values:
-
True If successful. false Otherwise.
| UpdateMode libglass::_Shared::getUpdateMode | ( | void | ) | const [inline] |
| bool libglass::_Shared::hasChanged | ( | void | ) | const [inline] |
| virtual chain libglass::_Shared::pack | ( | void | ) | [inline, protected, virtual] |
Pack function. Serializes the variable to a string.
- Returns:
- The variable, serialized to a string.
Reimplemented in libglass::Shared< T, T, T >.
| bool libglass::_Shared::sendUpdate | ( | void | ) |
| static bool libglass::_Shared::sendUpdateAll | ( | void | ) | [static] |
Synchronizes all variables.
All updates are sent as one, saving bandwidth and cutting the delay.
- Warning:
- IMPORTANT! Since this method is static, it guesses that the variable you want to synchronize are those of the current Glass class. You only have to care about this if you instantiate more than one Glass derived class in the same application, which you are almost certainly not doing. If you don't know for sure, you are not doing it; go worry about something else.
- See also:
- Glass.
- Return values:
-
True If successful. false Otherwise.
| void libglass::_Shared::setUpdateMode | ( | UpdateMode | updatemode | ) | [inline] |
| virtual bool libglass::_Shared::unpack | ( | chain & | s, | |
| unsigned int & | used | |||
| ) | [inline, protected, virtual] |
Unpack function. Unserializes the string to a variable.
- Parameters:
-
s The string. used The number of bytes used by the unserialization.
- Returns:
Reimplemented in libglass::Shared< T, T, T >.
Friends And Related Function Documentation
friend class SharedBase [friend] |
Member Data Documentation
bool libglass::_Shared::changed [protected] |
have we changed since the last update?
Definition at line 153 of file shared.h.
Referenced by libglass::Shared< T, T, T >::assign(), and libglass::Shared< T, T, T >::operator=().
chain libglass::_Shared::currentdata [protected] |
nodeId libglass::_Shared::lastchanged [protected] |
string libglass::_Shared::name [protected] |
chain libglass::_Shared::nextdata [protected] |
std::set<nodeId> libglass::_Shared::owners [protected] |
SharedBase* libglass::_Shared::sb [protected] |
boost::condition_variable libglass::_Shared::trigger [protected] |
UpdateMode libglass::_Shared::updatemode [protected] |
The documentation for this class was generated from the following file:
