azure-messaging-eventhubs
Loading...
Searching...
No Matches
Public Attributes | List of all members
Azure::Messaging::EventHubs::PartitionClientOptions Struct Referencefinal

#include <partition_client.hpp>

Public Attributes

Models::StartPosition StartPosition
 StartPosition is the position we will start receiving events from, either an offset (inclusive) with Offset, or receiving events received after a specific time using EnqueuedTime.
 
Azure::Nullable< std::int64_t > OwnerLevel {}
 OwnerLevel is the priority for this partition client, also known as the 'epoch' level. When used, a partition client with a higher OwnerLevel will take ownership of a partition from partition clients with a lower OwnerLevel. Default is off.
 
int32_t Prefetch = 300
 Prefetch represents the size of the internal prefetch buffer. 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.
 

Detailed Description

brief PartitionClientOptions provides options for the ConsumerClient::CreatePartitionClient function.

Member Data Documentation

◆ Prefetch

int32_t Azure::Messaging::EventHubs::PartitionClientOptions::Prefetch = 300

Defaults to 300 events if Prefetch == 0. Disabled if Prefetch < 0.

◆ StartPosition

Models::StartPosition Azure::Messaging::EventHubs::PartitionClientOptions::StartPosition
Remarks
NOTE: you can also use the [Processor], which will automatically manage the start value using a [CheckpointStore]. See [example_consuming_with_checkpoints_test.go] for an example.

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