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