man/udev_monitor_receive_device.xml

   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" >
   5 %entities;
   6 ]>
   7
   8 <!--
   9   SPDX-License-Identifier: LGPL-2.1+
  10 -->
  11
  12 <refentry id="udev_monitor_receive_device"
  13   xmlns:xi="http://www.w3.org/2001/XInclude">
  14
  15   <refentryinfo>
  16     <title>udev_monitor_receive_device</title>
  17     <productname>systemd</productname>
  18   </refentryinfo>
  19
  20   <refmeta>
  21     <refentrytitle>udev_monitor_receive_device</refentrytitle>
  22     <manvolnum>3</manvolnum>
  23   </refmeta>
  24
  25   <refnamediv>
  26     <refname>udev_monitor_receive_device</refname>
  27     <refname>udev_monitor_enable_receiving</refname>
  28     <refname>udev_monitor_set_receive_buffer_size</refname>
  29     <refname>udev_monitor_get_fd</refname>
  30     <refname>udev_monitor_get_udev</refname>
  31
  32     <refpurpose>Query and modify device monitor</refpurpose>
  33   </refnamediv>
  34
  35   <refsynopsisdiv>
  36     <funcsynopsis>
  37       <funcsynopsisinfo>#include &lt;libudev.h&gt;</funcsynopsisinfo>
  38
  39       <funcprototype>
  40         <funcdef>struct udev_device *<function>udev_monitor_receive_device</function></funcdef>
  41         <paramdef>struct udev_monitor *<parameter>udev_monitor</parameter></paramdef>
  42       </funcprototype>
  43
  44       <funcprototype>
  45         <funcdef>int <function>udev_monitor_enable_receiving</function></funcdef>
  46         <paramdef>struct udev_monitor *<parameter>udev_monitor</parameter></paramdef>
  47       </funcprototype>
  48
  49       <funcprototype>
  50         <funcdef>int <function>udev_monitor_set_receive_buffer_size</function></funcdef>
  51         <paramdef>struct udev_monitor *<parameter>udev_monitor</parameter></paramdef>
  52         <paramdef>int <parameter>size</parameter></paramdef>
  53       </funcprototype>
  54
  55       <funcprototype>
  56         <funcdef>int <function>udev_monitor_get_fd</function></funcdef>
  57         <paramdef>struct udev_monitor *<parameter>udev_monitor</parameter></paramdef>
  58       </funcprototype>
  59
  60       <funcprototype>
  61         <funcdef>struct udev *<function>udev_monitor_get_udev</function></funcdef>
  62         <paramdef>struct udev_monitor *<parameter>udev_monitor</parameter></paramdef>
  63       </funcprototype>
  64
  65     </funcsynopsis>
  66   </refsynopsisdiv>
  67
  68   <!--<refsect1>
  69     <title>Description</title>
  70
  71     <para>XXX: Add short description.</para>
  72   </refsect1>-->
  73
  74   <refsect1>
  75     <title>Return Value</title>
  76
  77     <para>On success,
  78     <function>udev_monitor_receive_device()</function> returns a
  79     pointer to a newly referenced device that was received via the
  80     monitor. The caller is responsible to drop this reference when
  81     done. On failure, <constant>NULL</constant> is returned.</para>
  82
  83     <para>On success,
  84     <function>udev_monitor_enable_receiving()</function> and
  85     <function>udev_monitor_set_receive_buffer_size()</function>
  86     return an integer greater than, or equal to,
  87     <constant>0</constant>. On failure, a negative error code is
  88     returned.</para>
  89
  90     <para>On success, <function>udev_monitor_get_fd()</function>
  91     returns the file descriptor used by this monitor. On failure,
  92     a negative error code is returned.</para>
  93
  94     <para><function>udev_monitor_get_udev()</function> always returns
  95     a pointer to the udev context that this monitor is associated
  96     with.</para>
  97   </refsect1>
  98
  99   <refsect1>
 100     <title>See Also</title>
 101
 102     <para>
 103       <citerefentry><refentrytitle>udev_new</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
 104       <citerefentry><refentrytitle>udev_device_new_from_syspath</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
 105       <citerefentry><refentrytitle>udev_enumerate_new</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
 106       <citerefentry><refentrytitle>udev_monitor_new_from_netlink</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
 107       <citerefentry><refentrytitle>udev_monitor_filter_update</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
 108       <citerefentry><refentrytitle>udev_list_entry</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
 109       <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 110     </para>
 111   </refsect1>
 112
 113 </refentry>