Skip to content

Commit 3b67ba0

Browse files
committed
Add support for rd_kafka_destroy_flags.
1 parent 006642c commit 3b67ba0

File tree

3 files changed

+62
-3
lines changed

3 files changed

+62
-3
lines changed

include/cppkafka/kafka_handle_base.h

Lines changed: 38 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -340,6 +340,30 @@ class CPPKAFKA_API KafkaHandleBase {
340340
*/
341341
int get_out_queue_length() const;
342342

343+
#if RD_KAFKA_VERSION >= RD_KAFKA_DESTROY_FLAGS_SUPPORT_VERSION
344+
/**
345+
* \brief Sets flags for rd_kafka_destroy_flags()
346+
*
347+
* 0 (default) - calls consumer_close() during handle destruction
348+
* to leave group and commit final offsets.
349+
*
350+
* RD_KAFKA_DESTROY_F_NO_CONSUMER_CLOSE - don't call consumer_close()
351+
*
352+
* Details: see https://github.com/edenhill/librdkafka/blob/8fc678518738c6b80380326dad86ef62228f87f0/src/rdkafka.h#L2612-L2651
353+
*
354+
* With default value some termination sequences can lead to hang
355+
* during destruction, see: https://github.com/edenhill/librdkafka/issues/2077
356+
*
357+
*/
358+
void set_destroy_flags(int destroy_flags);
359+
360+
/**
361+
* \brief Returns destroy_flags
362+
*
363+
*/
364+
int get_destroy_flags() const;
365+
366+
#endif
343367
/**
344368
* \brief Cancels the current callback dispatcher
345369
*
@@ -357,7 +381,20 @@ class CPPKAFKA_API KafkaHandleBase {
357381
private:
358382
static const std::chrono::milliseconds DEFAULT_TIMEOUT;
359383

360-
using HandlePtr = std::unique_ptr<rd_kafka_t, decltype(&rd_kafka_destroy)>;
384+
// It seems that destroy_flags maybe RD_KAFKA_DESTROY_F_NO_CONSUMER_CLOSE by default.
385+
//
386+
// All the consumer objects created by cppkafka call rd_kafka_consumer_close during destruction.
387+
// So we don't want it to be called once again during handle destruction.
388+
int destroy_flags_ = 0;
389+
390+
struct handle_deleter {
391+
handle_deleter(const KafkaHandleBase * handle_base_ptr) : handle_base_ptr_{handle_base_ptr} {}
392+
void operator()(rd_kafka_t* handle);
393+
private:
394+
const KafkaHandleBase * handle_base_ptr_;
395+
};
396+
397+
using HandlePtr = std::unique_ptr<rd_kafka_t, handle_deleter>;
361398
using TopicConfigurationMap = std::unordered_map<std::string, TopicConfiguration>;
362399

363400
Topic get_topic(const std::string& name, rd_kafka_topic_conf_t* conf);

include/cppkafka/macros.h

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,5 +51,6 @@
5151
#define RD_KAFKA_EVENT_STATS_SUPPORT_VERSION 0x000b0000 //v0.11.0.00
5252
#define RD_KAFKA_MESSAGE_STATUS_SUPPORT_VERSION 0x01000002 //v1.0.0.02
5353
#define RD_KAFKA_STORE_OFFSETS_SUPPORT_VERSION 0x00090501 //v0.9.5.01
54+
#define RD_KAFKA_DESTROY_FLAGS_SUPPORT_VERSION 0x000b0600 //v0.11.6
5455

5556
#endif // CPPKAFKA_MACROS_H

src/kafka_handle_base.cpp

Lines changed: 23 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ namespace cppkafka {
4848
const milliseconds KafkaHandleBase::DEFAULT_TIMEOUT{1000};
4949

5050
KafkaHandleBase::KafkaHandleBase(Configuration config)
51-
: timeout_ms_(DEFAULT_TIMEOUT), config_(move(config)), handle_(nullptr, nullptr) {
51+
: timeout_ms_(DEFAULT_TIMEOUT), config_(move(config)), handle_(nullptr, handle_deleter(this)) {
5252
auto& maybe_config = config_.get_default_topic_configuration();
5353
if (maybe_config) {
5454
maybe_config->set_as_opaque();
@@ -213,7 +213,7 @@ void KafkaHandleBase::yield() const {
213213
}
214214

215215
void KafkaHandleBase::set_handle(rd_kafka_t* handle) {
216-
handle_ = HandlePtr(handle, &rd_kafka_destroy);
216+
handle_ = HandlePtr(handle, handle_deleter(this));
217217
}
218218

219219
Topic KafkaHandleBase::get_topic(const string& name, rd_kafka_topic_conf_t* conf) {
@@ -285,4 +285,25 @@ rd_kafka_conf_t* KafkaHandleBase::get_configuration_handle() {
285285
return config_.get_handle();
286286
}
287287

288+
#if RD_KAFKA_VERSION >= RD_KAFKA_DESTROY_FLAGS_SUPPORT_VERSION
289+
290+
void KafkaHandleBase::set_destroy_flags(int destroy_flags) {
291+
destroy_flags_ = destroy_flags;
292+
};
293+
294+
int KafkaHandleBase::get_destroy_flags() const {
295+
return destroy_flags_;
296+
};
297+
298+
#endif
299+
300+
301+
void KafkaHandleBase::handle_deleter::operator()(rd_kafka_t* handle) {
302+
#if RD_KAFKA_VERSION >= RD_KAFKA_DESTROY_FLAGS_SUPPORT_VERSION
303+
rd_kafka_destroy_flags(handle, handle_base_ptr_->get_destroy_flags());
304+
#else
305+
rd_kafka_destroy(handle);
306+
#endif
307+
}
308+
288309
} // cppkafka

0 commit comments

Comments
 (0)