summaryrefslogtreecommitdiff
path: root/man/sd_bus_get_fd.xml
diff options
context:
space:
mode:
Diffstat (limited to 'man/sd_bus_get_fd.xml')
-rw-r--r--man/sd_bus_get_fd.xml101
1 files changed, 0 insertions, 101 deletions
diff --git a/man/sd_bus_get_fd.xml b/man/sd_bus_get_fd.xml
deleted file mode 100644
index 9f7019069f..0000000000
--- a/man/sd_bus_get_fd.xml
+++ /dev/null
@@ -1,101 +0,0 @@
-<?xml version='1.0'?> <!--*- Mode: nxml; nxml-child-indent: 2; indent-tabs-mode: nil -*-->
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
-"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
-
-<!--
- This file is part of systemd.
-
- Copyright 2016 Julian Orth
-
- systemd is free software; you can redistribute it and/or modify it
- under the terms of the GNU Lesser General Public License as published by
- the Free Software Foundation; either version 2.1 of the License, or
- (at your option) any later version.
-
- systemd is distributed in the hope that it will be useful, but
- WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- Lesser General Public License for more details.
-
- You should have received a copy of the GNU Lesser General Public License
- along with systemd; If not, see <http://www.gnu.org/licenses/>.
--->
-
-<refentry id="sd_bus_get_fd">
-
- <refentryinfo>
- <title>sd_bus_get_fd</title>
- <productname>systemd</productname>
-
- <authorgroup>
- <author>
- <firstname>Julian</firstname>
- <surname>Orth</surname>
- <email>ju.orth@gmail.com</email>
- </author>
- </authorgroup>
- </refentryinfo>
-
- <refmeta>
- <refentrytitle>sd_bus_get_fd</refentrytitle>
- <manvolnum>3</manvolnum>
- </refmeta>
-
- <refnamediv>
- <refname>sd_bus_get_fd</refname>
-
- <refpurpose>Get the file descriptor connected to the message bus</refpurpose>
- </refnamediv>
-
- <refsynopsisdiv>
- <funcsynopsis>
- <funcsynopsisinfo>#include &lt;systemd/sd-bus.h&gt;</funcsynopsisinfo>
-
- <funcprototype>
- <funcdef>int <function>sd_bus_get_fd</function></funcdef>
- <paramdef>sd_bus *<parameter>bus</parameter></paramdef>
- </funcprototype>
- </funcsynopsis>
- </refsynopsisdiv>
-
- <refsect1>
- <title>Description</title>
-
- <para>
- <function>sd_bus_get_fd()</function> returns the file descriptor used to
- communicate with the message bus. This descriptor can be used with
- <citerefentry
- project='die-net'><refentrytitle>select</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
- <citerefentry
- project='die-net'><refentrytitle>poll</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
- or similar functions to wait for incoming messages.
- </para>
-
- <para>
- If the bus was created with the
- <citerefentry><refentrytitle>sd_bus_set_fd</refentrytitle><manvolnum>3</manvolnum></citerefentry>
- function, then the <parameter>input_fd</parameter> used in that call is
- returned.
- </para>
- </refsect1>
-
- <refsect1>
- <title>Return Value</title>
-
- <para>
- Returns the file descriptor used for incoming messages from the message
- bus.
- </para>
- </refsect1>
-
- <refsect1>
- <title>See Also</title>
-
- <para>
- <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
- <citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
- <citerefentry><refentrytitle>sd_bus_set_fd</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
- </para>
- </refsect1>
-
-</refentry>