EventProcessor<TPartition>.StartProcessing(CancellationToken) Method

Definition

Namespace:

Azure.Messaging.EventHubs.Primitives

Assembly:

Azure.Messaging.EventHubs.dll

Package:

Azure.Messaging.EventHubs v5.11.2

Source:

EventProcessor.cs

Signals the EventProcessor<TPartition> to begin processing events. Should this method be called while the processor is running, no action is taken.

public virtual void StartProcessing (System.Threading.CancellationToken cancellationToken = default);

abstract member StartProcessing : System.Threading.CancellationToken -> unit
override this.StartProcessing : System.Threading.CancellationToken -> unit

Public Overridable Sub StartProcessing (Optional cancellationToken As CancellationToken = Nothing)

Parameters

cancellationToken

CancellationToken

A CancellationToken instance to signal the request to cancel the start operation. This won't affect the EventProcessor<TPartition> once it starts running.

Exceptions

AggregateException

As the processor starts, it will attempt to detect configuration and permissions errors that would prevent it from being able to recover without intervention. For example, an incorrect connection string or the inability to query the Event Hub would be detected. These exceptions will be packaged as an AggregateException, and will cause StartProcessing(CancellationToken) to fail.