StompClient class - stomp_client library

Constructors

StompClient.new({required Host host, required PeerId serverPeerId, required String hostName, String? login, String? passcode, Duration timeout = StompConstants.defaultTimeout})

Properties

hashCode → int: The hash code for this object.
no setterinherited
isConnected → bool: Whether the client is connected
no setter
onError → Stream<StompServerErrorException>: Stream of server errors
no setter
onFrame → Stream<StompFrame>: Stream of all frames (for debugging/monitoring)
no setter
onStateChange → Stream<StompClientState>: Stream of state changes
no setter
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
serverHeaders → Map<String, String>: Server headers from CONNECTED frame
no setter
serverInfo → String?: Server information
no setter
sessionId → String?: Session ID from the server
no setter
state → StompClientState: Current connection state
no setter
subscriptions → StompSubscriptionManager: Subscription manager
no setter
transactions → StompTransactionManager: Transaction manager
no setter

Methods

abortTransaction({required String transactionId, bool requestReceipt = false}) → Future<void>: Aborts a transaction
ack({required String messageId, String? transactionId, bool requestReceipt = false}) → Future<void>: Acknowledges a message
beginTransaction({String? transactionId, bool requestReceipt = false}) → Future<StompTransaction>: Begins a transaction
close() → Future<void>: Closes the client and cleans up resources
commitTransaction({required String transactionId, bool requestReceipt = false}) → Future<void>: Commits a transaction
connect() → Future<void>: Connects to the STOMP server
disconnect() → Future<void>: Disconnects from the STOMP server
nack({required String messageId, String? transactionId, bool requestReceipt = false}) → Future<void>: Negatively acknowledges a message
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
send({required String destination, String? body, Uint8List? bodyBytes, String? contentType, String? transactionId, bool requestReceipt = false, Map<String, String>? headers}) → Future<String?>: Sends a message to a destination
subscribe({required String destination, String? id, StompAckMode ackMode = StompAckMode.auto, bool requestReceipt = false, Map<String, String>? headers}) → Future<StompSubscription>: Subscribes to a destination
toString() → String: A string representation of this object.
inherited
unsubscribe({required String subscriptionId, bool requestReceipt = false}) → Future<void>: Unsubscribes from a destination

Operators

operator ==(Object other) → bool: The equality operator.
inherited