MessageQueue class
Abstract message queue that is used as a basis for specific message queue implementations.
Configuration parameters
- name: name of the message queue
connection(s)
:discovery_key
: key to retrieve parameters from discovery serviceprotocol
: connection protocol like http, https, tcp, udphost
: host name or IP addressport
: port numberuri
: resource URI or connection string with all parameters in it
credential(s)
:store_key
: key to retrieve parameters from credential storeusername
: user namepassword
: user passwordaccess_id
: application access idaccess_key
: application secret key
References
- *:logger:*:*:1.0 (optional)
ILogger
components to pass log messages - *:counters:*:*:1.0 (optional)
ICounters
components to pass collected measurements - *:discovery:*:*:1.0 (optional)
IDiscovery
components to discover connection(s) - *:credential-store:*:*:1.0 (optional)
ICredentialStore
componetns to lookup credential(s)
- Implemented types
- Implementers
Constructors
- MessageQueue([String name ])
- Creates a new instance of the message queue. [...]
Properties
- capabilities ↔ MessagingCapabilities
-
read / write
- connectionResolver ↔ ConnectionResolver
-
read / write
- counters ↔ CompositeCounters
-
read / write
- credentialResolver ↔ CredentialResolver
-
read / write
- logger ↔ CompositeLogger
-
read / write
- name ↔ String
-
read / write
- 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
-
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. [...]
override
-
beginListen(
String correlationId, IMessageReceiver receiver) → void -
Listens for incoming messages without blocking the current thread. [...]
override
-
clear(
String correlationId) → Future - Clears component state. [...]
-
close(
String correlationId) → Future - Closes component and frees used resources. [...]
-
complete(
MessageEnvelope message) → Future -
Permanently removes a message from the queue.
This method is usually used to remove the message after successful processing. [...]
override
-
configure(
ConfigParams config) → void - Configures component by passing configuration parameters. [...]
-
endListen(
String correlationId) → void -
Ends listening for incoming messages.
When this method is call [listen] unblocks the thread and execution continues. [...]
override
-
getCapabilities(
) → MessagingCapabilities -
Gets the queue capabilities [...]
override
-
getName(
) → String -
Gets the queue name [...]
override
-
isOpen(
) → bool - Checks if the component is opened. [...]
-
listen(
String correlationId, IMessageReceiver receiver) → void -
Listens for incoming messages and blocks the current thread until queue is closed. [...]
override
-
moveToDeadLetter(
MessageEnvelope message) → Future -
Permanently removes a message from the queue and sends it to dead letter queue. [...]
override
-
open(
String correlationId) → Future - Opens the component. [...]
-
openWithParams(
String correlationId, ConnectionParams connection, CredentialParams credential) → Future - Opens the component with given connection and credential parameters. [...]
-
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. [...]
override
-
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. [...]
override
-
readMessageCount(
) → Future< int> -
Reads the current number of messages in the queue to be delivered. [...]
override
-
receive(
String correlationId, int waitTimeout) → Future< MessageEnvelope> -
Receives an incoming message and removes it from the queue. [...]
override
-
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. [...]
override
-
send(
String correlationId, MessageEnvelope envelope) → Future -
Sends a message into the queue. [...]
override
-
sendAsObject(
String correlationId, String messageType, dynamic message) → Future -
Sends an object into the queue.
Before sending the object is converted into JSON string and wrapped in a [
MessageEnvelop
]. [...]override -
setReferences(
IReferences references) → void - Sets references to dependent components. [...]
-
toString(
) → String -
Gets a string representation of the object. [...]
override
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a non-existent method or property is accessed. [...]
inherited
Operators
-
operator ==(
dynamic other) → bool -
The equality operator. [...]
inherited