MessagingImplementation.MessagingImplementation Class Reference
Detailed Description
Represents the interface that a messaging implementation must provide.
Messages are created and sent using the createMessage() and sendMessage() methods.
To indicate that a message is being processed by a message receiver, wrap the processing around startProcessMessage() and endProcessMessage() method calls.
To indicate that a message is being dispatched to message receivers, wrap the dispatch around the startDispatchMessage() and endDispatchMessage() method calls.
The main processing loop should look similar to this:
message = implementation.getNextMessage()
while message is not None: implementation.startDispatchMessage( message )
for receiver in receivers: implementation.startProcessMessage( message )
...receiver message-processing code...
implementation.endProcessMessage()
implementation.endDispatchMessage()
message = implementation.getNextMessage()
#include
<class_messaging_implementation_1_1_messaging_implementation.h>
Public Member Functions |
|
| __init__ () | |
| createMessage () | |
| createMessageFromString () | |
| createMessagesFromStrings () | |
| createMessageDataFromString () | |
| sendMessage () | |
| undoMessage () | |
| isUndoMessage () | |
| isUndoRequested () | |
| startProcessMessage () | |
| endProcessMessage () | |
| setOnSendMessageCallback () | |
| Sets a callback to be called whenever a
message is sent. |
|
| executeOnSendMessageCallback () | |
| getNextMessage () | |
| startDispatchMessage () | |
| endDispatchMessage () | |
Member Function Documentation
| MessagingImplementation.MessagingImplementation.__init__ | ( | ) |
| MessagingImplementation.MessagingImplementation.createMessage | ( | ) |
| MessagingImplementation.MessagingImplementation.createMessageFromString | ( | ) |
| MessagingImplementation.MessagingImplementation.createMessagesFromStrings | ( | ) |
| MessagingImplementation.MessagingImplementation.createMessageDataFromString | ( | ) |
| MessagingImplementation.MessagingImplementation.sendMessage | ( | ) |
| MessagingImplementation.MessagingImplementation.undoMessage | ( | ) |
| MessagingImplementation.MessagingImplementation.isUndoMessage | ( | ) |
| MessagingImplementation.MessagingImplementation.isUndoRequested | ( | ) |
| MessagingImplementation.MessagingImplementation.startProcessMessage | ( | ) |
| MessagingImplementation.MessagingImplementation.endProcessMessage | ( | ) |
| MessagingImplementation.MessagingImplementation.setOnSendMessageCallback | ( | ) |
Sets a callback to be called whenever a message is sent.
This callback has no arguments.
| MessagingImplementation.MessagingImplementation.executeOnSendMessageCallback | ( | ) |
| MessagingImplementation.MessagingImplementation.getNextMessage | ( | ) |
| MessagingImplementation.MessagingImplementation.startDispatchMessage | ( | ) |
| MessagingImplementation.MessagingImplementation.endDispatchMessage | ( | ) |
