<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->

<refentry xml:id="function.inotify-read" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>inotify_read</refname>
  <refpurpose>Read events from an inotify instance</refpurpose>
 </refnamediv>
 
 <refsect1 role="description"><!-- {{{ -->
  &reftitle.description;
  <methodsynopsis>
   <type>array</type><methodname>inotify_read</methodname>
   <methodparam><type>resource</type><parameter>inotify_instance</parameter></methodparam>
  </methodsynopsis>
  <para>
   Read inotify events from an inotify instance.
  </para>
 </refsect1><!-- }}} -->
 
 <refsect1 role="parameters"><!-- {{{ -->
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>inotify_instance</parameter></term>
     <listitem>
      <para>
       &inotify.instance.description;
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1><!-- }}} -->
 
 <refsect1 role="returnvalues"><!-- {{{ -->
  &reftitle.returnvalues;
  <para>
   An array of inotify events or &false; if no events was pending and
   <parameter>inotify_instance</parameter> is non-blocking. Each event is an array with the following keys:
   <simplelist>
    <member>wd is a watch descriptor returned by
     <function>inotify_add_watch</function></member>
    <member>mask is a bit mask of <link linkend="inotify.constants">events</link></member>
    <member>cookie is a unique id to connect related events (e.g. <constant>IN_MOVE_FROM</constant>
     and <constant>IN_MOVE_TO</constant>)</member>
    <member>name is the name of a file (e.g. if a file was modified in a
     watched directory)</member>
   </simplelist>
  </para>
 </refsect1><!-- }}} -->
 
 <refsect1 role="seealso"><!-- {{{ -->
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>inotify_init</function></member>
    <member><function>stream_select</function></member>
    <member><function>stream_set_blocking</function></member>
    <member><function>inotify_queue_len</function></member>
   </simplelist>
  </para>
 </refsect1><!-- }}} -->

</refentry>
 
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

