summaryrefslogtreecommitdiffstats
path: root/man/sd_bus_attach_event.xml
diff options
context:
space:
mode:
authorLennart Poettering <lennart@poettering.net>2018-12-12 12:31:05 +0100
committerLennart Poettering <lennart@poettering.net>2018-12-13 22:33:47 +0100
commitffd1a3f688351e33b7133c8b4235258535f879a8 (patch)
treef1febd5e81d481075ef721b14ecbe92234b733ae /man/sd_bus_attach_event.xml
parentman: Use the proper option name in documentation (diff)
downloadsystemd-ffd1a3f688351e33b7133c8b4235258535f879a8.tar.xz
systemd-ffd1a3f688351e33b7133c8b4235258535f879a8.zip
man: substantially update the docs regarding hooking sd-bus objects up with external event loops
Prompted by https://lists.freedesktop.org/archives/systemd-devel/2018-December/041817.html This also drops all references to select() from our manpages. It's 2018 after all, people should use poll(), or ppoll() or epoll().
Diffstat (limited to 'man/sd_bus_attach_event.xml')
-rw-r--r--man/sd_bus_attach_event.xml10
1 files changed, 9 insertions, 1 deletions
diff --git a/man/sd_bus_attach_event.xml b/man/sd_bus_attach_event.xml
index 45f034910f..a2f7297f21 100644
--- a/man/sd_bus_attach_event.xml
+++ b/man/sd_bus_attach_event.xml
@@ -71,6 +71,13 @@
<para>The <function>sd_bus_get_event()</function> returns the event loop object the specified bus object is
currently attached to, or <constant>NULL</constant> if it is currently not attached to any.</para>
+
+ <para>Note that <function>sd_bus_attach_event()</function> is only one of three supported ways to implement I/O
+ event handling for bus connections. Alternatively use
+ <citerefentry><refentrytitle>sd_bus_get_fd</refentrytitle><manvolnum>3</manvolnum></citerefentry> for hooking up a
+ bus connection object with external or manual event loops. Or use
+ <citerefentry><refentrytitle>sd_bus_wait</refentrytitle><manvolnum>3</manvolnum></citerefentry> as a simple
+ synchronous, blocking I/O waiting call.</para>
</refsect1>
<refsect1>
@@ -107,7 +114,8 @@
<citerefentry><refentrytitle>sd-event</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
<citerefentry><refentrytitle>sd_event_source_set_priority</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
<citerefentry><refentrytitle>sd_bus_set_close_on_exit</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
- <citerefentry><refentrytitle>sd_bus_wait</refentrytitle><manvolnum>3</manvolnum></citerefentry>
+ <citerefentry><refentrytitle>sd_bus_wait</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
+ <citerefentry><refentrytitle>sd_bus_get_fd</refentrytitle><manvolnum>3</manvolnum></citerefentry>
</para>
</refsect1>