ciThread Class Reference

Inheritance diagram for ciThread:

Classes
struct	ThreadEvent

Public Member Functions
	ciThread (wxThreadKind kind=wxTHREAD_DETACHED)
virtual	~ciThread (void)
void	postThreadEvent (unsigned event, void *param=NULL)

Static Public Member Functions
static bool	testValid ()

Protected Member Functions
void	pushEvent (ThreadEvent *event)
void	popEvent ()
virtual bool	processEventQueue ()
virtual wxThread::ExitCode	Entry ()

Protected Attributes
int	m_eventStackSize
ThreadEvent **	m_eventQueue

Private Attributes
const int	m_stackSize

Static Private Attributes
static bool	m_isValid

Constructor & Destructor Documentation

ciThread::ciThread

(

wxThreadKind

kind = wxTHREAD_DETACHED

)

virtual ciThread::~ciThread ( void  )

virtual

Member Function Documentation

static bool ciThread::testValid ( )

inlinestatic

Description:

Tests the validity of a thread. If a thread has been auto deleted after completion, the pointer hangs around kind of uselessly. The member attribute m_isValid is set false in the destructor when the thread object is deleted.

Returns

true if the pointer to this thread object is still valid. false otherwise.

References m_isValid.

void ciThread::postThreadEvent	(	unsigned	event,
		void *	param = NULL
	)

Description:

Puts an event on the que for handling. Does not wait for return of event processing. Thread event processing is a FIFO service.

Parameters

event	- the event id to post.
param	- pointer associated with the event.

Returns

void

void ciThread::pushEvent ( ThreadEvent *  event )

protected

Description:

Adds an event to the que.

Returns

void.

void ciThread::popEvent ( )

protected

Description:

Removes the oldest event from the que.

Returns

void.

virtual bool ciThread::processEventQueue ( )

protectedvirtual

Description:

Event handler for the thread.

Returns

true if the wxWidgets method TestDestroy() has been invoked.

virtual wxThread::ExitCode ciThread::Entry ( )

protectedvirtual

Description:

The thread execution will start here.

Returns

wxThread::ExitCode for the thread

Member Data Documentation

int ciThread::m_eventStackSize

protected

Current size of the event stack

ThreadEvent** ciThread::m_eventQueue

protected

Event queue structure object

bool ciThread::m_isValid

staticprivate

Referenced by testValid().

const int ciThread::m_stackSize

private

---

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

• ciThread.h