MessageQueue.MessageQueue Class Reference
Public Member Functions |
|
| __init__ () | |
| updateStatus () | |
| setStatusCallback () | |
| registerCreateMessageCallback () | |
| Register any additional callbacks that need
to be executed before the message can be fully created. |
|
| createMessage () | |
| Creates a message with a given id and
message data. |
|
| add () | |
| Adds the message of the given ID with the
given data to the queue. |
|
| addMessage () | |
| If you have created a message using the
createMessage()
method, you should use this one instead of just add. |
|
| addList () | |
| Adds a list of well-formed messages to the
queue. |
|
| findMessage () | |
| Returns the index of a message in the queue
that matches the given id and data. |
|
| __contains__ () | |
| Return True if a message queue contains a
message having the specified message identifier. |
|
Member Function Documentation
| MessageQueue.MessageQueue.__init__ | ( | ) |
| MessageQueue.MessageQueue.updateStatus | ( | ) |
| MessageQueue.MessageQueue.setStatusCallback | ( | ) |
| MessageQueue.MessageQueue.registerCreateMessageCallback | ( | ) |
Register any additional callbacks that need to be executed before the message can be fully created.
| MessageQueue.MessageQueue.createMessage | ( | ) |
Creates a message with a given id and message data.
| MessageQueue.MessageQueue.add | ( | ) |
Adds the message of the given ID with the given data to the queue.
Adds nothing if the message with the given ID has not yet been registered.
Note: this overrides the add() method of the Queue class (although it has a different number of arguments.
| MessageQueue.MessageQueue.addMessage | ( | ) |
If you have created a message using the createMessage() method, you should use this one instead of just add.
| MessageQueue.MessageQueue.addList | ( | ) |
Adds a list of well-formed messages to the queue.
All messages will be added as one 'chunk', the queue is locked before the first message is added and unlocked after the last message.
| MessageQueue.MessageQueue.findMessage | ( | ) |
Returns the index of a message in the queue that matches the given id and data.
If a matching message was not found, then returns -1.
| MessageQueue.MessageQueue.__contains__ | ( | ) |
Return True if a message queue contains a message having the specified message identifier.
