Class AmazonMessageReceiveOptions

Namespace

Savvyio.Extensions.SimpleQueueService

Assembly

Savvyio.Extensions.SimpleQueueService.dll

Configuration options that is related to receive operations on AWS SQS.

public class AmazonMessageReceiveOptions

Inheritance

object

AmazonMessageReceiveOptions

Constructors

AmazonMessageReceiveOptions()

Initializes a new instance of the AmazonMessageReceiveOptions class.

public AmazonMessageReceiveOptions()

Remarks

The following table shows the initial property values for an instance of AmazonMessageReceiveOptions.

Property	Initial Value
NumberOfMessagesToTakePerRequest	10
PollingTimeout	20 seconds
AssumeMessageProcessed	true
RemoveProcessedMessages	true
UseApproximateNumberOfMessages	false

Properties

AssumeMessageProcessed

Gets or sets a value indicating whether each message should be automatically assumed processed. Default is true.

public bool AssumeMessageProcessed { get; set; }

Property Value

bool

true if each message should be assumed automatically processed; otherwise, false.

NumberOfMessagesToTakePerRequest

Gets or sets the number of messages to return per request. Default is 10.

public int NumberOfMessagesToTakePerRequest { get; set; }

Property Value

int

The number of messages to return per request.

Remarks

Max. allowed value is limited to MaxNumberOfMessages.

PollingTimeout

Gets or sets the polling timeout per request. Default is 20 seconds.

public TimeSpan PollingTimeout { get; set; }

Property Value

TimeSpan

The polling timeout per request.

Remarks

Max. allowed value is limited to MaxPollingWaitTimeInSeconds.

RemoveProcessedMessages

Gets or sets a value indicating whether processed messages should be removed after processing. Default is true.

public bool RemoveProcessedMessages { get; set; }

Property Value

bool

true if processed messages should be removed after processing; otherwise, false.

UseApproximateNumberOfMessages

Gets or sets a value indicating whether to retrieve the approximate number of messages for the queue in question. Default is false.

public bool UseApproximateNumberOfMessages { get; set; }

Property Value

bool

true to retrieve the approximate number of messages for the queue in question; otherwise, false.

VisibilityTimeout

Gets or sets the visibility timeout per request. Default is 30 seconds.

public TimeSpan VisibilityTimeout { get; set; }

Property Value

TimeSpan

The visibility timeout per request.

Remarks

Max. allowed value is limited to MaxVisibilityTimeoutInSeconds.