Interface IOutboxReader

Exposes the methods to read from the outbox. Used by the IOutboxWorker.

Namespace: Silverback.Messaging.Outbound.TransactionalOutbox.Repositories

Assembly: Silverback.Integration.dll

Syntax

public interface IOutboxReader

Methods

AcknowledgeAsync(OutboxStoredMessage)

Called after the message has been successfully produced to remove it from the outbox.

Declaration

Task AcknowledgeAsync(OutboxStoredMessage outboxMessage)

Parameters

Type	Name	Description
OutboxStoredMessage	outboxMessage	The message that was processed.

Returns

Type	Description
Task	A Task representing the result of the asynchronous operation.

AcknowledgeAsync(IEnumerable<OutboxStoredMessage>)

Called after the message has been successfully produced to remove it from the outbox.

Declaration

Task AcknowledgeAsync(IEnumerable<OutboxStoredMessage> outboxMessages)

Parameters

Type	Name	Description
IEnumerable<OutboxStoredMessage>	outboxMessages	The messages that have been processed.

Returns

Type	Description
Task	A Task representing the result of the asynchronous operation.

GetLengthAsync()

Returns the total number of messages in the outbox.

Declaration

Task<int> GetLengthAsync()

Returns

Type	Description
Task<int>	A Task<TResult> representing the asynchronous operation. The task result contains the number of messages in the outbox.

GetMaxAgeAsync()

Gets a TimeSpan representing the time elapsed since the oldest message currently in the outbox was written.

Declaration

Task<TimeSpan> GetMaxAgeAsync()

Returns

Type	Description
Task<TimeSpan>	The age of the oldest message.

ReadAsync(int)

Reads the specified number of messages from the outbox (according to the FIFO rule). The operation must be acknowledged for the messages to be removed.

Declaration

Task<IReadOnlyCollection<OutboxStoredMessage>> ReadAsync(int count)

Parameters

Type	Name	Description
int	count	The number of items to be dequeued.

Returns

Type	Description
Task<IReadOnlyCollection<OutboxStoredMessage>>	A Task representing the result of the asynchronous operation. The task result contains the collection of OutboxStoredMessage.

RetryAsync(OutboxStoredMessage)

Called when an error occurs producing the message to re-enqueue it and retry later on.

Declaration

Task RetryAsync(OutboxStoredMessage outboxMessage)

Parameters

Type	Name	Description
OutboxStoredMessage	outboxMessage	The message that was processed.

Returns

Type	Description
Task	A Task representing the result of the asynchronous operation.

RetryAsync(IEnumerable<OutboxStoredMessage>)

Called when an error occurs producing the message to re-enqueue it and retry later on.

Declaration

Task RetryAsync(IEnumerable<OutboxStoredMessage> outboxMessages)

Parameters

Type	Name	Description
IEnumerable<OutboxStoredMessage>	outboxMessages	The messages that have been processed.

Returns

Type	Description
Task	A Task representing the result of the asynchronous operation.