![]() |
Murl Engine API
Version 2018.3
|
The message base class. More...
#include <murl_util_message.h>
The message base class.
The Message class is used to send messages by the MessageQueue class. The Message class can be sub-classed to add used defined members, see MessageThread.
To synchonize message delivery so called sync-messages are available:
The message sender waits until the message is delivered and processed. The processing of a message ends when calling the Signal() method, which is typically called by the message destructor.
Inherited by Murl::Core::Engine::InvokeMethodCallMessage, Murl::Core::Engine::LicenseTerminatedMessage, Murl::Core::Engine::LoaderTerminatedMessage, Murl::Core::Engine::LogicConfigChangedMessage, Murl::Core::Engine::LogicFinishedMessage, Murl::Core::Engine::LogicTerminatedMessage, Murl::Core::Engine::RenderingFinishedMessage, Murl::Net::SocketClient::AddressMessage, Murl::Net::SocketSender::DataMessage, Murl::Net::SocketServer::AddressMessage, Murl::Net::SocketServer::ClientIdMessage, Murl::Platform::Foundation::Av::MovieVideoStream::WorkerThread::CreateOutputMessage, Murl::Platform::Foundation::Av::MovieVideoStream::WorkerThread::DestroyOutputMessage, Murl::Platform::Foundation::Av::MovieVideoStream::WorkerThread::GetFrameMessage, Murl::Platform::Foundation::Av::MovieVideoStream::WorkerThread::StartOutputMessage, and Murl::Platform::Foundation::Av::MovieVideoStream::WorkerThread::StopOutputMessage.
Public Types | |
enum | Id { ID_USER, ID_TIMEOUT, ID_QUIT, ID_ANY } |
Enumeration of the message identifiers. More... | |
typedef AutoPointer< Message > | AutoPtr |
Definition of the Message class auto pointer. | |
Public Member Functions | |
Message (UInt32 messageId) | |
The constructor. More... | |
virtual | ~Message () |
The destructor. More... | |
virtual UInt32 | GetId () const |
Get the message identifier. More... | |
Bool | SetSignal (System::Semaphore *sync) |
Set the sync-message semaphore. More... | |
Bool | Signal () |
Signal the sync-message semaphore, which means the processing of the message is finished. More... | |
Protected Attributes | |
UInt32 | mMessageId |
The message identifier. More... | |
Murl::Util::Message::Message | ( | UInt32 | messageId | ) |
The constructor.
messageId | The message identifier. |
|
virtual |
The destructor.
Calls Signal().
|
virtual |
Get the message identifier.
Bool Murl::Util::Message::SetSignal | ( | System::Semaphore * | sync | ) |
Set the sync-message semaphore.
For sending sync-messages a semaphore is used to wait until the message is processed.
sync | Pointer to the semaphore. |
Bool Murl::Util::Message::Signal | ( | ) |
Signal the sync-message semaphore, which means the processing of the message is finished.
This is typically done at Message object destruction.
|
protected |
The message identifier.