EventHubBufferedProducerClientOptions.MaximumWaitTime Property

Definition

Namespace:

Azure.Messaging.EventHubs.Producer

Assembly:

Azure.Messaging.EventHubs.dll

Package:

Azure.Messaging.EventHubs v5.11.5

Source:

EventHubBufferedProducerClientOptions.cs

The amount of time to wait for a batch to be built with events in the buffer before publishing a partially full batch.

public TimeSpan? MaximumWaitTime { get; set; }

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

Public Property MaximumWaitTime As Nullable(Of TimeSpan)

Property Value

Nullable<TimeSpan>

The default wait time is 1 second. For most scenarios, it is recommended to allow for at least 1 second in order to ensure consistent performance.

If null, batches will only be published when full unless FlushAsync(CancellationToken) is called.

Exceptions

ArgumentOutOfRangeException

Occurs when the requested wait time is negative.