summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorigo95862 <igo95862@yandex.ru>2020-11-17 12:47:28 +0300
committerZbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl>2020-12-08 18:08:31 +0100
commit2f5c994dde74a5d43686b030fd3b26af3520b2f9 (patch)
treecc7c2465dbd9b95a0badee552b90d6a59a72e1dd
parent8992d8576bdef0ccfc5d9cd338609307f201a8c5 (diff)
downloadsystemd-2f5c994dde74a5d43686b030fd3b26af3520b2f9.tar.gz
man: Add a paragraph to sd_bus_call explaning callback message lifetime
(cherry picked from commit e6ce785d611702532ae71547e78fbb49eff3aded)
-rw-r--r--man/sd_bus_call.xml6
1 files changed, 6 insertions, 0 deletions
diff --git a/man/sd_bus_call.xml b/man/sd_bus_call.xml
index b52f65a8d3..2b44f52076 100644
--- a/man/sd_bus_call.xml
+++ b/man/sd_bus_call.xml
@@ -89,6 +89,12 @@
input parameter; it can be used to propagate errors from the callback handler, it will not receive any
error that was received as method reply.)</para>
+ <para>The message <parameter>m</parameter> passed to the callback is only borrowed, that is, the callback should
+ not call <citerefentry><refentrytitle>sd_bus_message_unref</refentrytitle><manvolnum>3</manvolnum></citerefentry>
+ on it. If the callback wants to hold on to the message beyond the lifetime of the callback, it needs to call
+ <citerefentry><refentrytitle>sd_bus_message_ref</refentrytitle><manvolnum>3</manvolnum></citerefentry> to create a
+ new reference.</para>
+
<para>If <parameter>usec</parameter> is zero, the default D-Bus method call timeout is used. See
<citerefentry><refentrytitle>sd_bus_get_method_call_timeout</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
</para>