mirrors/systemd
0
0
Fork 0
mirror of https://github.com/systemd/systemd.git synced 2024-11-27 12:13:33 +08:00
Code Issues Packages Projects Releases Wiki Activity
6733d691bb
systemd/man/sd_event_get_fd.xml

117 lines
4.1 KiB
XML
Raw Normal View History

man: drop mode line in file headers This is already included in .dir-locals, so we don't need it in the files themselves.
2018-07-03 05:15:39 +08:00
<?xml version='1.0'?>
man: use same header for all files The "include" files had type "book" for some raeason. I don't think this is meaningful. Let's just use the same everywhere. $ perl -i -0pe 's^..DOCTYPE (book|refentry) PUBLIC "-//OASIS//DTD DocBook XML V4.[25]//EN"\s+"http^<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"\n "http^gms' man/*.xml
2019-03-14 21:40:58 +08:00
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
man: use same version in public and system ident.
2023-12-25 22:48:33 +08:00
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
license: LGPL-2.1+ -> LGPL-2.1-or-later
2020-11-09 12:23:58 +08:00
<!-- SPDX-License-Identifier: LGPL-2.1-or-later -->
man: add sd_event_get_fd(3) Example from Tom Gundersen is included using xi:include. The copyright notice stands out a bit. Maybe it should be removed, and the code placed in public domain.
2014-10-03 08:49:30 +08:00
man: fully document sd-event interfaces This completes the set of man pages for sd-event and contains some minor other fixes for other man pages too. The sd_event_set_name(3) man page is renamed to sd_event_source_set_description(3), which is the correct name of the concept today.
2015-11-20 06:38:54 +08:00
<refentry id="sd_event_get_fd" xmlns:xi="http://www.w3.org/2001/XInclude">
man: add sd_event_get_fd(3) Example from Tom Gundersen is included using xi:include. The copyright notice stands out a bit. Maybe it should be removed, and the code placed in public domain.
2014-10-03 08:49:30 +08:00
<refentryinfo>
<title>sd_event_get_fd</title>
<productname>systemd</productname>
</refentryinfo>
<refmeta>
<refentrytitle>sd_event_get_fd</refentrytitle>
<manvolnum>3</manvolnum>
</refmeta>
<refnamediv>
<refname>sd_event_get_fd</refname>
<refpurpose>Obtain a file descriptor to poll for event loop events</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
man: fully document sd-event interfaces This completes the set of man pages for sd-event and contains some minor other fixes for other man pages too. The sd_event_set_name(3) man page is renamed to sd_event_source_set_description(3), which is the correct name of the concept today.
2015-11-20 06:38:54 +08:00
<funcsynopsisinfo>#include &lt;systemd/sd-event.h&gt;</funcsynopsisinfo>
man: add sd_event_get_fd(3) Example from Tom Gundersen is included using xi:include. The copyright notice stands out a bit. Maybe it should be removed, and the code placed in public domain.
2014-10-03 08:49:30 +08:00
<funcprototype>
<funcdef>int <function>sd_event_get_fd</function></funcdef>
man: fully document sd-event interfaces This completes the set of man pages for sd-event and contains some minor other fixes for other man pages too. The sd_event_set_name(3) man page is renamed to sd_event_source_set_description(3), which is the correct name of the concept today.
2015-11-20 06:38:54 +08:00
<paramdef>sd_event *<parameter>event</parameter></paramdef>
man: add sd_event_get_fd(3) Example from Tom Gundersen is included using xi:include. The copyright notice stands out a bit. Maybe it should be removed, and the code placed in public domain.
2014-10-03 08:49:30 +08:00
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para><function>sd_event_get_fd()</function> returns the file
man: fully document sd-event interfaces This completes the set of man pages for sd-event and contains some minor other fixes for other man pages too. The sd_event_set_name(3) man page is renamed to sd_event_source_set_description(3), which is the correct name of the concept today.
2015-11-20 06:38:54 +08:00
descriptor that an event loop object returned by the
man: add sd_event_get_fd(3) Example from Tom Gundersen is included using xi:include. The copyright notice stands out a bit. Maybe it should be removed, and the code placed in public domain.
2014-10-03 08:49:30 +08:00
<citerefentry><refentrytitle>sd_event_new</refentrytitle><manvolnum>3</manvolnum></citerefentry>
man: fully document sd-event interfaces This completes the set of man pages for sd-event and contains some minor other fixes for other man pages too. The sd_event_set_name(3) man page is renamed to sd_event_source_set_description(3), which is the correct name of the concept today.
2015-11-20 06:38:54 +08:00
function uses to wait for events. This file descriptor may itself
be polled for
<constant>POLLIN</constant>/<constant>EPOLLIN</constant>
events. This makes it possible to embed an
man: add sd_event_get_fd(3) Example from Tom Gundersen is included using xi:include. The copyright notice stands out a bit. Maybe it should be removed, and the code placed in public domain.
2014-10-03 08:49:30 +08:00
<citerefentry><refentrytitle>sd-event</refentrytitle><manvolnum>3</manvolnum></citerefentry>
man: fully document sd-event interfaces This completes the set of man pages for sd-event and contains some minor other fixes for other man pages too. The sd_event_set_name(3) man page is renamed to sd_event_source_set_description(3), which is the correct name of the concept today.
2015-11-20 06:38:54 +08:00
event loop into another, possibly foreign, event loop.</para>
<para>The returned file descriptor refers to an <citerefentry
project='man-pages'><refentrytitle>epoll</refentrytitle><manvolnum>7</manvolnum></citerefentry>
object. It is recommended not to alter it by invoking
<citerefentry
project='man-pages'><refentrytitle>epoll_ctl</refentrytitle><manvolnum>2</manvolnum></citerefentry>
on it, in order to avoid interference with the event loop's inner
logic and assumptions.</para>
man: add sd_event_get_fd(3) Example from Tom Gundersen is included using xi:include. The copyright notice stands out a bit. Maybe it should be removed, and the code placed in public domain.
2014-10-03 08:49:30 +08:00
</refsect1>
<refsect1>
<title>Return Value</title>
man: make separate "Errors" sections subsection of "Return value" Logically, this is better, because we're describing a subset of possible return values. Visually this also looks quite good because groff renders refsect2 much less prominently. Also rewrap things, add <constant> in various places, fix some typos.
2019-03-21 21:53:00 +08:00
<para>On success, <function>sd_event_get_fd()</function> returns a non-negative file descriptor. On
failure, it returns a negative errno-style error code.</para>
man: add sd_event_get_fd(3) Example from Tom Gundersen is included using xi:include. The copyright notice stands out a bit. Maybe it should be removed, and the code placed in public domain.
2014-10-03 08:49:30 +08:00
man: make separate "Errors" sections subsection of "Return value" Logically, this is better, because we're describing a subset of possible return values. Visually this also looks quite good because groff renders refsect2 much less prominently. Also rewrap things, add <constant> in various places, fix some typos.
2019-03-21 21:53:00 +08:00
<refsect2>
<title>Errors</title>
man: add sd_event_get_fd(3) Example from Tom Gundersen is included using xi:include. The copyright notice stands out a bit. Maybe it should be removed, and the code placed in public domain.
2014-10-03 08:49:30 +08:00
man: make separate "Errors" sections subsection of "Return value" Logically, this is better, because we're describing a subset of possible return values. Visually this also looks quite good because groff renders refsect2 much less prominently. Also rewrap things, add <constant> in various places, fix some typos.
2019-03-21 21:53:00 +08:00
<para>Returned errors may indicate the following problems:</para>
man: add sd_event_get_fd(3) Example from Tom Gundersen is included using xi:include. The copyright notice stands out a bit. Maybe it should be removed, and the code placed in public domain.
2014-10-03 08:49:30 +08:00
man: make separate "Errors" sections subsection of "Return value" Logically, this is better, because we're describing a subset of possible return values. Visually this also looks quite good because groff renders refsect2 much less prominently. Also rewrap things, add <constant> in various places, fix some typos.
2019-03-21 21:53:00 +08:00
<variablelist>
<varlistentry>
<term><constant>-EINVAL</constant></term>
man: add sd_event_get_fd(3) Example from Tom Gundersen is included using xi:include. The copyright notice stands out a bit. Maybe it should be removed, and the code placed in public domain.
2014-10-03 08:49:30 +08:00
man: make separate "Errors" sections subsection of "Return value" Logically, this is better, because we're describing a subset of possible return values. Visually this also looks quite good because groff renders refsect2 much less prominently. Also rewrap things, add <constant> in various places, fix some typos.
2019-03-21 21:53:00 +08:00
<listitem><para><parameter>event</parameter> is not a valid pointer to an
<structname>sd_event</structname> structure.</para></listitem>
</varlistentry>
man: add sd_event_get_fd(3) Example from Tom Gundersen is included using xi:include. The copyright notice stands out a bit. Maybe it should be removed, and the code placed in public domain.
2014-10-03 08:49:30 +08:00
man: make separate "Errors" sections subsection of "Return value" Logically, this is better, because we're describing a subset of possible return values. Visually this also looks quite good because groff renders refsect2 much less prominently. Also rewrap things, add <constant> in various places, fix some typos.
2019-03-21 21:53:00 +08:00
<varlistentry>
<term><constant>-ECHILD</constant></term>
man: add sd_event_get_fd(3) Example from Tom Gundersen is included using xi:include. The copyright notice stands out a bit. Maybe it should be removed, and the code placed in public domain.
2014-10-03 08:49:30 +08:00
sd-event: store and compare per-module static origin id sd-event objects use hashmaps, which use module-global state, so it is not safe to pass a sd-event object created by a module instance to another module instance (e.g.: when two libraries static linking sd-event are pulled in a single process). Initialize a random per-module origin id and store it in the object, and compare it when entering a public API, and error out if they don't match, together with the PID.
2023-04-25 08:46:22 +08:00
<listitem><para>The event loop has been created in a different process, library or module instance.</para></listitem>
man: add sd_event_get_fd(3) Example from Tom Gundersen is included using xi:include. The copyright notice stands out a bit. Maybe it should be removed, and the code placed in public domain.
2014-10-03 08:49:30 +08:00
man: make separate "Errors" sections subsection of "Return value" Logically, this is better, because we're describing a subset of possible return values. Visually this also looks quite good because groff renders refsect2 much less prominently. Also rewrap things, add <constant> in various places, fix some typos.
2019-03-21 21:53:00 +08:00
</varlistentry>
</variablelist>
</refsect2>
man: add sd_event_get_fd(3) Example from Tom Gundersen is included using xi:include. The copyright notice stands out a bit. Maybe it should be removed, and the code placed in public domain.
2014-10-03 08:49:30 +08:00
</refsect1>
<refsect1>
<title>Examples</title>
<example>
man: fully document sd-event interfaces This completes the set of man pages for sd-event and contains some minor other fixes for other man pages too. The sd_event_set_name(3) man page is renamed to sd_event_source_set_description(3), which is the correct name of the concept today.
2015-11-20 06:38:54 +08:00
<title>Integration in the GLib event loop</title>
man: add sd_event_get_fd(3) Example from Tom Gundersen is included using xi:include. The copyright notice stands out a bit. Maybe it should be removed, and the code placed in public domain.
2014-10-03 08:49:30 +08:00
<programlisting><xi:include href="glib-event-glue.c" parse="text" /></programlisting>
</example>
</refsect1>
man: fully document sd-event interfaces This completes the set of man pages for sd-event and contains some minor other fixes for other man pages too. The sd_event_set_name(3) man page is renamed to sd_event_source_set_description(3), which is the correct name of the concept today.
2015-11-20 06:38:54 +08:00
<xi:include href="libsystemd-pkgconfig.xml" />
man: add sd_event_get_fd(3) Example from Tom Gundersen is included using xi:include. The copyright notice stands out a bit. Maybe it should be removed, and the code placed in public domain.
2014-10-03 08:49:30 +08:00
man: add version information for functions
2023-09-04 20:46:35 +08:00
<refsect1>
<title>History</title>
<para><function>sd_event_get_fd()</function> was added in version 217.</para>
</refsect1>
man: add sd_event_get_fd(3) Example from Tom Gundersen is included using xi:include. The copyright notice stands out a bit. Maybe it should be removed, and the code placed in public domain.
2014-10-03 08:49:30 +08: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-23 02:09:32 +08:00
<para><simplelist type="inline">
<member><citerefentry><refentrytitle>sd-event</refentrytitle><manvolnum>3</manvolnum></citerefentry></member>
<member><citerefentry><refentrytitle>sd_event_new</refentrytitle><manvolnum>3</manvolnum></citerefentry></member>
<member><citerefentry><refentrytitle>sd_event_wait</refentrytitle><manvolnum>3</manvolnum></citerefentry></member>
<member><citerefentry project='man-pages'><refentrytitle>epoll_ctl</refentrytitle><manvolnum>2</manvolnum></citerefentry></member>
<member><citerefentry project='man-pages'><refentrytitle>epoll</refentrytitle><manvolnum>7</manvolnum></citerefentry></member>
</simplelist></para>
man: add sd_event_get_fd(3) Example from Tom Gundersen is included using xi:include. The copyright notice stands out a bit. Maybe it should be removed, and the code placed in public domain.
2014-10-03 08:49:30 +08:00
</refsect1>
</refentry>
Reference in New Issue Copy Permalink