csEventCord Class Reference
Event cord. More...
#include <csutil/csevcord.h>
Inherits scfImplementation1<csEventCord, iEventCord>.
Public Member Functions | |
| csEventCord (csEventID, bool=false) | |
| Create an event cord for a given name. | |
| virtual csEventID | GetName () const |
| Get the category of this cord. | |
| virtual bool | GetPass () const |
| Get whether events are passed to the system event queue. | |
| virtual int | Insert (iEventHandler *, int priority) |
| Insert an event handler into the event cord. | |
| virtual void | Remove (iEventHandler *) |
| Remove an event handler from the event cord. | |
| virtual void | SetPass (bool flag) |
| Set whether events are passed to the system event queue. | |
| virtual | ~csEventCord () |
| Destructor. | |
Protected Member Functions | |
| void | Lock () |
| Lock the queue for modifications: NESTED CALLS TO LOCK/UNLOCK NOT ALLOWED! | |
| void | Unlock () |
| Unlock the queue. | |
Protected Attributes | |
| csEventID | name |
| The name of the events on this cord. | |
| volatile bool | pass |
| Pass events to the system queue? | |
| PluginData * | plugins |
| The cord itself. | |
| volatile int | SpinLock |
| Protection against multiple threads accessing the same cord. | |
Friends | |
| class | csEventOutlet |
| iEventOutlet places events into cords. | |
Detailed Description
Event cord.Definition at line 38 of file csevcord.h.
Constructor & Destructor Documentation
| csEventCord::csEventCord | ( | csEventID | , | |
| bool | = false | |||
| ) |
Create an event cord for a given name.
| virtual csEventCord::~csEventCord | ( | ) | [virtual] |
Destructor.
Member Function Documentation
| virtual csEventID csEventCord::GetName | ( | ) | const [inline, virtual] |
| virtual bool csEventCord::GetPass | ( | ) | const [inline, virtual] |
| virtual int csEventCord::Insert | ( | iEventHandler * | , | |
| int | priority | |||
| ) | [virtual] |
Insert an event handler into the event cord.
| void csEventCord::Lock | ( | ) | [inline, protected] |
Lock the queue for modifications: NESTED CALLS TO LOCK/UNLOCK NOT ALLOWED!
Definition at line 65 of file csevcord.h.
| virtual void csEventCord::Remove | ( | iEventHandler * | ) | [virtual] |
Remove an event handler from the event cord.
| virtual void csEventCord::SetPass | ( | bool | flag | ) | [inline, virtual] |
| void csEventCord::Unlock | ( | ) | [inline, protected] |
Friends And Related Function Documentation
friend class csEventOutlet [friend] |
Member Data Documentation
csEventID csEventCord::name [protected] |
volatile bool csEventCord::pass [protected] |
PluginData* csEventCord::plugins [protected] |
volatile int csEventCord::SpinLock [protected] |
Protection against multiple threads accessing the same cord.
Definition at line 62 of file csevcord.h.
The documentation for this class was generated from the following file:
- csutil/csevcord.h
Generated for Crystal Space 1.4.0 by doxygen 1.5.8
