EventHubClient.PrefetchSizeInBytes 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 maximum size (in bytes) in total that any receive operation will actively cache. The size of each event data is determined by the SerializedSizeInBytes property.

public long? PrefetchSizeInBytes { get; set; }

member this.PrefetchSizeInBytes : Nullable<int64> with get, set

Public Property PrefetchSizeInBytes As Nullable(Of Long)

Property Value

Nullable<Int64>

Returns Int64.

Exceptions

ArgumentOutOfRangeException

Thrown when the size value is less than the minimum required value of 260K bytes.

Remarks

The size limit is not an absolute limit, and can go over by as much as (PrefetchSizeInBytes/256kBytes) number of event worth of bytes. Any EventHubConsumerGroup created from this instance will inherit this value by default. Changes to this value will not be propagated to already created consumer group, but will be used by new EventHubConsumerGroup created after the change. Also setting this value to non-null value will set PrefetchCount to zero. Note that setting the size too low will affect the effective performance of the Event Hub receive call.

Applies to