EventHubConsumerGroup.PrefetchCount Property

Reference

Definition

Namespace:: Microsoft.ServiceBus.Messaging

Assembly:: Microsoft.ServiceBus.dll

Package:: WindowsAzure.ServiceBus v6.2.2

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.

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

public int PrefetchCount { get; set; }

member this.PrefetchCount : int with get, set

Public Property PrefetchCount As Integer

Property Value

Int32

The number of events that the receiver can cache.

Exceptions

ArgumentOutOfRangeException

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

Remarks

Any EventHubReceiver created from this instance will inherit this value by default. Changes to this value will not be propagate to already created receiver, but will be used by new EventHubReceiver created after the change. Also setting this property to non-zero 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

Share via