ResponseTarget Class Reference

Constructs a response (to be sent back to a script) More...

#include <CommandTargets.h>

Inheritance diagram for ResponseTarget:

Collaboration diagram for ResponseTarget:

Public Member Functions
	ResponseTarget ()
virtual	~ResponseTarget ()
void	Update (const wxString &message) override
virtual void	Flush () override
wxString	GetResponse ()
Public Member Functions inherited from CommandMessageTarget
	CommandMessageTarget ()
virtual	~CommandMessageTarget ()
virtual void	Update (const wxString &message)=0
virtual void	StartArray ()
virtual void	EndArray ()
virtual void	StartStruct ()
virtual void	EndStruct ()
virtual void	AddItem (const wxString &value, const wxString &name={})
virtual void	AddBool (const bool value, const wxString &name={})
virtual void	AddItem (const double value, const wxString &name={})
virtual void	StartField (const wxString &name={})
virtual void	EndField ()
virtual void	Flush ()
wxString	Escaped (const wxString &str)

Private Attributes
wxSemaphore	mSemaphore
wxString	mBuffer

Additional Inherited Members
Public Attributes inherited from CommandMessageTarget
std::vector< int >	mCounts

Detailed Description

Constructs a response (to be sent back to a script)

Definition at line 226 of file CommandTargets.h.

Constructor & Destructor Documentation

ResponseTarget()

ResponseTarget::ResponseTarget ( )

inline

Definition at line 232 of file CommandTargets.h.

      : mSemaphore(0, 1),
        mBuffer(wxEmptyString)
   { 
      // Cater for handling long responses quickly.
      mBuffer.Alloc(40000);
   }

References mBuffer.

~ResponseTarget()

virtual ResponseTarget::~ResponseTarget ( )

inlinevirtual

Definition at line 239 of file CommandTargets.h.

   {
   }

Member Function Documentation

Flush()

virtual void ResponseTarget::Flush ( )

inlineoverridevirtual

Reimplemented from CommandMessageTarget.

Definition at line 246 of file CommandTargets.h.

   {
      mSemaphore.Post();
   }

References mSemaphore.

GetResponse()

wxString ResponseTarget::GetResponse ( )

inline

Definition at line 250 of file CommandTargets.h.

   {
      mSemaphore.Wait();
      return mBuffer;
   }

References mBuffer, and mSemaphore.

Update()

void ResponseTarget::Update ( const wxString &  message )

inlineoverridevirtual

Implements CommandMessageTarget.

Definition at line 242 of file CommandTargets.h.

   {
      mBuffer += message;
   }

References mBuffer.

Member Data Documentation

mBuffer

wxString ResponseTarget::mBuffer

private

Definition at line 230 of file CommandTargets.h.

Referenced by GetResponse(), ResponseTarget(), and Update().

mSemaphore

wxSemaphore ResponseTarget::mSemaphore

private

Definition at line 229 of file CommandTargets.h.

Referenced by Flush(), and GetResponse().

---

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

• CommandTargets.h