CL_Event Class Reference [clanCore System]

OS level event. More...

#include <event.h>

List of all members.

Public Member Functions
Construction
	CL_Event (bool manual_reset=true, bool initial_state=false)
	Constructs an event object.
	CL_Event (CL_EventProvider *event_provider)
	~CL_Event ()
Attributes
CL_EventProvider *	get_event_provider () const
	Returns the event provider for this event.
Operations
bool	wait (int timeout=-1)
	Wait for event to become flagged.
void	set ()
	Flag event.
void	reset ()
	Reset flag.
static int	wait (int count, CL_Event const *const *events, int timeout=-1)
static int	wait (const std::vector< CL_Event * > &events, int timeout=-1)
static int	wait (const std::vector< CL_Event > &events, int timeout=-1)
static int	wait (CL_Event &event1, int timeout=-1)
static int	wait (CL_Event &event1, CL_Event &event2, int timeout=-1)
static int	wait (CL_Event &event1, CL_Event &event2, CL_Event &event3, int timeout=-1)
static int	wait (CL_Event &event1, CL_Event &event2, CL_Event &event3, CL_Event &event4, int timeout=-1)
static int	wait (CL_Event &event1, CL_Event &event2, CL_Event &event3, CL_Event &event4, CL_Event &event5, int timeout=-1)
static int	wait (CL_Event &event1, CL_Event &event2, CL_Event &event3, CL_Event &event4, CL_Event &event5, CL_Event &event6, int timeout=-1)
static int	wait (CL_Event &event1, CL_Event &event2, CL_Event &event3, CL_Event &event4, CL_Event &event5, CL_Event &event6, CL_Event &event7, int timeout=-1)
static int	wait (CL_Event &event1, CL_Event &event2, CL_Event &event3, CL_Event &event4, CL_Event &event5, CL_Event &event6, CL_Event &event7, CL_Event &event8, int timeout=-1)

---

Detailed Description

OS level event.

---

Constructor & Destructor Documentation

CL_Event::CL_Event	(	bool	manual_reset = true,
		bool	initial_state = false
	)

Constructs an event object.

CL_Event::CL_Event

(

CL_EventProvider *

event_provider

)

CL_Event::~CL_Event

(

)

---

Member Function Documentation

CL_EventProvider* CL_Event::get_event_provider

(

)

const

Returns the event provider for this event.

void CL_Event::reset

(

)

Reset flag.

void CL_Event::set

(

)

Flag event.

static int CL_Event::wait	(	CL_Event &	event1,
		CL_Event &	event2,
		CL_Event &	event3,
		CL_Event &	event4,
		CL_Event &	event5,
		CL_Event &	event6,
		CL_Event &	event7,
		CL_Event &	event8,
		int	timeout = -1
	)			[static]

static int CL_Event::wait	(	CL_Event &	event1,
		CL_Event &	event2,
		CL_Event &	event3,
		CL_Event &	event4,
		CL_Event &	event5,
		CL_Event &	event6,
		CL_Event &	event7,
		int	timeout = -1
	)			[static]

static int CL_Event::wait	(	CL_Event &	event1,
		CL_Event &	event2,
		CL_Event &	event3,
		CL_Event &	event4,
		CL_Event &	event5,
		CL_Event &	event6,
		int	timeout = -1
	)			[static]

static int CL_Event::wait	(	CL_Event &	event1,
		CL_Event &	event2,
		CL_Event &	event3,
		CL_Event &	event4,
		CL_Event &	event5,
		int	timeout = -1
	)			[static]

static int CL_Event::wait	(	CL_Event &	event1,
		CL_Event &	event2,
		CL_Event &	event3,
		CL_Event &	event4,
		int	timeout = -1
	)			[static]

static int CL_Event::wait	(	CL_Event &	event1,
		CL_Event &	event2,
		CL_Event &	event3,
		int	timeout = -1
	)			[static]

static int CL_Event::wait	(	int	count,
		CL_Event const *const *	events,
		int	timeout = -1
	)			[static]

static int CL_Event::wait	(	CL_Event &	event1,
		int	timeout = -1
	)			[static]

static int CL_Event::wait	(	const std::vector< CL_Event > &	events,
		int	timeout = -1
	)			[static]

static int CL_Event::wait	(	const std::vector< CL_Event * > &	events,
		int	timeout = -1
	)			[static]

static int CL_Event::wait	(	CL_Event &	event1,
		CL_Event &	event2,
		int	timeout = -1
	)			[static]

bool CL_Event::wait

(

int

timeout = -1

)

Wait for event to become flagged.

Returns:

true = When was flagged. Else timeout

---

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

• Core/System/event.h