ProcessEventArgs.CancellationToken Property

Definition

Namespace:

Azure.Messaging.EventHubs.Processor

Assembly:

Azure.Messaging.EventHubs.dll

Package:

Azure.Messaging.EventHubs v5.11.3

Source:

ProcessEventArgs.cs

A CancellationToken to indicate that the processor is requesting that the handler stop its activities. If this token is requesting cancellation, then either the processor is attempting to shutdown or ownership of the partition has changed.

public System.Threading.CancellationToken CancellationToken { get; }

member this.CancellationToken : System.Threading.CancellationToken

Public ReadOnly Property CancellationToken As CancellationToken

Property Value

CancellationToken

Remarks

The handler processing events has responsibility for deciding whether or not to honor the cancellation request. If the application chooses not to do so, the processor will wait for the handler to complete before taking further action.