ProcessSessionEventArgs Class

Definition

Namespace:

Azure.Messaging.ServiceBus

Assembly:

Azure.Messaging.ServiceBus.dll

Package:

Azure.Messaging.ServiceBus v7.17.5

Source:

ProcessSessionEventArgs.cs

The ProcessSessionEventArgs contain event args related to the session being processed.

public class ProcessSessionEventArgs : EventArgs

type ProcessSessionEventArgs = class
    inherit EventArgs

Public Class ProcessSessionEventArgs
Inherits EventArgs

Inheritance

EventArgs

ProcessSessionEventArgs

Constructors

ProcessSessionEventArgs(ServiceBusSessionReceiver, String, CancellationToken)

Initializes a new instance of the ProcessSessionEventArgs class.

Properties

CancellationToken	A CancellationToken instance which will be cancelled when StopProcessingAsync(CancellationToken) is called, or when the session lock has been lost.
EntityPath	The path of the Service Bus entity that the message was received from.
FullyQualifiedNamespace	The fully qualified Service Bus namespace that the message was received from.
Identifier	The identifier of the ServiceBusSessionProcessor.
SessionId	The Session Id associated with the session being processed.
SessionLockedUntil	Gets the DateTimeOffset that the current session is locked until.

Methods

GetSessionStateAsync(CancellationToken)	Gets the session state.
ReleaseSession()	Releases the session that is being processed. No receives will be initiated for the session and the session will be closed. The session may end up being reopened for processing immediately after closing if there are messages remaining in the session ( This depends on what other session messages may be in the queue or subscription).
RenewSessionLockAsync(CancellationToken)	Renews the lock on the session specified by the SessionId. The lock will be renewed based on the setting specified on the entity.
SetSessionStateAsync(BinaryData, CancellationToken)	Set a custom state on the session which can be later retrieved using GetSessionStateAsync(CancellationToken)