MessageQueueStatusThread::StatusListener Class Reference

An interface to allow you to receive callbacks when a message has been read from a MessageQueue, subscribed via an external class which is monitoring the queue's MessageQueueBase::pollStatus() (e.g. LoadFileThread). More...

#include <MessageQueueStatusThread.h>

---

Detailed Description

An interface to allow you to receive callbacks when a message has been read from a MessageQueue, subscribed via an external class which is monitoring the queue's MessageQueueBase::pollStatus() (e.g. LoadFileThread).

Definition at line 19 of file MessageQueueStatusThread.h.

List of all members.

Public Member Functions
virtual	~StatusListener ()
	destructor -- does nothing
virtual void	messagesRead (MessageQueueBase &which, unsigned int howmany)=0
	Called after a message has been read by all receivers, and thus has been removed from the queue.

---

Constructor & Destructor Documentation

virtual MessageQueueStatusThread::StatusListener::~StatusListener

(

)

[virtual]

destructor -- does nothing

Definition at line 22 of file MessageQueueStatusThread.h.

---

Member Function Documentation

virtual void MessageQueueStatusThread::StatusListener::messagesRead	(	MessageQueueBase &	which,
		unsigned int	howmany
	)			[pure virtual]

Called after a message has been read by all receivers, and thus has been removed from the queue.

Don't assume that because you receive this callback there is space in the queue -- an earlier listener may have already added a message, or the queue might have been already waiting to send a message if the queue's overflowPolicy is MessageQueueBase::WAIT

Parameters:

	which	The MessageQueueBase which has had message(s) read
	howmany	The number of message which have been cleared

---

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

• MessageQueueStatusThread.h