libglass::SharedBase Class Reference

#include <shared.h>

Inheritance diagram for libglass::SharedBase:

List of all members.

Protected Member Functions
bool	registerShared (_Shared *v)
bool	unregisterShared (_Shared *v)
bool	sendUpdate (_Shared *s)
bool	getUpdate (_Shared *s)
bool	sendUpdateAll (void)
virtual	~SharedBase ()
Friends
class	_Shared

---

Detailed Description

Shared variables plugin.

Provides synchronous shared variables among the nodes.

Format of Shared Plugin packets:

• Client->server: [action (1 byte)][variable name (ended by \0)][data]
• Server->client: [action (1 byte)][variable name (ended by \0)][data]

where valid action commands are described below.

These are valid actions in client->server packets:

• 'C' = created a variable.
• 'U' = updated a variable.
• 'D' = deleted a variable.
• 'S' = synchronized a variable.

These are valid actions in server->client packets:

• 'C' = changed variable.

See also:

_Shared, Shared.

Definition at line 61 of file shared.h.

---

Constructor & Destructor Documentation

virtual libglass::SharedBase::~SharedBase

(

)

[protected, virtual]

Destructor.

---

Member Function Documentation

bool libglass::SharedBase::getUpdate

(

_Shared *

s

)

[protected]

Synchronizes the value of a given variable with the most current value.

Parameters:

s

The shared variable.

Return values:

	true	If successful.
	false	Otherwise.

bool libglass::SharedBase::registerShared

(

_Shared *

v

)

[protected]

Registers a shared variable in the list.

Parameters:

v

A pointer to the variable.

Return values:

	true	If successful.
	false	Otherwise.

bool libglass::SharedBase::sendUpdate

(

_Shared *

s

)

[protected]

Updates the shared variable with the current local value.

Parameters:

s

The shared variable.

Return values:

	true	If successful.
	false	Otherwise.

bool libglass::SharedBase::sendUpdateAll

(

void

)

[protected]

Synchronizes the value of all variables.

Return values:

	true	If successful.
	false	Otherwise.

bool libglass::SharedBase::unregisterShared

(

_Shared *

v

)

[protected]

Unregisters a shared variable, taking it off the list.

Parameters:

v

A pointer to the variable.

Return values:

	true	If successful.
	false	Otherwise.

---

Friends And Related Function Documentation

friend class _Shared [friend]

Definition at line 67 of file shared.h.

---

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

• shared.h