1 <?xml version='
1.0'
?> <!--*-nxml-*-->
2 <!DOCTYPE refentry PUBLIC
"-//OASIS//DTD DocBook XML V4.2//EN"
3 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
4 <!ENTITY % entities SYSTEM
"custom-entities.ent" >
9 This file is part of systemd.
11 Copyright 2015 David Herrmann <dh.herrmann@gmail.com>
13 systemd is free software; you can redistribute it and/or modify it
14 under the terms of the GNU Lesser General Public License as published by
15 the Free Software Foundation; either version 2.1 of the License, or
16 (at your option) any later version.
18 systemd is distributed in the hope that it will be useful, but
19 WITHOUT ANY WARRANTY; without even the implied warranty of
20 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
21 Lesser General Public License for more details.
23 You should have received a copy of the GNU Lesser General Public License
24 along with systemd; If not, see <http://www.gnu.org/licenses/>.
27 <refentry id=
"udev_monitor_receive_device"
28 xmlns:
xi=
"http://www.w3.org/2001/XInclude">
31 <title>udev_monitor_receive_device
</title>
32 <productname>systemd
</productname>
36 <contrib>Developer
</contrib>
37 <firstname>David
</firstname>
38 <surname>Herrmann
</surname>
39 <email>dh.herrmann@gmail.com
</email>
45 <refentrytitle>udev_monitor_receive_device
</refentrytitle>
46 <manvolnum>3</manvolnum>
50 <refname>udev_monitor_receive_device
</refname>
51 <refname>udev_monitor_enable_receiving
</refname>
52 <refname>udev_monitor_set_receive_buffer_size
</refname>
53 <refname>udev_monitor_get_fd
</refname>
54 <refname>udev_monitor_get_udev
</refname>
56 <refpurpose>Query and modify device monitor
</refpurpose>
61 <funcsynopsisinfo>#include
<libudev.h
></funcsynopsisinfo>
64 <funcdef>struct udev_device *
<function>udev_monitor_receive_device
</function></funcdef>
65 <paramdef>struct udev_monitor *
<parameter>udev_monitor
</parameter></paramdef>
69 <funcdef>int
<function>udev_monitor_enable_receiving
</function></funcdef>
70 <paramdef>struct udev_monitor *
<parameter>udev_monitor
</parameter></paramdef>
74 <funcdef>int
<function>udev_monitor_set_receive_buffer_size
</function></funcdef>
75 <paramdef>struct udev_monitor *
<parameter>udev_monitor
</parameter></paramdef>
76 <paramdef>int
<parameter>size
</parameter></paramdef>
80 <funcdef>int
<function>udev_monitor_get_fd
</function></funcdef>
81 <paramdef>struct udev_monitor *
<parameter>udev_monitor
</parameter></paramdef>
85 <funcdef>struct udev *
<function>udev_monitor_get_udev
</function></funcdef>
86 <paramdef>struct udev_monitor *
<parameter>udev_monitor
</parameter></paramdef>
93 <title>Description</title>
95 <para>XXX: Add short description.</para>
99 <title>Return Value
</title>
102 <function>udev_monitor_receive_device()
</function> returns a
103 pointer to a newly referenced device that was received via the
104 monitor. The caller is responsible to drop this reference when
105 done. On failure,
<constant>NULL
</constant> is returned.
</para>
108 <function>udev_monitor_enable_receiving()
</function> and
109 <function>udev_monitor_set_receive_buffer_size()
</function>
110 return an integer greater than, or equal to,
111 <constant>0</constant>. On failure, a negative error code is
114 <para>On success,
<function>udev_monitor_get_fd()
</function>
115 returns the file descriptor used by this monitor. On failure,
116 a negative error code is returned.
</para>
118 <para><function>udev_monitor_get_udev()
</function> always returns
119 a pointer to the udev context that this monitor is associated
124 <title>See Also
</title>
127 <citerefentry><refentrytitle>udev_new
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
128 <citerefentry><refentrytitle>udev_device_new_from_syspath
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
129 <citerefentry><refentrytitle>udev_enumerate_new
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
130 <citerefentry><refentrytitle>udev_monitor_new_from_netlink
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
131 <citerefentry><refentrytitle>udev_monitor_filter_update
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
132 <citerefentry><refentrytitle>udev_list_entry
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
133 <citerefentry><refentrytitle>systemd
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,