ServiceBusSessionReceiver.GetSessionStateAsync(CancellationToken) Method

Definition

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

The session state as BinaryData.

Exceptions

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

Applies to