ProcessEventArgs Struct

Definition

Namespace:

Azure.Messaging.EventHubs.Processor

Assembly:

Azure.Messaging.EventHubs.dll

Package:

Azure.Messaging.EventHubs v5.11.5

Source:

ProcessEventArgs.cs

Contains information about a partition that has attempted to receive an event from the Azure Event Hub service in an EventProcessorClient context, as well as the received event, if any. It allows creating a checkpoint based on the associated event.

public struct ProcessEventArgs

type ProcessEventArgs = struct

Public Structure ProcessEventArgs

Inheritance

ValueType

ProcessEventArgs

Constructors

ProcessEventArgs(PartitionContext, EventData, Func<CancellationToken,Task>, CancellationToken)

Initializes a new instance of the ProcessEventArgs structure.

Properties

CancellationToken	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.
Data	The received event to be processed. Expected to be null if the receive call has timed out.
HasEvent	Indicates whether or not the arguments contain an event to be processed. In the case where no event is contained, then the creation of checkpoints and reading the last enqueued event properties are unavailable.
Partition	The context of the Event Hub partition this instance is associated with.

Methods

UpdateCheckpointAsync(CancellationToken)

Updates the checkpoint for the PartitionContext and EventData associated with this event.