inotify_init

(PECL inotify >= 0.1.2)

inotify_init — inotify インスタンスを初期化する

説明

inotify_init(): resource|false

inotify_add_watch() で使用するための inotify インスタンスを初期化します。

パラメータ

この関数にはパラメータはありません。

戻り値

ストリームリソース、あるいはエラー時に false を返します。

例

例1 inotify の使用例

<?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);

?>

上の例の出力は、たとえば以下のようになります。

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)
  ),
);

参考

inotify_add_watch() - 初期化済みの inotify インスタンスに監視対象を追加する
inotify_rm_watch() - 既存の監視を inotify インスタンスから削除する
inotify_queue_len() - 待機中のイベントがある場合に正の数を返す
inotify_read() - inotify インスタンスからイベントを読み込む
fclose() - オープンされたファイルポインタをクローズする