| | |
- Method resolution order:
- StompCLI
- stomp.listener.ConnectionListener
- __builtin__.object
Methods defined here:
- __init__(self, host='localhost', port=61613, user='', passcode='')
- abort(self, args)
- Usage:
abort <transaction-id>
Required Parameters:
transaction-id - the transaction to abort
Description:
Roll back a transaction in progress.
- ack(self, args)
- Usage:
ack <message-id> [transaction-id]
Required Parameters:
message-id - the id of the message being acknowledged
Optional Parameters:
transaction-id - the acknowledgement should be a part of the named transaction
Description:
The command 'ack' is used to acknowledge consumption of a message from a subscription using client
acknowledgment. When a client has issued a 'subscribe' with the ack flag set to client, any messages
received from that destination will not be considered to have been consumed (by the server) until
the message has been acknowledged.
- begin(self, args)
- Usage:
begin
Description:
Start a transaction. Transactions in this case apply to sending and acknowledging -
any messages sent or acknowledged during a transaction will be handled atomically based on the
transaction.
- commit(self, args)
- Usage:
commit <transaction-id>
Required Parameters:
transaction-id - the transaction to commit
Description:
Commit a transaction in progress.
- disconnect(self, args)
- Usage:
disconnect
Description:
Gracefully disconnect from the server.
- help(self, args)
- Usage:
help [command]
Description:
Display info on a specified command, or a list of available commands
- on_connected(self, headers, body)
- on_connecting(self, host_and_port)
- on_disconnected(self)
- on_error(self, headers, body)
- on_message(self, headers, body)
- on_receipt(self, headers, body)
- send(self, args)
- Usage:
send <destination> <message>
Required Parameters:
destination - where to send the message
message - the content to send
Description:
Sends a message to a destination in the messaging system.
- sendtrans(self, args)
- Usage:
sendtrans <destination> <transaction-id> <message>
Required Parameters:
destination - where to send the message
transaction-id - the id of the transaction in which to enlist this message
message - the content to send
Description:
Sends a message to a destination in the message system, using a specified transaction.
- stats(self, args)
- Usage:
stats [on|off]
Description:
Record statistics on messages sent, received, errors, etc. If no argument (on|off) is specified,
dump the current statistics.
- subscribe(self, args)
- Usage:
subscribe <destination> [ack]
Required Parameters:
destination - the name to subscribe to
Optional Parameters:
ack - how to handle acknowledgements for a message; either automatically (auto) or manually (client)
Description:
Register to listen to a given destination. Like send, the subscribe command requires a destination
header indicating which destination to subscribe to. The ack parameter is optional, and defaults to
auto.
- unsubscribe(self, args)
- Usage:
unsubscribe <destination>
Required Parameters:
destination - the name to unsubscribe from
Description:
Remove an existing subscription - so that the client no longer receive messages from that destination.
Methods inherited from stomp.listener.ConnectionListener:
- on_send(self, headers, body)
Data descriptors inherited from stomp.listener.ConnectionListener:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
|