MessageHandlerOptions Class

  • Reference

Definition

Namespace:
Microsoft.Azure.ServiceBus
Assembly:
Microsoft.Azure.ServiceBus.dll
Package:
Microsoft.Azure.ServiceBus v5.2.0
Source:
MessageHandlerOptions.cs

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
type MessageHandlerOptions = class
Public NotInheritable Class MessageHandlerOptions
Inheritance
Object
MessageHandlerOptions

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

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.
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.
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.
MaxConcurrentCalls

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

Applies to