Share via


EventHubReceiver.PrefetchCount Property

Definition

Gets or sets the number of events that any receive operation will actively cache. By default, this value is inherited from EventHubConsumerGroup. The default value is 300.

public int PrefetchCount { get; set; }
member this.PrefetchCount : int with get, set
Public Property PrefetchCount As Integer

Property Value

The number of messages that the message receiver can simultaneously request.

Exceptions

Thrown if the value is less than the minimum required value of 10.

Remarks

Changes to this value will be used in next receive operation, however this does not affect the number of events already cached by the receiver. Setting this property to non-zero value will set PrefetchSizeInBytes to null. Note that setting the count too low will affect the effective performance of the event hub receive call.

Applies to