From c1e8beaa511c8d94529df787094fc62e28842d62 Mon Sep 17 00:00:00 2001 From: dev Date: Mon, 17 Jul 2023 16:06:24 -0400 Subject: [PATCH] Added comments --- src/tmx/TmxUtils/src/kafka/kafka_consumer_worker.h | 9 ++++++--- src/tmx/TmxUtils/src/kafka/kafka_producer_worker.h | 10 ++++++++-- 2 files changed, 14 insertions(+), 5 deletions(-) diff --git a/src/tmx/TmxUtils/src/kafka/kafka_consumer_worker.h b/src/tmx/TmxUtils/src/kafka/kafka_consumer_worker.h index 2ce2076eb..341492b17 100644 --- a/src/tmx/TmxUtils/src/kafka/kafka_consumer_worker.h +++ b/src/tmx/TmxUtils/src/kafka/kafka_consumer_worker.h @@ -69,14 +69,17 @@ namespace tmx::utils { */ kafka_consumer_worker(const std::string &broker_str, const std::string &topic_str, const std::string & group_id, int64_t cur_offset = 0, int32_t partition = 0); /** - * @brief Destroy the kafka consumer worker object - * + * @brief Destroy the kafka consumer worker object. Calls stop on consumer to clean up resources. */ ~kafka_consumer_worker(); - + // Rule of 5 because destructor is define (https://www.codementor.io/@sandesh87/the-rule-of-five-in-c-1pdgpzb04f) + // Delete copy constructor kafka_consumer_worker(kafka_consumer_worker& other) = delete; + // Delete copy assigment kafka_consumer_worker& operator=(const kafka_consumer_worker& other) = delete; + // delete move constructor kafka_consumer_worker(kafka_consumer_worker &&consumer) = delete; + // delete move assignment kafka_consumer_worker const & operator=(kafka_consumer_worker &&consumer) = delete; /** * @brief Initialize kafka_consumer_worker diff --git a/src/tmx/TmxUtils/src/kafka/kafka_producer_worker.h b/src/tmx/TmxUtils/src/kafka/kafka_producer_worker.h index a8fc0a7fe..ae8d0b56a 100644 --- a/src/tmx/TmxUtils/src/kafka/kafka_producer_worker.h +++ b/src/tmx/TmxUtils/src/kafka/kafka_producer_worker.h @@ -60,12 +60,18 @@ namespace tmx::utils * @param broker_str network address of kafka broker. */ explicit kafka_producer_worker(const std::string &brokers); - + /** + * @brief Destroy the kafka producer worker object. Calls stop on producer to clean up resources. + */ virtual ~kafka_producer_worker(); - + // Rule of 5 because destructor is define (https://www.codementor.io/@sandesh87/the-rule-of-five-in-c-1pdgpzb04f) + // delete copy constructor kafka_producer_worker(kafka_producer_worker& other) = delete; + // delete copy assignment kafka_producer_worker& operator=(const kafka_producer_worker& other) = delete; + // delete move constructor kafka_producer_worker(kafka_producer_worker &&producer) = delete; + // delete move assignment kafka_producer_worker const & operator=(kafka_producer_worker &&producer) = delete; /** * @brief Initialize kafka_producer_worker. This method must be called before send!