azure-messaging-eventhubs
Loading...
Searching...
No Matches
Public Member Functions | List of all members
Azure::Messaging::EventHubs::PartitionClient Class Referencefinal

#include <partition_client.hpp>

Public Member Functions

 PartitionClient (PartitionClient const &other)=delete
 Create a PartitionClient from another PartitionClient.
 
 PartitionClient (PartitionClient &&other)=default
 Create a PartitionClient moving from another PartitionClient.
 
PartitionClientoperator= (PartitionClient const &other)=delete
 Assign a PartitionClient to another PartitionClient.
 
PartitionClientoperator= (PartitionClient &&other)=default
 Move a PartitionClient to another PartitionClient.
 
virtual ~PartitionClient ()
 
std::vector< std::shared_ptr< const Models::ReceivedEventData > > ReceiveEvents (uint32_t maxMessages, Core::Context const &context={})
 
void Close (Core::Context const &context)
 Closes the connection to the Event Hub service.
 

Detailed Description

PartitionClient is used to receive events from an Event Hub partition.

This type is instantiated from the [ConsumerClient] type, using [ConsumerClient.CreatePartitionClient].

Constructor & Destructor Documentation

◆ ~PartitionClient()

Azure::Messaging::EventHubs::PartitionClient::~PartitionClient ( )
virtual

Destroy this partition client.

Member Function Documentation

◆ ReceiveEvents()

std::vector< std::shared_ptr< const Models::ReceivedEventData > > Azure::Messaging::EventHubs::PartitionClient::ReceiveEvents ( uint32_t  maxMessages,
Core::Context const &  context = {} 
)

Receive events from the partition.

Parameters
maxMessagesThe maximum number of messages to receive.
contextA context to control the request lifetime.
Returns
A vector of received events.

The documentation for this class was generated from the following files: