Interface IMessageHandler<T>

Namespace: AWS.Messaging

Assembly: AWS.Messaging.dll

This interface is implemented by the users of this library for each type of message that should be processed.

The implementation of this interface is where the business logic for processing a particular message type is written. The message type is indicated by the generic type T for the interface. The library will call the handler whenever the message type is read from the message source.

public interface IMessageHandler<T>

Type Parameters

T

Methods

HandleAsync(MessageEnvelope<T>, CancellationToken)

This method is where the business logic for processing the message will start.

If the message was successfully processed and should them Success() should be returned. The underlying service like SQS will be told the message has been processed and can be removed.

If an exception is thrown from this method the status is treated as Failed().

Task<MessageProcessStatus> HandleAsync(MessageEnvelope<T> messageEnvelope, CancellationToken token = default)

Parameters

messageEnvelope MessageEnvelope<T>: The message read from the message source wrapped around a message envelope containing message metadata.
token CancellationToken: The optional cancellation token.

Returns