ResponseQueue Class Reference

Allow messages to be sent from the main thread to the script thread. More...

#include <ResponseQueue.h>

Collaboration diagram for ResponseQueue:

Public Member Functions
	ResponseQueue ()
	~ResponseQueue ()
void	AddResponse (Response response)
Response	WaitAndGetResponse ()

Private Attributes
std::queue< Response >	mResponses
wxMutex	mMutex
wxCondition	mCondition

Detailed Description

Allow messages to be sent from the main thread to the script thread.

Based roughly on wxMessageQueue<T> (which hasn't reached the stable wxwidgets yet). Wraps a std::queue<Response> inside a wxMutex with a wxCondition to force the script thread to wait until a response is available.

Definition at line 60 of file ResponseQueue.h.

Constructor & Destructor Documentation

ResponseQueue()

ResponseQueue::ResponseQueue

(

)

Definition at line 22 of file ResponseQueue.cpp.

   : mCondition(mMutex)
{ }

~ResponseQueue()

ResponseQueue::~ResponseQueue

(

)

Definition at line 26 of file ResponseQueue.cpp.

{ }

Member Function Documentation

AddResponse()

void ResponseQueue::AddResponse

(

Response

response

)

Definition at line 29 of file ResponseQueue.cpp.

{
   wxMutexLocker locker(mMutex);
   mResponses.push(response);
   mCondition.Signal();
}

References mCondition, mMutex, and mResponses.

WaitAndGetResponse()

Response ResponseQueue::WaitAndGetResponse

(

)

Definition at line 36 of file ResponseQueue.cpp.

{
   wxMutexLocker locker(mMutex);
   if (mResponses.empty())
   {
      mCondition.Wait();
   }
   wxASSERT(!mResponses.empty());
   Response msg = mResponses.front();
   mResponses.pop();
   return msg;
}

References mCondition, mMutex, and mResponses.

Member Data Documentation

mCondition

wxCondition ResponseQueue::mCondition

private

Definition at line 64 of file ResponseQueue.h.

Referenced by AddResponse(), and WaitAndGetResponse().

mMutex

wxMutex ResponseQueue::mMutex

private

Definition at line 63 of file ResponseQueue.h.

Referenced by AddResponse(), and WaitAndGetResponse().

mResponses

std::queue<Response> ResponseQueue::mResponses

private

Definition at line 62 of file ResponseQueue.h.

Referenced by AddResponse(), and WaitAndGetResponse().

---

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

• ResponseQueue.h
• ResponseQueue.cpp