Skip to content

docs(cpp): clarify ownership of Conf::dump() return (#5166) #5174

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

docs(cpp): clarify ownership of Conf::dump() return (#5166) #5174

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a797121
docs(cpp): clarify ownership of Conf::dump() return (#5166)
aryanrahar Aug 23, 2025
34d2efa
Merge branch 'master' into docs/conf-dump-ownership
aryanrahar Sep 5, 2025
ce4f871
Merge branch 'master' into docs/conf-dump-ownership
aryanrahar Sep 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@

# librdkafka v2.11.2 (unreleased)

## Fixes

* C++ docs: Clarify ownership of `RdKafka::Conf::dump()` return value (#5166, @aryanrahar)
=======
# librdkafka v2.12.0

librdkafka v2.12.0 is a feature release:
Expand All @@ -19,6 +26,7 @@ librdkafka v2.12.0 is a feature release:




# librdkafka v2.11.1

librdkafka v2.11.1 is a maintenance release:
Expand Down
13 changes: 11 additions & 2 deletions src-cpp/rdkafkacpp.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1436,8 +1436,17 @@ class RD_EXPORT Conf {
virtual Conf::ConfResult get(
SslCertificateVerifyCb *&ssl_cert_verify_cb) const = 0;

/** @brief Dump configuration names and values to list containing
* name,value tuples */
/** @brief Dump configuration names and values to a list containing
* name,value tuples.
*
* @remark Ownership: The returned std::list<std::string> is heap-allocated.
* The caller owns the list and must delete it when done, e.g.:
* @code
* std::list<std::string> *lst = conf->dump();
* // ... use lst ...
* delete lst;
* @endcode
*/
virtual std::list<std::string> *dump() = 0;

/** @brief Use with \p name = \c \"consume_cb\" */
Expand Down