#include <yatengine.h>
Inheritance diagram for Message:
Public Member Functions | |
Message (const char *name, const char *retval=0) | |
Message (const Message &original) | |
~Message () | |
virtual void * | getObject (const String &name) const |
String & | retValue () |
const String & | retValue () const |
RefObject * | userData () const |
void | userData (RefObject *data) |
void * | userObject (const String &name) const |
void | setNotify (bool notify=true) |
Time & | msgTime () |
const Time & | msgTime () const |
Message & | operator= (const char *value) |
String | encode (const char *id) const |
String | encode (bool received, const char *id) const |
int | decode (const char *str, String &id) |
int | decode (const char *str, bool &received, const char *id) |
Protected Member Functions | |
virtual void | dispatched (bool accepted) |
Friends | |
class | MessageDispatcher |
This class holds the messages that are moved around in the engine.
|
Creates a new message.
|
|
Copy constructor. Note that user data and notification are not copied.
|
|
Destruct the message and dereferences any user data |
|
Decode a string from an external communication interface that is an answer to a specific external processing request.
|
|
Decode a string from an external communication interface for processing in the engine. The message is modified accordingly.
|
|
Notify the message it has been dispatched. The default behaviour is to call the dispatched() method of the user data if it implements MessageNotifier
|
|
Encode the message into a string adequate for sending as answer to an external communication interface
|
|
Encode the message into a string adequate for sending for processing to an external communication interface
|
|
Get a pointer to a derived class given that class name
Reimplemented from NamedList. |
|
Retrive a const reference to the creation time of the message.
|
|
Retrive a reference to the creation time of the message.
|
|
Name assignment operator Reimplemented from String. |
|
Retrive a const reference to the value returned by the message.
|
|
Retrive a reference to the value returned by the message.
|
|
Enable or disable notification of any MessageNotifier that was set as user data. This method must be called after userData()
|
|
Set obscure data associated with the message. The user data is reference counted to avoid stray pointers. Note that setting new user data will disable any notification.
|
|
Retrive the object associated with the message
|
|
Get a pointer to a derived class of user data given that class name
|