XbmcThreads::CEventGroup Class Reference

#include <Event.h>

Public Member Functions
	CEventGroup (std::initializer_list< CEvent * > events)
	~CEventGroup ()
CEvent *	wait ()
CEvent *	wait (unsigned int milliseconds)
int	getNumWaits ()

Friends
class	::CEvent

Detailed Description

CEventGroup is a means of grouping CEvents to wait on them together. It is equivalent to WaitOnMultipleObject that returns when "any" Event in the group signaled.

Constructor & Destructor Documentation

CEventGroup()

XbmcThreads::CEventGroup::CEventGroup

(

std::initializer_list< CEvent * >

events

)

Create a CEventGroup from a number of CEvents.

~CEventGroup()

XbmcThreads::CEventGroup::~CEventGroup

(

)

Member Function Documentation

getNumWaits()

int XbmcThreads::CEventGroup::getNumWaits ( )

inline

This is mostly for testing. It allows a thread to make sure there are the right amount of other threads waiting.

wait() [1/2]

CEvent * XbmcThreads::CEventGroup::wait

(

)

This will block until any one of the CEvents in the group are signaled at which point a pointer to that CEvents will be returned.

wait() [2/2]

CEvent * XbmcThreads::CEventGroup::wait

(

unsigned int

milliseconds

)

This will block until any one of the CEvents in the group are signaled or the timeout is reached. If an event is signaled then it will return a pointer to that CEvent, otherwise it will return NULL.

Friends And Related Function Documentation

::CEvent

friend class ::CEvent

friend

---

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

• Event.h
• Event.cpp