SessionHandlerOptions Class

Definition

Namespace:

Microsoft.ServiceBus.Messaging

Assembly:

Microsoft.ServiceBus.dll

Package:

WindowsAzure.ServiceBus v6.2.2

Represents the options for the session handler.

public class SessionHandlerOptions

type SessionHandlerOptions = class

Public Class SessionHandlerOptions

Inheritance

Object

SessionHandlerOptions

Constructors

SessionHandlerOptions()

Initializes a new instance of the SessionHandlerOptions class.

Properties

AutoComplete	Gets or sets whether the autocomplete option of the session handler is enabled. If this value is true, if the handler returns without any failure, then the message is completed and will not show up in the session; if any exception is thrown from the handler, the message is abandoned and the DeliveryCount of this message will increase by one. If this value is false, if the handler returns without any failure, then user has to write the logic to explicitly complete the message, otherwise the message is not considered 'completed' and will reappear in the session.
AutoRenewTimeout	Gets or sets the time needed before the session renew its state. If a session lock is going to expire, this value is the duration for the session lock to be automatically renewed.
MaxConcurrentSessions	Gets or sets the maximum number of existing sessions.Setting this value to be greater than the max number of active sessions in the service will not increase message throughput.
MessageWaitTimeout	Gets or sets the time needed before the message waiting expires.This is the time the session-pump waits before closing down the current session and switching to a different session.

Events

ExceptionReceived

Occurs when an exception was received during session handling.