ReadEventOptions.MaximumWaitTime Property

Definition

Namespace:

Azure.Messaging.EventHubs.Consumer

Assembly:

Azure.Messaging.EventHubs.dll

Package:

Azure.Messaging.EventHubs v5.11.2

Source:

ReadEventOptions.cs

The maximum amount of time to wait to for an event to be available when reading before reading 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 specified, should there be no events available before this waiting period expires, an empty event will be returned, allowing control to return to the reader that was waiting.

If null, the reader will wait forever for items to be available unless reading is canceled. Empty items will not be returned.

Exceptions

ArgumentOutOfRangeException

Occurs when the requested wait time is negative.