csEventQueue Class Reference
This class represents a general event queue. More...
#include <csutil/cseventq.h>
Inheritance diagram for csEventQueue:

Public Member Functions | |
virtual void | ChangeListenerTrigger (iEventHandler *, unsigned int trigger) |
Change a listener's trigger. | |
virtual void | Clear () |
Clear event queue. | |
uint32 | CountPool () |
Get a count of events in the pool, for testing only. | |
virtual csPtr< iEvent > | CreateEvent (uint8 type) |
Grab an event from the pool or make a new one if it's empty. | |
virtual csPtr< iEventOutlet > | CreateEventOutlet (iEventPlug *) |
Register an event plug and return a new outlet. | |
csEventQueue (iObjectRegistry *, size_t iLength=DEF_EVENT_QUEUE_LENGTH) | |
Initialize the event queue. | |
virtual void | Dispatch (iEvent &) |
Dispatch a single event from the queue; normally called by Process (). | |
virtual csPtr< iEvent > | Get () |
Get next event from queue or a null references if no event. | |
virtual iEventCord * | GetEventCord (int Category, int Subcategory) |
Get the event cord for a given category and subcategory. | |
virtual iEventOutlet * | GetEventOutlet () |
Get a public event outlet for posting just an event. | |
virtual bool | IsEmpty () |
Query if queue is empty (@@ Not thread safe!). | |
virtual void | Post (iEvent *) |
Place an event into queue. | |
virtual void | Process () |
Process the event queue. Calls Dispatch () once for each contained event. | |
virtual void | RegisterListener (iEventHandler *, unsigned int trigger) |
Register a listener for specific events. | |
virtual void | RemoveAllListeners () |
Unregister all listeners. | |
virtual void | RemoveListener (iEventHandler *) |
Unregister a listener. | |
virtual | ~csEventQueue () |
Destroy an event queue object. | |
Public Attributes | |
SCF_DECLARE_IBASE | |
Friends | |
class | csEventOutlet |
class | csPoolEvent |
Detailed Description
This class represents a general event queue.See the documentation of iEventQueue for a detailed description of each method. One instance of this class is usually shared via iObjectRegistry. Event queues are thread-safe.
Definition at line 53 of file cseventq.h.
Constructor & Destructor Documentation
|
Initialize the event queue.
|
|
Destroy an event queue object.
|
Member Function Documentation
|
Change a listener's trigger.
Implements iEventQueue. |
|
Clear event queue.
Implements iEventQueue. |
|
Get a count of events in the pool, for testing only.
|
|
Grab an event from the pool or make a new one if it's empty.
Implements iEventQueue. |
|
Register an event plug and return a new outlet.
Implements iEventQueue. |
|
Dispatch a single event from the queue; normally called by Process ().
Implements iEventQueue. |
|
Get next event from queue or a null references if no event.
Implements iEventQueue. |
|
Get the event cord for a given category and subcategory.
Implements iEventQueue. |
|
Get a public event outlet for posting just an event.
Implements iEventQueue. |
|
Query if queue is empty (@@ Not thread safe!).
Implements iEventQueue. Definition at line 158 of file cseventq.h. |
|
Place an event into queue.
Implements iEventQueue. |
|
Process the event queue. Calls Dispatch () once for each contained event.
Implements iEventQueue. |
|
Register a listener for specific events.
Implements iEventQueue. |
|
Unregister all listeners.
Implements iEventQueue. |
|
Unregister a listener.
Implements iEventQueue. |
The documentation for this class was generated from the following file:
- csutil/cseventq.h
Generated for Crystal Space by doxygen 1.4.4