shaba/systemd
1
0
Fork 0
mirror of https://github.com/systemd/systemd.git synced 2024-12-23 21:35:11 +03:00
Code
c1852f9d5f
systemd/man/sd_bus_set_fd.xml

136 lines
4.7 KiB
XML
Raw Normal View History

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.
2021-02-20 16:03:34 +03:00
<?xml version='1.0'?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
man: use same version in public and system ident.
2023-12-25 17:48:33 +03:00
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
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.
2021-02-20 16:03:34 +03:00
<!--
SPDX-License-Identifier: LGPL-2.1-or-later
Copyright © 2016 Julian Orth
-->
<refentry id="sd_bus_set_fd" xmlns:xi="http://www.w3.org/2001/XInclude">
<refentryinfo>
<title>sd_bus_set_fd</title>
<productname>systemd</productname>
</refentryinfo>
<refmeta>
<refentrytitle>sd_bus_set_fd</refentrytitle>
<manvolnum>3</manvolnum>
</refmeta>
<refnamediv>
<refname>sd_bus_set_fd</refname>
<refpurpose>Set the file descriptors to use for bus communication</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcsynopsisinfo>#include &lt;systemd/sd-bus.h&gt;</funcsynopsisinfo>
<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>
</funcsynopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para><function>sd_bus_set_fd()</function> sets the file descriptors used to communicate by a bus
connection object. Both <parameter>input_fd</parameter> and <parameter>output_fd</parameter> must be
valid file descriptors, referring to stream-based file objects (e.g. a stream socket, a pair of pipes or
tree-wide: "a" -> "an"
2021-06-30 15:26:47 +03:00
FIFOs, or even a TTY device). <parameter>input_fd</parameter> must be readable, and
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.
2021-02-20 16:03:34 +03:00
<parameter>output_fd</parameter> must be writable. The same file descriptor may be used (and typically is
used) as both the input and the output file descriptor. This function must be called before the bus
connection is started via
<citerefentry><refentrytitle>sd_bus_start</refentrytitle><manvolnum>3</manvolnum></citerefentry>.</para>
<para>The bus connection object will take possession of the passed file descriptors and will close them
automatically when it is freed. Use
<citerefentry><refentrytitle>sd_bus_set_close_on_exit</refentrytitle><manvolnum>3</manvolnum></citerefentry>
to turn off this behaviour.</para>
</refsect1>
<refsect1>
<title>Return Value</title>
<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>
<refsect2>
<title>Errors</title>
<para>Returned errors may indicate the following problems:</para>
<variablelist>
<varlistentry>
<term><constant>-EINVAL</constant></term>
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-22 19:52:36 +03:00
<listitem><para>An invalid bus object was passed.</para>
<xi:include href="version-info.xml" xpointer="v248"/></listitem>
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.
2021-02-20 16:03:34 +03:00
</varlistentry>
<varlistentry>
<term><constant>-ECHILD</constant></term>
<listitem><para>The bus connection was allocated in a parent process and is being reused
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-22 19:52:36 +03:00
in a child process after <function>fork()</function>.</para>
<xi:include href="version-info.xml" xpointer="v248"/></listitem>
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.
2021-02-20 16:03:34 +03:00
</varlistentry>
<varlistentry>
<term><constant>-EBADF</constant></term>
<listitem><para>An invalid file descriptor was passed to
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-22 19:52:36 +03:00
<function>sd_bus_set_fd()</function>.</para>
<xi:include href="version-info.xml" xpointer="v248"/></listitem>
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.
2021-02-20 16:03:34 +03:00
</varlistentry>
<varlistentry>
<term><constant>-ENOPKG</constant></term>
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-22 19:52:36 +03:00
<listitem><para>The bus cannot be resolved.</para>
<xi:include href="version-info.xml" xpointer="v248"/></listitem>
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.
2021-02-20 16:03:34 +03:00
</varlistentry>
<varlistentry>
<term><constant>-EPERM</constant></term>
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-22 19:52:36 +03:00
<listitem><para>The bus connection has already been started.</para>
<xi:include href="version-info.xml" xpointer="v248"/></listitem>
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.
2021-02-20 16:03:34 +03:00
</varlistentry>
</variablelist>
</refsect2>
</refsect1>
<xi:include href="libsystemd-pkgconfig.xml" />
man: add version information for functions
2023-09-04 15:46:35 +03:00
<refsect1>
<title>History</title>
<para><function>sd_bus_set_fd()</function> was added in version 248.</para>
</refsect1>
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.
2021-02-20 16:03:34 +03:00
<refsect1>
<title>See Also</title>
man: use <simplelist> for 'See also' sections This is just a slight markup improvement; there should be no difference in rendering.
2023-12-22 21:09:32 +03:00
<para><simplelist type="inline">
<member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member>
<member><citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry></member>
<member><citerefentry><refentrytitle>sd_bus_get_fd</refentrytitle><manvolnum>3</manvolnum></citerefentry></member>
<member><citerefentry><refentrytitle>sd_bus_start</refentrytitle><manvolnum>3</manvolnum></citerefentry></member>
</simplelist></para>
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.
2021-02-20 16:03:34 +03:00
</refsect1>
</refentry>
Copy Permalink