IMessageQueue class Null safety

Interface for asynchronous message queues.

Not all queues may implement all the methods. Attempt to call non-supported method will result in NotImplemented exception. To verify if specific method is supported consult with MessagingCapabilities.

See MessageEnvelope See MessagingCapabilities

Implemented types
Implementers

Constructors

IMessageQueue()

Properties

hashCode → int
The hash code for this object.
read-onlyinherited
runtimeType → Type
A representation of the runtime type of the object.
read-onlyinherited

Methods

abandon(MessageEnvelope message) → Future
Returnes message into the queue and makes it available for all subscribers to receive it again. This method is usually used to return a message which could not be processed at the moment to repeat the attempt. Messages that cause unrecoverable errors shall be removed permanently or/and send to dead letter queue.
beginListen(String? correlationId, IMessageReceiver receiver) → void
Listens for incoming messages without blocking the current thread.
close(String? correlationId) → Future
Closes component and frees used resources.
inherited
complete(MessageEnvelope message) → Future
Permanently removes a message from the queue. This method is usually used to remove the message after successful processing.
endListen(String? correlationId) → void
Ends listening for incoming messages. When this method is call listen unblocks the thread and execution continues.
getCapabilities() → MessagingCapabilities
Gets the queue capabilities
getName() → String
Gets the queue name
isOpen() → bool
Checks if the component is opened.
inherited
listen(String? correlationId, IMessageReceiver receiver) → void
Listens for incoming messages and blocks the current thread until queue is closed.
moveToDeadLetter(MessageEnvelope message) → Future
Permanently removes a message from the queue and sends it to dead letter queue.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed.
inherited
open(String? correlationId) → Future
Opens the component.
inherited
peek(String? correlationId) → Future<MessageEnvelope?>
Peeks a single incoming message from the queue without removing it. If there are no messages available in the queue it returns null.
peekBatch(String? correlationId, int messageCount) → Future<List<MessageEnvelope?>>
Peeks multiple incoming messages from the queue without removing them. If there are no messages available in the queue it returns an empty list.
readMessageCount() → Future<int>
Reads the current number of messages in the queue to be delivered.
receive(String? correlationId, int waitTimeout) → Future<MessageEnvelope?>
Receives an incoming message and removes it from the queue.
renewLock(MessageEnvelope message, int lockTimeout) → Future
Renews a lock on a message that makes it invisible from other receivers in the queue. This method is usually used to extend the message processing time.
send(String? correlationId, MessageEnvelope envelope) → Future
Sends a message into the queue.
sendAsObject(String? correlationId, String messageType, dynamic value) → Future
Sends an object into the queue. Before sending the object is converted into JSON string and wrapped in a MessageEnvelope.
toString() → String
A string representation of this object.
inherited

Operators

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