EventProcessor<TPartition>.UpdateCheckpointAsync Method

Definition

Namespace:

Azure.Messaging.EventHubs.Primitives

Assembly:

Azure.Messaging.EventHubs.dll

Package:

Azure.Messaging.EventHubs v5.11.5

Overloads

UpdateCheckpointAsync(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.
UpdateCheckpointAsync(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, CheckpointPosition, CancellationToken)

Source:

EventProcessor.cs

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.

protected virtual System.Threading.Tasks.Task UpdateCheckpointAsync (string partitionId, Azure.Messaging.EventHubs.Processor.CheckpointPosition startingPosition, System.Threading.CancellationToken cancellationToken);

abstract member UpdateCheckpointAsync : string * Azure.Messaging.EventHubs.Processor.CheckpointPosition * System.Threading.CancellationToken -> System.Threading.Tasks.Task
override this.UpdateCheckpointAsync : string * Azure.Messaging.EventHubs.Processor.CheckpointPosition * System.Threading.CancellationToken -> System.Threading.Tasks.Task

Protected Overridable Function UpdateCheckpointAsync (partitionId As String, startingPosition As CheckpointPosition, cancellationToken As CancellationToken) As Task

Parameters

partitionId

String

The identifier of the partition the checkpoint is for.

startingPosition

CheckpointPosition

The starting position to associate with the checkpoint, indicating that a processor should begin reading from the next event in the stream.

cancellationToken

CancellationToken

A CancellationToken instance to signal a request to cancel the operation.

Returns

Task

UpdateCheckpointAsync(String, Int64, Nullable<Int64>, CancellationToken)

Source:

EventProcessor.cs

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.

protected virtual System.Threading.Tasks.Task UpdateCheckpointAsync (string partitionId, long offset, long? sequenceNumber, System.Threading.CancellationToken cancellationToken);

abstract member UpdateCheckpointAsync : string * int64 * Nullable<int64> * System.Threading.CancellationToken -> System.Threading.Tasks.Task
override this.UpdateCheckpointAsync : string * int64 * Nullable<int64> * System.Threading.CancellationToken -> System.Threading.Tasks.Task

Protected Overridable Function UpdateCheckpointAsync (partitionId As String, offset As Long, sequenceNumber As Nullable(Of Long), cancellationToken As CancellationToken) As Task

Parameters

partitionId

String

The identifier of the partition the checkpoint is for.

offset

Int64

The offset to associate with the checkpoint, intended as informational metadata. This will only be used for positioning if there is no value provided for sequenceNumber.

sequenceNumber

Nullable<Int64>

The sequence number to associate with the checkpoint, indicating that a processor should begin reading from the next event in the stream.

cancellationToken

CancellationToken

A CancellationToken instance to signal a request to cancel the operation.

Returns

Task

Remarks

This overload exists to preserve backwards compatibility; it is highly recommended that UpdateCheckpointAsync(String, CheckpointPosition, CancellationToken) be called instead.