Azure::Messaging::EventHubs::ProcessorOptions Struct Reference

ProcessorOptions are the options for the CreateProcessor function.

#include <processor.hpp>

Public Attributes
Models::ProcessorStrategy	LoadBalancingStrategy
	LoadBalancingStrategy dictates how concurrent Processor instances distribute ownership of partitions between them. The default strategy is ProcessorStrategyBalanced.
Azure::DateTime::duration	UpdateInterval {std::chrono::seconds(10)}
	UpdateInterval controls how often attempt to claim partitions. The default value is 10 seconds.
Azure::DateTime::duration	PartitionExpirationDuration {std::chrono::seconds(60)}
	PartitionExpirationDuration is the amount of time before a partition is considered unowned. The default value is 60 seconds.
Models::StartPositions	StartPositions
	StartPositions are the default start positions (configurable per partition, or with an overall default value) if a checkpoint is not found in the CheckpointStore. The default position is Latest.
int32_t	Prefetch {300}
	Prefetch represents the size of the internal prefetch buffer for each ProcessorPartitionClient created by this Processor. When set, this client will attempt to always maintain an internal cache of events of this size, asynchronously, increasing the odds that ReceiveEvents() will use a locally stored cache of events, rather than having to wait for events to arrive from the network.
int32_t	MaximumNumberOfPartitions {0}
	Specifies the maximum number of partitions to process.

Member Data Documentation

LoadBalancingStrategy

Models::ProcessorStrategy Azure::Messaging::EventHubs::ProcessorOptions::LoadBalancingStrategy

Initial value:

{
        Models::ProcessorStrategy::ProcessorStrategyBalanced}

MaximumNumberOfPartitions

int32_t Azure::Messaging::EventHubs::ProcessorOptions::MaximumNumberOfPartitions {0}

By default, the processor will process all available partitions. If a client desires limiting the number of partitions to a restricted set, set the MaximumNumberOfPartitions to the number of partitions to process.

Prefetch

int32_t Azure::Messaging::EventHubs::ProcessorOptions::Prefetch {300}

Defaults to 300 events. Disabled if Prefetch < 0.

---

The documentation for this struct was generated from the following file:

• inc/azure/messaging/eventhubs/processor.hpp