summaryrefslogtreecommitdiff
path: root/man/sd_bus_get_fd.xml
diff options
context:
space:
mode:
authorLennart Poettering <lennart@poettering.net>2021-02-20 14:03:34 +0100
committerLennart Poettering <lennart@poettering.net>2021-02-20 16:13:06 +0100
commitcd6d2111c496ace8370974394c766178ae0c8f40 (patch)
treed7f909227d6dc947ebbd1dc8f3744aac42c9e4a4 /man/sd_bus_get_fd.xml
parent2306d1778f2479cb16423d51d82f8f31b15146d1 (diff)
downloadsystemd-cd6d2111c496ace8370974394c766178ae0c8f40.tar.gz
man: split out sd_bus_set_fd() man page from sd_bus_get_fd()
sd_bus_get_fd() and related calls are useful for integrating a bus connection into arbitrary event loops. But sd_bus_set_fd() is quite a different beast, it's for using D-Bus over pre-initialized sockets or pairs of fifos or stuff, i.e. very advanced stuff. Let's split this man page in two, in order not to confuse things needlessly. And while we are at it, let's slightly extend the documentation.
Diffstat (limited to 'man/sd_bus_get_fd.xml')
-rw-r--r--man/sd_bus_get_fd.xml24
1 files changed, 1 insertions, 23 deletions
diff --git a/man/sd_bus_get_fd.xml b/man/sd_bus_get_fd.xml
index 7297db316f..2c0ec8fc05 100644
--- a/man/sd_bus_get_fd.xml
+++ b/man/sd_bus_get_fd.xml
@@ -22,7 +22,6 @@
<refnamediv>
<refname>sd_bus_get_fd</refname>
- <refname>sd_bus_set_fd</refname>
<refname>sd_bus_get_events</refname>
<refname>sd_bus_get_timeout</refname>
@@ -40,13 +39,6 @@
</funcprototype>
<funcprototype>
- <funcdef>int <function>sd_bus_set_fd</function></funcdef>
- <paramdef>sd_bus *<parameter>bus</parameter></paramdef>
- <paramdef>int <parameter>input_fd</parameter></paramdef>
- <paramdef>int <parameter>output_fd</parameter></paramdef>
- </funcprototype>
-
- <funcprototype>
<funcdef>int <function>sd_bus_get_events</function></funcdef>
<paramdef>sd_bus *<parameter>bus</parameter></paramdef>
</funcprototype>
@@ -69,11 +61,6 @@
object was configured with the <function>sd_bus_set_fd()</function> function, then the
<parameter>input_fd</parameter> file descriptor used in that call is returned.</para>
- <para><function>sd_bus_set_fd()</function> sets the file descriptors used to communicate from a
- message bus object. Both <parameter>input_fd</parameter> and <parameter>output_fd</parameter>
- must be valid file descriptors. The same file descriptor may be used as both the input and the
- output file descriptor. This function must be called before the bus is started.</para>
-
<para><function>sd_bus_get_events()</function> returns the I/O events to wait for, suitable for
passing to <function>poll()</function> or a similar call. Returns a combination of
<constant>POLLIN</constant>, <constant>POLLOUT</constant>, … events, or negative on error.
@@ -122,9 +109,6 @@
<para>On success, <function>sd_bus_get_fd()</function> returns the file descriptor used for
communication. On failure, it returns a negative errno-style error code.</para>
- <para>On success, <function>sd_bus_set_fd()</function> returns a non-negative integer. On
- failure, it returns a negative errno-style error code.</para>
-
<para>On success, <function>sd_bus_get_events()</function> returns the I/O event mask to use for
I/O event watching. On failure, it returns a negative errno-style error code.</para>
@@ -165,13 +149,6 @@
</varlistentry>
<varlistentry>
- <term><constant>-EBADF</constant></term>
-
- <listitem><para>An invalid file descriptor was passed to
- <function>sd_bus_set_fd()</function>.</para></listitem>
- </varlistentry>
-
- <varlistentry>
<term><constant>-ENOPKG</constant></term>
<listitem><para>The bus cannot be resolved.</para></listitem>
@@ -191,6 +168,7 @@
<citerefentry><refentrytitle>sd_bus_process</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
<citerefentry><refentrytitle>sd_bus_attach_event</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
<citerefentry><refentrytitle>sd_bus_wait</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
+ <citerefentry><refentrytitle>sd_bus_set_fd</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
<citerefentry project='man-pages'><refentrytitle>poll</refentrytitle><manvolnum>3</manvolnum></citerefentry>
</para>
</refsect1>