Table of Contents

Class OnMessageOptions

Namespace
Microsoft.ServiceBus.Messaging
Assembly
Microsoft.ServiceBus.dll

Provides options associated with message pump processing using OnMessage(Action<BrokeredMessage>) and OnMessage(Action<BrokeredMessage>).

public sealed class OnMessageOptions
Inheritance
OnMessageOptions
Inherited Members

Constructors

OnMessageOptions()

Initializes a new instance of the OnMessageOptions class.

public OnMessageOptions()

Properties

AutoComplete

Gets or sets a value that indicates whether the message-pump should call Complete(Guid) or Complete(Guid) 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.

AutoRenewTimeout

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 AutoRenewTimeout { get; set; }

Property Value

TimeSpan

The maximum duration during which locks are automatically renewed. The default value is 5 minutes, and if you set this value to Zero the lock will not be 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.

Events

ExceptionReceived

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 event EventHandler<ExceptionReceivedEventArgs> ExceptionReceived

Event Type

EventHandler<ExceptionReceivedEventArgs>