inotify-init.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 37da852aa1f9b754fed577897efa509ef4d578e5 Maintainer: takagi Status: ready -->

<refentry xml:id="function.inotify-init" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>inotify_init</refname>
  <refpurpose>inotify インスタンスを初期化する</refpurpose>
 </refnamediv>
 
 <refsect1 role="description"><!-- {{{ -->
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>resource</type><type>false</type></type><methodname>inotify_init</methodname>
   <void />
  </methodsynopsis>
  <para>
   <function>inotify_add_watch</function> で使用するための
   inotify インスタンスを初期化します。
  </para>
 </refsect1><!-- }}} -->
 
 <refsect1 role="parameters">
  &reftitle.parameters;
  &no.function.parameters;
 </refsect1>

 <refsect1 role="returnvalues"><!-- {{{ -->
  &reftitle.returnvalues;
  <para>
   ストリームリソース、あるいはエラー時に &false; を返します。
  </para>
 </refsect1><!-- }}} -->
 
 <refsect1 role="examples"><!-- {{{ -->
  &reftitle.examples;
  <para>
   <example xml:id="inotify-init.example.basic"><!-- {{{ -->
    <title>inotify の使用例</title>
    <programlisting role="php">
<![CDATA[
<?php
// inotify インスタンスを開きます
$fd = inotify_init();

// __FILE__ のメタデータ (変更時刻など) の変更を監視します
$watch_descriptor = inotify_add_watch($fd, __FILE__, IN_ATTRIB);

// イベントを発生させます
touch(__FILE__);

// イベントを読み込みます
$events = inotify_read($fd);
print_r($events);

// 以下の方法を使うと、inotify_read() でブロックせずに inotify 関数を使用できます

// - stream_select() を $fd で使用します
$read = array($fd);
$write = null;
$except = null;
stream_select($read,$write,$except,0);

// - stream_set_blocking() を $fd で使用します
stream_set_blocking($fd, 0);
inotify_read($fd); // ブロックしません。待ち状態のイベントがなければ false を返します

// - inotify_queue_len() を使用して、イベントキューが空でないかどうかを調べます
$queue_len = inotify_queue_len($fd); // If > 0, inotify_read() will not block

// __FILE__ のメタデータ変更の監視を終了します
inotify_rm_watch($fd, $watch_descriptor);

// inotify インスタンスを閉じます
// 未完了の監視があれば、それらもすべて閉じられます
fclose($fd);

?>
]]>
    </programlisting>
    &example.outputs.similar;
    <screen>
<![CDATA[
array(
  array(
    'wd' => 1,     // Equals $watch_descriptor
    'mask' => 4,   // IN_ATTRIB bit is set
    'cookie' => 0, // unique id to connect related events (e.g. 
                   // IN_MOVE_FROM and IN_MOVE_TO events)
    'name' => '',  // the name of a file (e.g. if we monitored changes
                   // in a directory)
  ),
);
]]>
    </screen>
   </example><!-- }}} -->
  </para>
 </refsect1><!-- }}} -->
 
 <refsect1 role="seealso"><!-- {{{ -->
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>inotify_add_watch</function></member>
    <member><function>inotify_rm_watch</function></member>
    <member><function>inotify_queue_len</function></member>
    <member><function>inotify_read</function></member>
    <member><function>fclose</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
-->