Skip to content

Commit

Permalink
Added comments
Browse files Browse the repository at this point in the history
  • Loading branch information
paulbourelly999 committed Jul 17, 2023
1 parent 6e611fb commit c1e8bea
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 5 deletions.
9 changes: 6 additions & 3 deletions src/tmx/TmxUtils/src/kafka/kafka_consumer_worker.h
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
10 changes: 8 additions & 2 deletions src/tmx/TmxUtils/src/kafka/kafka_producer_worker.h
Original file line number Diff line number Diff line change
Expand Up @@ -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!
Expand Down

0 comments on commit c1e8bea

Please sign in to comment.