]>
Commit | Line | Data |
---|---|---|
514094f9 | 1 | <?xml version='1.0'?> |
e382c49f | 2 | <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" |
3 | "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> | |
4 | ||
5 | <!-- | |
572eb058 ZJS |
6 | SPDX-License-Identifier: LGPL-2.1+ |
7 | ||
96b2fb93 | 8 | Copyright © 2016 Julian Orth |
e382c49f | 9 | --> |
10 | ||
11 | <refentry id="sd_bus_get_fd"> | |
12 | ||
13 | <refentryinfo> | |
14 | <title>sd_bus_get_fd</title> | |
15 | <productname>systemd</productname> | |
e382c49f | 16 | </refentryinfo> |
17 | ||
18 | <refmeta> | |
19 | <refentrytitle>sd_bus_get_fd</refentrytitle> | |
20 | <manvolnum>3</manvolnum> | |
21 | </refmeta> | |
22 | ||
23 | <refnamediv> | |
24 | <refname>sd_bus_get_fd</refname> | |
25 | ||
26 | <refpurpose>Get the file descriptor connected to the message bus</refpurpose> | |
27 | </refnamediv> | |
28 | ||
29 | <refsynopsisdiv> | |
30 | <funcsynopsis> | |
31 | <funcsynopsisinfo>#include <systemd/sd-bus.h></funcsynopsisinfo> | |
32 | ||
33 | <funcprototype> | |
34 | <funcdef>int <function>sd_bus_get_fd</function></funcdef> | |
35 | <paramdef>sd_bus *<parameter>bus</parameter></paramdef> | |
36 | </funcprototype> | |
37 | </funcsynopsis> | |
38 | </refsynopsisdiv> | |
39 | ||
40 | <refsect1> | |
41 | <title>Description</title> | |
42 | ||
43 | <para> | |
44 | <function>sd_bus_get_fd()</function> returns the file descriptor used to | |
45 | communicate with the message bus. This descriptor can be used with | |
46 | <citerefentry | |
47 | project='die-net'><refentrytitle>select</refentrytitle><manvolnum>3</manvolnum></citerefentry>, | |
48 | <citerefentry | |
49 | project='die-net'><refentrytitle>poll</refentrytitle><manvolnum>3</manvolnum></citerefentry>, | |
6dd6a9c4 | 50 | or similar functions to wait for incoming messages. |
e382c49f | 51 | </para> |
52 | ||
53 | <para> | |
54 | If the bus was created with the | |
55 | <citerefentry><refentrytitle>sd_bus_set_fd</refentrytitle><manvolnum>3</manvolnum></citerefentry> | |
56 | function, then the <parameter>input_fd</parameter> used in that call is | |
57 | returned. | |
58 | </para> | |
59 | </refsect1> | |
60 | ||
61 | <refsect1> | |
62 | <title>Return Value</title> | |
63 | ||
64 | <para> | |
65 | Returns the file descriptor used for incoming messages from the message | |
66 | bus. | |
67 | </para> | |
68 | </refsect1> | |
69 | ||
70 | <refsect1> | |
71 | <title>See Also</title> | |
72 | ||
73 | <para> | |
74 | <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, | |
75 | <citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry>, | |
76 | <citerefentry><refentrytitle>sd_bus_set_fd</refentrytitle><manvolnum>3</manvolnum></citerefentry>, | |
77 | </para> | |
78 | </refsect1> | |
79 | ||
80 | </refentry> |