2015-06-17 16:11:11 +03:00
<?xml version='1.0'?> <!-- * - nxml - * -->
2019-03-14 16:40:58 +03:00
< !DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
2023-12-25 17:48:33 +03:00
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
2015-06-17 16:11:11 +03:00
<!ENTITY % entities SYSTEM "custom-entities.ent" >
%entities;
]>
2020-11-09 07:23:58 +03:00
<!-- SPDX - License - Identifier: LGPL - 2.1 - or - later -->
2015-06-17 16:11:11 +03:00
<refentry id= "udev_monitor_receive_device"
xmlns:xi="http://www.w3.org/2001/XInclude">
<refentryinfo >
<title > udev_monitor_receive_device</title>
<productname > systemd</productname>
</refentryinfo>
<refmeta >
<refentrytitle > udev_monitor_receive_device</refentrytitle>
<manvolnum > 3</manvolnum>
</refmeta>
<refnamediv >
<refname > udev_monitor_receive_device</refname>
<refname > udev_monitor_enable_receiving</refname>
<refname > udev_monitor_set_receive_buffer_size</refname>
<refname > udev_monitor_get_fd</refname>
<refname > udev_monitor_get_udev</refname>
<refpurpose > Query and modify device monitor</refpurpose>
</refnamediv>
<refsynopsisdiv >
<funcsynopsis >
<funcsynopsisinfo > #include < libudev.h> </funcsynopsisinfo>
<funcprototype >
<funcdef > struct udev_device *<function > udev_monitor_receive_device</function> </funcdef>
<paramdef > struct udev_monitor *<parameter > udev_monitor</parameter> </paramdef>
</funcprototype>
<funcprototype >
<funcdef > int <function > udev_monitor_enable_receiving</function> </funcdef>
<paramdef > struct udev_monitor *<parameter > udev_monitor</parameter> </paramdef>
</funcprototype>
<funcprototype >
<funcdef > int <function > udev_monitor_set_receive_buffer_size</function> </funcdef>
<paramdef > struct udev_monitor *<parameter > udev_monitor</parameter> </paramdef>
<paramdef > int <parameter > size</parameter> </paramdef>
</funcprototype>
<funcprototype >
<funcdef > int <function > udev_monitor_get_fd</function> </funcdef>
<paramdef > struct udev_monitor *<parameter > udev_monitor</parameter> </paramdef>
</funcprototype>
<funcprototype >
<funcdef > struct udev *<function > udev_monitor_get_udev</function> </funcdef>
<paramdef > struct udev_monitor *<parameter > udev_monitor</parameter> </paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<!-- <refsect1>
<title > Description</title>
<para > XXX: Add short description.</para>
</refsect1> -->
<refsect1 >
<title > Return Value</title>
<para > On success,
<function > udev_monitor_receive_device()</function> returns a
pointer to a newly referenced device that was received via the
monitor. The caller is responsible to drop this reference when
done. On failure, <constant > NULL</constant> is returned.</para>
<para > On success,
<function > udev_monitor_enable_receiving()</function> and
<function > udev_monitor_set_receive_buffer_size()</function>
return an integer greater than, or equal to,
<constant > 0</constant> . On failure, a negative error code is
returned.</para>
<para > On success, <function > udev_monitor_get_fd()</function>
returns the file descriptor used by this monitor. On failure,
a negative error code is returned.</para>
<para > <function > udev_monitor_get_udev()</function> always returns
a pointer to the udev context that this monitor is associated
with.</para>
</refsect1>
2023-09-19 11:04:56 +03:00
<refsect1 >
<title > History</title>
<para > <function > udev_monitor_receive_device()</function> ,
<function > udev_monitor_enable_receiving()</function> ,
<function > udev_monitor_set_receive_buffer_size()</function> ,
<function > udev_monitor_get_fd()</function> , and
<function > udev_monitor_get_udev()</function> were added in version 221.</para>
</refsect1>
2015-06-17 16:11:11 +03:00
<refsect1 >
<title > See Also</title>
2023-12-22 21:09:32 +03:00
<para > <simplelist type= "inline" >
<member > <citerefentry > <refentrytitle > udev_new</refentrytitle> <manvolnum > 3</manvolnum> </citerefentry> </member>
<member > <citerefentry > <refentrytitle > udev_device_new_from_syspath</refentrytitle> <manvolnum > 3</manvolnum> </citerefentry> </member>
<member > <citerefentry > <refentrytitle > udev_enumerate_new</refentrytitle> <manvolnum > 3</manvolnum> </citerefentry> </member>
<member > <citerefentry > <refentrytitle > udev_monitor_new_from_netlink</refentrytitle> <manvolnum > 3</manvolnum> </citerefentry> </member>
<member > <citerefentry > <refentrytitle > udev_monitor_filter_update</refentrytitle> <manvolnum > 3</manvolnum> </citerefentry> </member>
<member > <citerefentry > <refentrytitle > udev_list_entry</refentrytitle> <manvolnum > 3</manvolnum> </citerefentry> </member>
<member > <citerefentry > <refentrytitle > systemd</refentrytitle> <manvolnum > 1</manvolnum> </citerefentry> </member>
</simplelist> </para>
2015-06-17 16:11:11 +03:00
</refsect1>
</refentry>