ProcessSessionMessageEventArgs.GetSessionStateAsync(CancellationToken) Method

Reference

Definition

Namespace:: Azure.Messaging.ServiceBus

Assembly:: Azure.Messaging.ServiceBus.dll

Package:: Azure.Messaging.ServiceBus v7.17.5

Source:: ProcessSessionMessageEventArgs.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Gets the session state.

public virtual System.Threading.Tasks.Task<BinaryData> GetSessionStateAsync (System.Threading.CancellationToken cancellationToken = default);

abstract member GetSessionStateAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<BinaryData>
override this.GetSessionStateAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<BinaryData>

Public Overridable Function GetSessionStateAsync (Optional cancellationToken As CancellationToken = Nothing) As Task(Of BinaryData)

Parameters

cancellationToken: CancellationToken

An optional CancellationToken instance to signal the request to cancel the operation.

Returns

Task<BinaryData>

The session state as BinaryData.

Exceptions

ServiceBusException

The lock for the session has expired. The Reason will be set to SessionLockLost in this case.

Applies to