ReadEventOptions Class

Definition

The set of options that can be specified to configure behavior when reading events from an EventHubConsumerClient.

public class ReadEventOptions
type ReadEventOptions = class
Public Class ReadEventOptions
Inheritance
System.Object
ReadEventOptions

Constructors

ReadEventOptions()

Properties

CacheEventCount

The maximum number of events that will be read from the Event Hubs service and held in a local memory cache when reading is active and events are being emitted to an enumerator for processing.

MaximumWaitTime

The maximum amount of time to wait to for an event to be available when reading before reading an empty event.

OwnerLevel

When populated, the owner level indicates that a reading is intended to be performed exclusively for events in the requested partition and for the associated consumer group. To do so, reading will attempt to assert ownership over the partition; in the case where more than one exclusive reader in the consumer group attempts to assert ownership for the same partition, the one having a larger OwnerLevel value will "win".

When an exclusive reader is used, other readers which are non-exclusive or which have a lower owner level will either not be allowed to be created, if they already exist, will encounter an exception during the next attempted operation.

PrefetchCount

The number of events that will be eagerly requested from the Event Hubs service and queued locally without regard to whether a read operation is currently active, intended to help maximize throughput by allowing events to be read from from a local cache rather than waiting on a service request.

PrefetchSizeInBytes

The desired number of bytes to attempt to eagerly request from the Event Hubs service and queued locally without regard to whether a read operation is currently active, intended to help maximize throughput by allowing events to be read from from a local cache rather than waiting on a service request.

TrackLastEnqueuedEventProperties

Indicates whether or not the reader should request information on the last enqueued event on the partition associated with a given event, and track that information as events are read.

Applies to