Class MessageHandlerOptions

Namespace

Microsoft.Azure.ServiceBus

Assembly

Microsoft.Azure.ServiceBus.dll

Provides options associated with message pump processing using RegisterMessageHandler(Func<Message, CancellationToken, Task>, MessageHandlerOptions) and RegisterMessageHandler(Func<Message, CancellationToken, Task>, MessageHandlerOptions).

public sealed class MessageHandlerOptions

Inheritance

object

MessageHandlerOptions

Inherited Members

object.GetType()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

MessageHandlerOptions(Func<ExceptionReceivedEventArgs, Task>)

Initializes a new instance of the MessageHandlerOptions class. Default Values: MaxConcurrentCalls = 1 AutoComplete = true Microsoft.Azure.ServiceBus.MessageHandlerOptions.ReceiveTimeOut = 1 minute MaxAutoRenewDuration = 5 minutes

public MessageHandlerOptions(Func<ExceptionReceivedEventArgs, Task> exceptionReceivedHandler)

Parameters

exceptionReceivedHandler Func<ExceptionReceivedEventArgs, Task>

A Func<T, TResult> that is invoked during exceptions. ExceptionReceivedEventArgs contains contextual information regarding the exception.

Properties

AutoComplete

Gets or sets a value that indicates whether the message-pump should call CompleteAsync(string) or CompleteAsync(string) on messages after the callback has completed processing.

public bool AutoComplete { get; set; }

Property Value

bool

true to complete the message processing automatically on successful execution of the operation; otherwise, false.

ExceptionReceivedHandler

Occurs when an exception is received. Enables you to be notified of any errors encountered by the message pump. When errors are received calls will automatically be retried, so this is informational.

public Func<ExceptionReceivedEventArgs, Task> ExceptionReceivedHandler { get; }

Property Value

Func<ExceptionReceivedEventArgs, Task>

MaxAutoRenewDuration

Gets or sets the maximum duration within which the lock will be renewed automatically. This value should be greater than the longest message lock duration; for example, the LockDuration Property.

public TimeSpan MaxAutoRenewDuration { get; set; }

Property Value

TimeSpan

The maximum duration during which locks are automatically renewed.

MaxConcurrentCalls

Gets or sets the maximum number of concurrent calls to the callback the message pump should initiate.

public int MaxConcurrentCalls { get; set; }

Property Value

int

The maximum number of concurrent calls to the callback.