diff options
| author | Lennart Poettering <lennart@poettering.net> | 2020-09-23 10:09:53 +0200 |
|---|---|---|
| committer | Zbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl> | 2020-09-30 15:01:17 +0200 |
| commit | 533ee38b56e881a49481bdc095793c294acce121 (patch) | |
| tree | 43eaaeda73e2f6c0c7a0c534cb3a92ede4d6a835 /man/sd_bus_send.xml | |
| parent | d1f6e01e4743ae94740314eeb46a162112ef4599 (diff) | |
| download | systemd-533ee38b56e881a49481bdc095793c294acce121.tar.gz | |
man: mention that sd_bus_send() buffers locally, and sd_bus_process() is needed to flush it out
Prompted-by: #17128
Diffstat (limited to 'man/sd_bus_send.xml')
| -rw-r--r-- | man/sd_bus_send.xml | 11 |
1 files changed, 10 insertions, 1 deletions
diff --git a/man/sd_bus_send.xml b/man/sd_bus_send.xml index 2cdf436db2..233dd7c4fa 100644 --- a/man/sd_bus_send.xml +++ b/man/sd_bus_send.xml @@ -68,6 +68,14 @@ single receiver). It's behavior is similar to calling <citerefentry><refentrytitle>sd_bus_message_set_destination</refentrytitle><manvolnum>3</manvolnum></citerefentry> followed by calling <function>sd_bus_send()</function>.</para> + + <para><function>sd_bus_send()</function>/<function>sd_bus_send_to()</function> will write the message + directly to the underlying transport (e.g. kernel socket buffer) if possible. If the connection is not + set up fully yet the message is queued locally. If the transport buffers are congested any unwritten + message data is queued locally, too. If the connection has been closed or is currently being closed the + call fails. + <citerefentry><refentrytitle>sd_bus_process</refentrytitle><manvolnum>3</manvolnum></citerefentry> should + be invoked to write out any queued message data to the transport.</para> </refsect1> <refsect1> @@ -142,7 +150,8 @@ <citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry>, <citerefentry><refentrytitle>sd_bus_call_method</refentrytitle><manvolnum>3</manvolnum></citerefentry>, <citerefentry><refentrytitle>sd_bus_message_set_destination</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_reply_method_return</refentrytitle><manvolnum>3</manvolnum></citerefentry> + <citerefentry><refentrytitle>sd_bus_reply_method_return</refentrytitle><manvolnum>3</manvolnum></citerefentry>, + <citerefentry><refentrytitle>sd_bus_process</refentrytitle><manvolnum>3</manvolnum></citerefentry> </para> </refsect1> |