Public API Reference

                 

---

csEventCord Class Reference

Event cord. More...

#include <csevcord.h>

Inheritance diagram for csEventCord:

List of all members.

Public Methods
	csEventCord (int category, int subcategory)
	Create an event cord for a given category/subcategory.
virtual	~csEventCord ()
	Destructor.
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 bool	GetPass () const
	Get whether events are passed to the system event queue.
virtual void	SetPass (bool flag)
	Set whether events are passed to the system event queue.
virtual int	GetCategory () const
	Get the category of this cord.
virtual int	GetSubcategory () const
	Get the subcategory of this cord.
Protected Methods
void	Lock ()
	Lock the queue for modifications: NESTED CALLS TO LOCK/UNLOCK NOT ALLOWED!
void	Unlock ()
	Unlock the queue.
Protected Attributes
volatile bool	pass
	Pass events to the system queue?
int	category
	The category and subcategory of this events on this cord.
int	subcategory
	The category and subcategory of this events on this cord.
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 31 of file csevcord.h.

---

Constructor & Destructor Documentation

csEventCord::csEventCord (  int    category, int    subcategory )

Create an event cord for a given category/subcategory.

virtual csEventCord::~csEventCord (    )  [virtual]

Destructor.

---

Member Function Documentation

virtual int csEventCord::GetCategory (    )  const [inline, virtual]

Get the category of this cord. Implements iEventCord. Definition at line 86 of file csevcord.h. References subcategory.

virtual bool csEventCord::GetPass (    )  const [inline, virtual]

Get whether events are passed to the system event queue. Implements iEventCord. Definition at line 80 of file csevcord.h. References pass.

virtual int csEventCord::GetSubcategory (    )  const [inline, virtual]

Get the subcategory of this cord. Implements iEventCord. Definition at line 89 of file csevcord.h.

virtual int csEventCord::Insert (  iEventHandler *   , int    priority )  [virtual]

Insert an event handler into the event cord. Implements iEventCord.

void csEventCord::Lock (    )  [inline, protected]

Lock the queue for modifications: NESTED CALLS TO LOCK/UNLOCK NOT ALLOWED! Definition at line 56 of file csevcord.h.

virtual void csEventCord::Remove (  iEventHandler *    )  [virtual]

Remove an event handler from the event cord. Implements iEventCord.

virtual void csEventCord::SetPass (  bool    flag )  [inline, virtual]

Set whether events are passed to the system event queue. Implements iEventCord. Definition at line 83 of file csevcord.h. References category.

void csEventCord::Unlock (    )  [inline, protected]

Unlock the queue. Definition at line 58 of file csevcord.h.

---

Friends And Related Function Documentation

friend class csEventOutlet [friend]

iEventOutlet places events into cords. Definition at line 61 of file csevcord.h.

---

Member Data Documentation

int csEventCord::category [protected]

The category and subcategory of this events on this cord. Definition at line 38 of file csevcord.h. Referenced by SetPass().

volatile bool csEventCord::pass [protected]

Pass events to the system queue? Definition at line 35 of file csevcord.h. Referenced by GetPass().

PluginData* csEventCord::plugins [protected]

The cord itself. Definition at line 50 of file csevcord.h.

volatile int csEventCord::SpinLock [protected]

Protection against multiple threads accessing the same cord. Definition at line 53 of file csevcord.h.

int csEventCord::subcategory [protected]

The category and subcategory of this events on this cord. Definition at line 38 of file csevcord.h. Referenced by GetCategory().

---

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

• csutil/csevcord.h

---