CheckpointStore Class

Definition

Namespace:

Azure.Messaging.EventHubs.Primitives

Assembly:

Azure.Messaging.EventHubs.dll

Package:

Azure.Messaging.EventHubs v5.11.5

Source:

CheckpointStore.cs

Allows interaction with checkpoint and ownership data needed for event processor operation.

public abstract class CheckpointStore

type CheckpointStore = class

Public MustInherit Class CheckpointStore

Inheritance

Object

CheckpointStore

Derived

Azure.Messaging.EventHubs.Primitives.BlobCheckpointStore

Constructors

CheckpointStore()

Methods

ClaimOwnershipAsync(IEnumerable<EventProcessorPartitionOwnership>, CancellationToken)	Attempts to claim ownership of the specified partitions for processing. This operation is used by load balancing to enable distributing the responsibility for processing partitions for an Event Hub and consumer group pairing amongst the active event processors.
GetCheckpointAsync(String, String, String, String, CancellationToken)	Requests checkpoint information for a specific partition, allowing an event processor to resume reading from the next event in the stream.
ListOwnershipAsync(String, String, String, CancellationToken)	Requests a list of the ownership assignments for partitions between each of the cooperating event processor instances for a given Event Hub and consumer group pairing. This operation is used during load balancing to allow the processor to discover other active collaborators and to make decisions about how to best balance work between them.
UpdateCheckpointAsync(String, String, String, String, Int64, Nullable<Int64>, CancellationToken)	Creates or updates a checkpoint for a specific partition, identifying a position in the partition's event stream that an event processor should begin reading from.
UpdateCheckpointAsync(String, String, String, String, String, CheckpointPosition, CancellationToken)	Creates or updates a checkpoint for a specific partition, identifying a position in the partition's event stream that an event processor should begin reading from.