Interface IMessageQueue<T>
Message queue.
Namespace: DNVGL.One.Compute.StorageLibrary.MessageQueue
Assembly: DNVGL.One.Compute.StorageLibrary.dll
Syntax
public interface IMessageQueue<T>
where T : classType Parameters
| Name | Description |
|---|---|
| T | Message type. |
Methods
View SourceCompleteMessage(T)
Notifies the message queue that the message has been processed by the receiver.
Declaration
Task CompleteMessage(T message)Parameters
| Type | Name | Description |
|---|---|---|
| T | message | The message. |
Returns
| Type | Description |
|---|---|
| Task | Asynchronous |
FailMessage(T, String)
Notifies the message queue that the message processing by the receiver failed.
Declaration
Task FailMessage(T message, string error)Parameters
| Type | Name | Description |
|---|---|---|
| T | message | The message. |
| System.String | error | The error. |
Returns
| Type | Description |
|---|---|
| Task | Asynchronous |
GetMessage()
Gets the message.
Declaration
Task<T> GetMessage()Returns
| Type | Description |
|---|---|
| Task<T> | A message, null if no message is on the queue. |
PeekMessages(Int32)
Peeks the messages in the queue.
Declaration
Task<IEnumerable<T>> PeekMessages(int messageCount)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | messageCount | The message count. |
Returns
| Type | Description |
|---|---|
| Task<IEnumerable<T>> | A sequence of job messages. |
SendMessage(T, Nullable<TimeSpan>)
Sends the message.
Declaration
Task SendMessage(T message, TimeSpan? lifeTime = null)Parameters
| Type | Name | Description |
|---|---|---|
| T | message | The message. |
| System.Nullable<TimeSpan> | lifeTime | Lifetime of the message. 7 days is default. |
Returns
| Type | Description |
|---|---|
| Task | Asynchronous |