EventProcessorClientOptions.MaximumWaitTime Property

Reference

Definition

Namespace:: Azure.Messaging.EventHubs

Assembly:: Azure.Messaging.EventHubs.Processor.dll

Package:: Azure.Messaging.EventHubs.Processor v5.11.5

Package:: Azure.Messaging.EventHubs.Processor v5.12.0-beta.1

Source:: EventProcessorClientOptions.cs

Source:: EventProcessorClientOptions.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

The maximum amount of time to wait for an event to become available for a given partition before emitting an empty event.

public TimeSpan? MaximumWaitTime { get; set; }

member this.MaximumWaitTime : Nullable<TimeSpan> with get, set

Public Property MaximumWaitTime As Nullable(Of TimeSpan)

Property Value

Nullable<TimeSpan>

If null, the processor will wait indefinitely for an event to become available; otherwise, a value will always be emitted within this interval, whether an event was available or not.

Exceptions

ArgumentOutOfRangeException

Occurs when the requested wait time is negative.

Remarks

When set, if no events are received before the timeout, ProcessEventAsync is called with a ProcessEventArgs instance that does not contain any event data. The HasEvent property is intended to help detect this.

Applies to

Share via