libglass::_Event Class Reference

#include <event.h>

Inheritance diagram for libglass::_Event:

libglass::PluginInterface libglass::Event< T, T, T > libglass::EventSerializable

List of all members.

Protected Member Functions

 _Event (const char *name) throw (Exception)
virtual ~_Event ()
bool _enqueueEvent (chain &s, nodeId target)
bool _enqueueEvent (chain &s, std::vector< nodeId > &targets)
virtual bool pushEvent (chain &s, nodeId sender)=0

Friends

class EventBase
class EventPacket


Detailed Description

Definition at line 103 of file event.h.


Constructor & Destructor Documentation

libglass::_Event::_Event ( const char *  name  )  throw (Exception) [protected]

Constructor.

virtual libglass::_Event::~_Event (  )  [protected, virtual]

Destructor.


Member Function Documentation

bool libglass::_Event::_enqueueEvent ( chain s,
std::vector< nodeId > &  targets 
) [protected]

bool libglass::_Event::_enqueueEvent ( chain s,
nodeId  target 
) [protected]

Enqueues an event, sending it to other nodes.

The event is not enqueued locally.

Parameters:
s The packed event.
target The target node.
Return values:
True if successfully sent.
False if an error occurred.
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters:
s The packed event.
targets The list of target nodes.
target The target node.

Referenced by libglass::Event< T, T, T >::enqueueEvent().

virtual bool libglass::_Event::pushEvent ( chain s,
nodeId  sender 
) [protected, pure virtual]

Enqueues locally an event received by the network.

Parameters:
s The packed event.
sender The node which created the event.
Return values:
True if successfully queued.
False if an error occurred.

Implemented in libglass::Event< T, T, T >, and libglass::EventSerializable.


Friends And Related Function Documentation

friend class EventBase [friend]

Definition at line 109 of file event.h.

friend class EventPacket [friend]

Definition at line 110 of file event.h.


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

Generated on Fri May 28 13:19:01 2010 for libGlass by  doxygen 1.5.8