---

strmod::unievent::Event Class Reference

An event to be queued up in a UNIDispatcher. More...

#include <UniEvent/Event.h>

Inheritance diagram for strmod::unievent::Event:

[legend]List of all members.

Public Methods
	Event ()
	Nothing exciting here.
virtual	~Event ()
	This is an interface class, of course it has a virtual destructor.
virtual int	AreYouA (const lcore::ClassIdent &cid) const
	Asks if a class is of a particular type, or publicly derived from that type.
virtual void	triggerEvent (Dispatcher *dispatcher=0)=0
	Perform the action associated with the event.
virtual void	interrupt ()
	Interrupt the current event if possible.
void	operator() (Dispatcher *dispatcher)
	Alternate form of TriggerEvent.
void	operator() ()
	Alternate form of TriggerEvent.
Static Public Attributes
const UNEVT_ClassIdent	identifier
	Globally unique identifier for this class.
Protected Methods
virtual const lcore::ClassIdent *	i_GetIdent () const
	Returns the class identifier for the class the object actually is.

---

Detailed Description

An event to be queued up in a UNIDispatcher.

Definition at line 46 of file Event.h.

---

Member Function Documentation

int strmod::unievent::Event::AreYouA (  const lcore::ClassIdent &    cid )  const [inline, virtual]

Asks if a class is of a particular type, or publicly derived from that type. Overriden in every derived class (with a static identifier member) to compare against the identifier, then call the AreYouA methods of all the superclasses. Parameters: cid  Usually <class>::identifier for the class you want to ask if the object is an instance of. Reimplemented from strmod::lcore::Protocol. Definition at line 92 of file Event.h.

virtual const lcore::ClassIdent* strmod::unievent::Event::i_GetIdent (    )  const [inline, protected, virtual]

Returns the class identifier for the class the object actually is. Should always be overridden in any class that has a static identifier member. Reimplemented from strmod::lcore::Protocol. Definition at line 82 of file Event.h.

virtual void strmod::unievent::Event::interrupt (    )  [inline, virtual]

Interrupt the current event if possible. MUST be thread-safe, signal-safe, and otherwise prepared to be called in very strange contexts! This method should cause the currently executing event to return as quickly as possible. This may not be possible to do for all kinds of events. This method will only be called just before, during, or just after the triggerEvent() method is called. Definition at line 74 of file Event.h.

virtual void strmod::unievent::Event::triggerEvent (  Dispatcher *    dispatcher = 0 )  [pure virtual]

Perform the action associated with the event. If the event was triggered by a dispatcher, the dispatcher that triggered it is expected to be passed in. Otherwise NULL (aka 0) can be passed in. A dispatcher will only call ONE triggerEvent method at a time.

---

Member Data Documentation

const UNEVT_ClassIdent strmod::unievent::Event::identifier [static]

Globally unique identifier for this class. Every class that might need to be identified should have a public static const identifier object in it. Reimplemented from strmod::lcore::Protocol.

---

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

• Event.h
• Event.cxx

---