Table of Contents

Class DispatchBuilderAwsSqsExtensions

Namespace
Microsoft.Extensions.DependencyInjection
Assembly
Excalibur.Dispatch.Transport.AwsSqs.dll

Extension methods for configuring AWS SQS transport via IDispatchBuilder.

public static class DispatchBuilderAwsSqsExtensions
Inheritance
DispatchBuilderAwsSqsExtensions
Inherited Members

Methods

UseAwsSqs(IDispatchBuilder, Action<IAwsSqsTransportBuilder>)

Configures the AWS SQS transport with the default name via the dispatch builder.

public static IDispatchBuilder UseAwsSqs(this IDispatchBuilder builder, Action<IAwsSqsTransportBuilder> configure)

Parameters

builder IDispatchBuilder

The dispatch builder.

configure Action<IAwsSqsTransportBuilder>

The transport configuration action.

Returns

IDispatchBuilder

The builder for fluent chaining.

Examples

services.AddDispatch(dispatch =>
{
    dispatch.UseAwsSqs(sqs =>
    {
        sqs.UseRegion("us-east-1")
           .ConfigureQueue(queue => queue.VisibilityTimeout(TimeSpan.FromMinutes(5)));
    });
});

Exceptions

ArgumentNullException

Thrown when builder or configure is null.

UseAwsSqs(IDispatchBuilder, string, Action<IAwsSqsTransportBuilder>)

Configures a named AWS SQS transport via the dispatch builder.

public static IDispatchBuilder UseAwsSqs(this IDispatchBuilder builder, string name, Action<IAwsSqsTransportBuilder> configure)

Parameters

builder IDispatchBuilder

The dispatch builder.

name string

The transport name for multi-transport scenarios.

configure Action<IAwsSqsTransportBuilder>

The transport configuration action.

Returns

IDispatchBuilder

The builder for fluent chaining.

Examples

services.AddDispatch(dispatch =>
{
    dispatch.UseAwsSqs("payments", sqs =>
    {
        sqs.UseRegion("us-west-2")
           .MapQueue<PaymentReceived>("https://sqs.us-west-2.amazonaws.com/123/payments");
    });
});

Exceptions

ArgumentNullException

Thrown when builder or configure is null.

ArgumentException

Thrown when name is null or whitespace.