system/systemd
system/systemd
1
0
Fork 0
mirror of https://github.com/systemd/systemd synced 2024-10-14 20:17:52 +00:00
Code Issues Packages Projects Releases Wiki Activity

man/sd_bus_process: fix confusion about "synchronous"

Browse source 
An event loop is not "synchronous". So we shouldn't say that the client must
"synchrounusly poll" if we recommend an event loop. Let's just say it should
poll, and say that "sd_bus_wait()" is blocking, which is clearer and more
correct than "synchronous".
This commit is contained in:
Zbigniew Jędrzejewski-Szmek 2023-11-16 11:12:00 +01:00
parent 0f9267501b
commit 83d0edf565
1 changed files with 8 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
man/sd_bus_process.xml
View file

@ -41,14 +41,14 @@
<refsect1>
<title>Description</title>
<para><function>sd_bus_process()</function> drives the connection between the client and the message bus. That is,
it handles connecting, authentication, and message processing. When invoked pending I/O work is executed, and
queued incoming messages are dispatched to registered callbacks. Each time it is invoked a single operation is
executed. It returns zero when no operations were pending and positive if a message was processed. When zero is
returned the caller should synchronously poll for I/O events before calling into
<function>sd_bus_process()</function> again. For that either use the simple, synchronous
<citerefentry><refentrytitle>sd_bus_wait</refentrytitle><manvolnum>3</manvolnum></citerefentry> call, or hook up
the bus connection object to an external or manual event loop using
<para><function>sd_bus_process()</function> drives the connection between the client and the message bus.
That is, it handles connecting, authentication, and processing of messages. When invoked, pending I/O
work is executed, and queued incoming messages are dispatched to registered callbacks. Each time it is
invoked a single operation is executed. It returns zero when no operations were pending and positive if a
message was processed. When zero is returned the caller should poll for I/O events before calling into
<function>sd_bus_process()</function> again. For that either use the simple, blocking
<citerefentry><refentrytitle>sd_bus_wait</refentrytitle><manvolnum>3</manvolnum></citerefentry> call, or
hook up the bus connection object to an external or manual event loop using
<citerefentry><refentrytitle>sd_bus_get_fd</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
</para>