EventProcessorClient.StartProcessing(CancellationToken) Method

Definition

Namespace:

Azure.Messaging.EventHubs

Assembly:

Azure.Messaging.EventHubs.Processor.dll

Package:

Azure.Messaging.EventHubs.Processor v5.11.2

Source:

EventProcessorClient.cs

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

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

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

Public Overrides 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 EventProcessorClient once it starts running.

Exceptions

EventHubsException

Occurs when this EventProcessorClient instance is already closed.

InvalidOperationException

Occurs when either the ProcessEventAsync handler or ProcessErrorAsync handler has not been registered.

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 write to the storage container would be detected. These exceptions will be packaged as an AggregateException, and will cause StartProcessing(CancellationToken) to fail.