Azure · LarryOsterman · Jul 13, 2023 · Mar 31, 2023 · Apr 3, 2023 · Apr 3, 2023
@@ -4,6 +4,8 @@
 
 ### Features Added
 
+Initial Release.
+
 ### Breaking Changes
 
 ### Bugs Fixed

@@ -10,8 +10,7 @@
   ],
   "additionalCompilerSwitches": [
   ],
-  "allowInternal": true,
-  "includeInternal": false,
+  "allowInternal": false,
   "includeDetail": false,
   "includePrivate": false,
   "filterNamespace": "Azure::Messaging",

@@ -22,5 +22,4 @@
 #include "azure/messaging/eventhubs/processor.hpp"
 #include "azure/messaging/eventhubs/processor_load_balancer.hpp"
 #include "azure/messaging/eventhubs/producer_client.hpp"
-#include "azure/messaging/eventhubs/retry_operation.hpp"
 #include "azure/messaging/eventhubs/rtti.hpp"
@@ -13,37 +13,8 @@
 #include <vector>
 
 namespace Azure { namespace Messaging { namespace EventHubs {
-  /**@brief  ListCheckpointsOptions contains optional parameters for the ListCheckpoints
-   * function
-   */
-  struct ListCheckpointsOptions
-  {
-    // For future expansion
-  };
-
-  /**@brief  ListOwnershipOptions contains optional parameters for the ListOwnership function
-   */
-  struct ListOwnershipOptions
-  {
-    // For future expansion
-  };
-
-  /**@brief  UpdateCheckpointOptions contains optional parameters for the UpdateCheckpoint
-   * function
-   */
-  struct UpdateCheckpointOptions
-  {
-    // For future expansion
-  };
-
-  /**@brief  ClaimOwnershipOptions contains optional parameters for the ClaimOwnership function
-   */
-  struct ClaimOwnershipOptions
-  {
-    // For future expansion
-  };
 
-  /**@brief  CheckpointStore is used by multiple consumers to coordinate progress and ownership for
+    /**@brief  CheckpointStore is used by multiple consumers to coordinate progress and ownership for
    * partitions.
    */
   class CheckpointStore {
@@ -62,12 +33,10 @@ namespace Azure { namespace Messaging { namespace EventHubs {
      */
     virtual std::vector<Models::Ownership> ClaimOwnership(
         std::vector<Models::Ownership> partitionOwnership,
-        ClaimOwnershipOptions const& options = {},
-        Azure::Core::Context ctx = {})
+        Core::Context const& context = {})
     {
       (void)partitionOwnership;
-      (void)ctx;
-      (void)options;
+      (void)context;
       throw std::runtime_error("Not Implemented");
     }
 
@@ -77,14 +46,12 @@ namespace Azure { namespace Messaging { namespace EventHubs {
         std::string const& fullyQualifiedNamespace,
         std::string const& eventHubName,
         std::string const& consumerGroup,
-        ListCheckpointsOptions options = {},
-        Azure::Core::Context ctx = {})
+        Core::Context const& context = {})
     {
       (void)fullyQualifiedNamespace;
       (void)consumerGroup;
       (void)eventHubName;
-      (void)ctx;
-      (void)options;
+      (void)context;
       throw std::runtime_error("Not Implemented");
     }
 
@@ -94,27 +61,23 @@ namespace Azure { namespace Messaging { namespace EventHubs {
         std::string const& fullyQualifiedNamespace,
         std::string const& eventHubName,
         std::string const& consumerGroup,
-        ListOwnershipOptions options = {},
-        Azure::Core::Context ctx = {})
+        Core::Context const& context = {})
     {
       (void)fullyQualifiedNamespace;
       (void)eventHubName;
       (void)consumerGroup;
-      (void)ctx;
-      (void)options;
+      (void)context;
       throw std::runtime_error("Not Implemented");
     }
 
     /**@brief  UpdateCheckpoint updates a specific checkpoint with a sequence and offset.
      */
     virtual void UpdateCheckpoint(
         Models::Checkpoint const& checkpoint,
-        UpdateCheckpointOptions options = {},
-        Azure::Core::Context ctx = {})
+        Core::Context const& context = {})
     {
       (void)checkpoint;
-      (void)ctx;
-      (void)options;
+      (void)context;
       throw std::runtime_error("Not Implemented");
     }
 
@@ -124,7 +87,7 @@ namespace Azure { namespace Messaging { namespace EventHubs {
   /** @brief BlobCheckpointStore is an implementation of a CheckpointStore backed by Azure Blob
    * Storage.
    */
-  class BlobCheckpointStore : public CheckpointStore {
+  class BlobCheckpointStore final : public CheckpointStore {
 
     std::string m_connectionString;
     std::string m_containerName;
@@ -144,7 +107,7 @@ namespace Azure { namespace Messaging { namespace EventHubs {
         std::string const& blobName,
         Azure::Storage::Metadata const& metadata,
         Azure::ETag const& etag,
-        Azure::Core::Context const& context = Azure::Core::Context());
+        Core::Context const& context = {});
 
   public:
     /** @brief  Construct a BlobCheckpointStore from another BlobCheckpointStore.
@@ -171,30 +134,26 @@ namespace Azure { namespace Messaging { namespace EventHubs {
 
     std::vector<Models::Ownership> ClaimOwnership(
         std::vector<Models::Ownership> partitionOwnership,
-        ClaimOwnershipOptions const& options = {},
-        Azure::Core::Context ctx = {}) override;
+        Core::Context const& context = {}) override;
 
     std::vector<Models::Checkpoint> ListCheckpoints(
         std::string const& fullyQualifiedNamespace,
         std::string const& eventHubName,
         std::string const& consumerGroup,
-        ListCheckpointsOptions options = {},
-        Azure::Core::Context ctx = {}) override;
+        Core::Context const& context = {}) override;
 
     /**@brief  ListOwnership lists all ownerships.
      */
     std::vector<Models::Ownership> ListOwnership(
         std::string const& fullyQualifiedNamespace,
         std::string const& eventHubName,
         std::string const& consumerGroup,
-        ListOwnershipOptions options = {},
-        Azure::Core::Context ctx = {}) override;
+        Core::Context const& context = {}) override;
 
     /**@brief  UpdateCheckpoint updates a specific checkpoint with a sequence and offset.
      */
     void UpdateCheckpoint(
         Models::Checkpoint const& checkpoint,
-        UpdateCheckpointOptions options = {},
-        Azure::Core::Context ctx = {}) override;
+        Core::Context const& context = {}) override;
   };
 }}} // namespace Azure::Messaging::EventHubs
@@ -18,7 +18,7 @@
 namespace Azure { namespace Messaging { namespace EventHubs {
   /**@brief Contains options for the ConsumerClient creation
    */
-  struct ConsumerClientOptions
+  struct ConsumerClientOptions final
   {
     /**@brief ApplicationID is used as the identifier when setting the User-Agent property.
      */
@@ -34,65 +34,39 @@ namespace Azure { namespace Messaging { namespace EventHubs {
     Azure::Core::Amqp::_internal::MessageReceiverOptions ReceiverOptions{};
   };
 
-  /**@brief Contains credentials for the ConsumerClient creation
+  /**
+   * @brief The ConsumerClient class is a high level class used to consume events from an Event Hub.
+   *
+   * @details The ConsumerClient class uses a #Azure::Messaging::EventHubs::PartitionClient to
+   * receive events from a specific partition of an Event Hub. The
+   * #Azure::Messaging::EventHubs::PartitionClient is created by the #ConsumerClient and is
+   * available via the NewPartitionClient method. The ConsumerClient is also responsible for
+   * managing the connection to the Event Hub and will reconnect as necessary.
    */
-  struct ConsumerClientCreds
-  {
+  class ConsumerClient final {
     /// The connection string for the Event Hubs namespace
-    std::string ConnectionString;
+    std::string m_connectionString;
 
     /// the Event Hubs namespace name (ex: myeventhub.servicebus.windows.net)
-    std::string HostName;
+    std::string m_hostName;
 
     /// The name of the Event Hub
-    std::string EventHub;
+    std::string m_eventHub;
 
     /// The name of the consumer group
-    std::string ConsumerGroup;
+    std::string m_consumerGroup;
 
     /// Credentials to be used to authenticate the client.
-    std::shared_ptr<Core::Credentials::TokenCredential> Credential{};
+    std::shared_ptr<Core::Credentials::TokenCredential> m_credential{};
 
     /// The URL to the Event Hubs namespace
-    std::string HostUrl{};
-  };
-
-  /**@brief GetEventHubPropertiesOptions contains optional parameters for the GetEventHubProperties
-   * function
-   */
-  struct GetEventHubPropertiesOptions
-  {
-    // For future expansion
-  };
-
-  /**@brief GetPartitionPropertiesOptions contains optional parameters for the
-   * GetPartitionProperties function
-   */
-  struct GetPartitionPropertiesOptions
-  {
-    // For future expansion
-  };
+    std::string m_hostUrl{};
 
-  /**
-   * @brief The ConsumerClient class is a high level class used to consume events from an Event Hub.
-   *
-   * @details The ConsumerClient class uses a #Azure::Messaging::EventHubs::PartitionClient to
-   * receive events from a specific partition of an Event Hub. The
-   * #Azure::Messaging::EventHubs::PartitionClient is created by the #ConsumerClient and is
-   * available via the NewPartitionClient method. The ConsumerClient is also responsible for
-   * managing the connection to the Event Hub and will reconnect as necessary.
-   */
-  class ConsumerClient {
-
-  protected:
     /// @brief The message receivers used to receive messages for a given partition.
     std::map<std::string, Azure::Core::Amqp::_internal::MessageReceiver> m_receivers{};
     /// @brief The AMQP Sessions used to receive messages for a given partition.
     std::map<std::string, Azure::Core::Amqp::_internal::Session> m_sessions{};
 
-    /// @brief the credentials used to connect to the event hub.
-    ConsumerClientCreds m_credentials;
-
     /// @brief The options used to configure the consumer client.
     ConsumerClientOptions m_consumerClientOptions;
 
@@ -107,31 +81,31 @@ namespace Azure { namespace Messaging { namespace EventHubs {
      *
      * @returns Event hub name for client
      */
-    std::string const& GetEventHubName() { return m_credentials.EventHub; }
+    std::string const& GetEventHubName() const { return m_eventHub; }
 
     /** @brief Getter for consumer group name
      *
      * @returns Consumer group name for client
      */
-    std::string const& GetConsumerGroup() { return m_credentials.ConsumerGroup; }
+    std::string const& GetConsumerGroup() const { return m_consumerGroup; }
 
     /** @brief Getter FQDN
      *
      * @returns FQDN client
      */
-    std::string const& GetHostName() { return m_credentials.HostName; }
+    std::string const& GetHostName() const { return m_hostName; }
 
     /** @brief Getter for client id
      *
      * @returns Clientid for client
      */
-    std::string const& GetClientId() { return m_consumerClientOptions.ApplicationID; }
+    std::string const& GetClientId() const { return m_consumerClientOptions.ApplicationID; }
 
     /** @brief Getter for client details
      *
      * @returns Client details for client
      */
-    Models::ConsumerClientDetails GetDetails()
+    Models::ConsumerClientDetails GetDetails() const
     {
       Models::ConsumerClientDetails details;
       details.ClientID = GetClientId();
@@ -170,6 +144,7 @@ namespace Azure { namespace Messaging { namespace EventHubs {
         std::string const& eventHub = {},
         std::string const& consumerGroup = _detail::DefaultConsumerGroup,
         ConsumerClientOptions const& options = {});
+
     /** @brief creates a ConsumerClient from a token credential.
      *
      * @param fullyQualifiedNamespace fully qualified namespace name (e.g.
@@ -201,7 +176,7 @@ namespace Azure { namespace Messaging { namespace EventHubs {
      *
      * @param options Additional options for getting partition properties
      */
-    Models::EventHubProperties GetEventHubProperties(GetEventHubPropertiesOptions options = {});
+    Models::EventHubProperties GetEventHubProperties(Core::Context const& context = {});
 
     /**@brief  GetPartitionProperties gets properties for a specific partition. This includes data
      * like the last enqueued sequence number, the first sequence number and when an event was last
@@ -212,6 +187,6 @@ namespace Azure { namespace Messaging { namespace EventHubs {
      */
     Models::EventHubPartitionProperties GetPartitionProperties(
         std::string const& partitionID,
-        GetPartitionPropertiesOptions options = {});
+        Core::Context const& context = {});
   };
 }}} // namespace Azure::Messaging::EventHubs
@@ -22,7 +22,7 @@ namespace Azure { namespace Messaging { namespace EventHubs {
    * @remark If both PartitionKey and PartitionID are nil, Event Hubs will choose an arbitrary
    * partition for any events in this [EventDataBatch].
    */
-  struct EventDataBatchOptions
+  struct EventDataBatchOptions final
   {
 
     /** @brief MaxBytes overrides the max size (in bytes) for a batch.
@@ -48,7 +48,7 @@ namespace Azure { namespace Messaging { namespace EventHubs {
    * [ProducerClient.CreateEventDataBatch], which will create them with the proper size limit for
    * your Event Hub.
    */
-  class EventDataBatch {
+  class EventDataBatch final {
   private:
     const std::string anyPartitionId = "";
 

@@ -17,4 +17,4 @@ namespace Azure { namespace Messaging { namespace EventHubs { namespace _detail
   constexpr const char* SequenceNumberAnnotation = "x-opt-sequence-number";
   constexpr const char* OffsetNumberAnnotation = "x-opt-offset";
   constexpr const char* EnqueuedTimeAnnotation = "x-opt-enqueued-time";
-}}}} // namespace Azure::Messaging::EventHubs::_detail
+}}}} // namespace Azure::Messaging::EventHubs::_detail
@@ -14,7 +14,7 @@ namespace Azure { namespace Messaging { namespace EventHubs { namespace Models {
 
   /**@brief Contains options for the ConsumerClient creation
    */
-  struct ConsumerClientDetails
+  struct ConsumerClientDetails final
   {
     /**@brief The Fully Qualified Namespace that the Event Hub exists in.
      */

@@ -7,7 +7,7 @@ namespace Azure { namespace Messaging { namespace EventHubs { namespace Models {
   /** @brief The type of the body of an EventData Message.
    *
    */
-  struct EventDataBody
+  struct EventDataBody final
   {
     /** @brief Value is encoded / decoded as the amqp - value section in the body.
      *
@@ -61,6 +61,7 @@ namespace Azure { namespace Messaging { namespace EventHubs { namespace Models {
     std::map<std::string, Azure::Core::Amqp::Models::AmqpValue> Properties;
 
     EventData() = default;
+    virtual ~EventData() = default;
   };
 
   /** @brief Represents an event received from the Azure Event Hubs service.
@@ -69,7 +70,7 @@ namespace Azure { namespace Messaging { namespace EventHubs { namespace Models {
    * specifically the date and time that the event was enqueued, the offset of the event data within
    * the partition, and the partition key for sending a message to a partition.
    */
-  class ReceivedEventData : public EventData {
+  class ReceivedEventData final : public EventData {
   public:
     /** @brief The date and time that the event was enqueued.
      *