StompClient class

A STOMP client.

Constructors

StompClient()

Properties

heartbeat → List<int>
The heart beat. A two-element array. The first element is [...]
read-only
isDisconnected → bool
Whether it is disconnected from the server.
read-only
server → String
The information about the STOMP server, such as ripple/1.0.0.
read-only
session → String
A session identifier that uniquely identifies the session. [...]
read-only
hashCode → int
The hash code for this object.
read-only, inherited
runtimeType → Type
A representation of the runtime type of the object.
read-only, inherited

Methods

abort(String transaction, { String receipt }) → void
Aborts a transaction.
ack(String id, { String transaction }) → void
Acknowledges the consumption of a message. [...]
begin(String transaction, { String receipt }) → void
Starts a transaction. [...]
commit(String transaction, { String receipt }) → void
Commits a transaction.
disconnect({String receipt }) → Future
Disconnects. After disconnected, this object can not be used any more.
nack(String id, { String transaction }) → void
The opposite of ack.
receipt(String receipt, void onReceipt(String receipt)) → void
Adds a listener called when the RECEIPT frame of the given receipt-id [...]
sendBlob(String destination, Stream<List<int>> message, { Map<String, String> headers }) → Future
Sends a message read from a given Stream. [...]
sendBytes(String destination, List<int> message, { Map<String, String> headers }) → void
Sends an array of bytes. [...]
sendJson(String destination, dynamic message, { Map<String, String> headers }) → void
Sends a JSON message. [...]
sendString(String destination, String message, { Map<String, String> headers }) → void
Sends a String-typed message. [...]
subscribeBlob(String id, String destination, void onMessage(Map<String, String> headers, Stream<List<int>> message), { Ack ack: AUTO, String receipt, Matcher matcher: exact, Map extraHeaders }) → void
Subscribes for listening to a given destination. [...]
subscribeBytes(String id, String destination, void onMessage(Map<String, String> headers, List<int> message), { Ack ack: AUTO, String receipt, Matcher matcher: exact, Map extraHeaders }) → void
Subscribes for listening a given destination; assuming the message [...]
subscribeJson(String id, String destination, void onMessage(Map<String, String> headers, dynamic message), { Ack ack: AUTO, String receipt, Matcher matcher: exact, Map extraHeaders }) → void
Subscribes for listening a given destination; assuming the message [...]
subscribeString(String id, String destination, void onMessage(Map<String, String> headers, String message), { Ack ack: AUTO, String receipt, Matcher matcher: exact, Map extraHeaders }) → void
Subscribes for listening a given destination; assuming the message [...]
unreceipt(String receipt) → void
Removes the listener added by receipt.
unsubscribe(String id) → void
Unsubscribes. [...]
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed.
inherited
toString() → String
Returns a string representation of this object.
inherited

Operators

operator ==(dynamic other) → bool
The equality operator.
inherited

Static Methods

connect(StompConnector connector, { String host, String login, String passcode, List<int> heartbeat, void onConnect(StompClient client, Map<String, String> headers), void onDisconnect(StompClient client), void onError(StompClient client, String message, String detail, Map<String, String> headers), void onFault(StompClient client, dynamic error, dynamic stackTrace) }) → Future<StompClient>
Connects a STOMP server, and instantiates a StompClient [...]