Inheritance diagram for zeus::IThreadMessageQueue:

Public Member Functions
virtual void MQUALIFIER	flush ()=0
virtual Retval MQUALIFIER	processObject ()=0
virtual Retval MQUALIFIER	postObject (ISynchronizeObject &rObject, bool bWaitForCompletion)=0
virtual void MQUALIFIER	lock ()=0
virtual void MQUALIFIER	unlock ()=0
virtual bool MQUALIFIER	isLocked () const =0
virtual bool MQUALIFIER	isEmpty () const =0

Detailed Description

This interface defines the thread message queue. The queue is used to send messages to the thread for synchronizing

Member Function Documentation

virtual void MQUALIFIER zeus::IThreadMessageQueue::flush ( ) [pure virtual]

Clears the queue

virtual bool MQUALIFIER zeus::IThreadMessageQueue::isEmpty ( ) const [pure virtual]

checks if the queue is empty

virtual bool MQUALIFIER zeus::IThreadMessageQueue::isLocked ( ) const [pure virtual]

checks if the queue is locked

virtual void MQUALIFIER zeus::IThreadMessageQueue::lock ( ) [pure virtual]

locks the queue. All post calls will return an error

virtual Retval MQUALIFIER zeus::IThreadMessageQueue::postObject	(	ISynchronizeObject &	rObject,
		bool	bWaitForCompletion
	)		`[pure virtual]`

puts a object into the message queue

Parameters:

rObject	: Synchronizing object
bWaitForCompletion	: caller waits for completion

Return values:

RET_NOERROR	: Object posted
RET_REQUEST_FAILED	: Could not post object or waiting was aborted

virtual Retval MQUALIFIER zeus::IThreadMessageQueue::processObject ( ) [pure virtual]

proceses the first object of the queue and removes it from the queue

Return values:

RET_NOERROR	: Object processed
RET_REQUEST_FAILED	: No object found for processing

virtual void MQUALIFIER zeus::IThreadMessageQueue::unlock ( ) [pure virtual]

unlocks the queue. The queue is ready to receive objects

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