PHP 8.4.0 RC4 available for testing

    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() - オープンされたファイルポインタをクローズする

    Improve This Page

    Learn How To Improve This Page • Submit a Pull Request • Report a Bug
    ＋add a note

    User Contributed Notes 1 note

    up
    11
    david dot schueler at tel-billig dot de
    13 years ago
    Example for tailing a file (like tail -f) using inotify.
    <?php
    /**
    * Tail a file (UNIX only!)
    * Watch a file for changes using inotify and return the changed data
    *
    * @param string $file - filename of the file to be watched
    * @param integer $pos - actual position in the file
    * @return string
    */
    function tail($file,&$pos) {
    // get the size of the file
    if(!$pos) $pos = filesize($file);
    // Open an inotify instance
    $fd = inotify_init();
    // Watch $file for changes.
    $watch_descriptor = inotify_add_watch($fd, $file, IN_ALL_EVENTS);
    // Loop forever (breaks are below)
    while (true) {
    // Read events (inotify_read is blocking!)
    $events = inotify_read($fd);
    // Loop though the events which occured
    foreach ($events as $event=>$evdetails) {
    // React on the event type
    switch (true) {
    // File was modified
    case ($evdetails['mask'] & IN_MODIFY):
    // Stop watching $file for changes
    inotify_rm_watch($fd, $watch_descriptor);
    // Close the inotify instance
    fclose($fd);
    // open the file
    $fp = fopen($file,'r');
    if (!    $fp) return false;
    // seek to the last EOF position
    fseek($fp,$pos);
    // read until EOF
    while (!feof($fp)) {
    $buf .= fread($fp,8192);
    }
    // save the new EOF to $pos
    $pos = ftell($fp); // (remember: $pos is called by reference)
    // close the file pointer
    fclose($fp);
    // return the new data and leave the function
    return $buf;
    // be a nice guy and program good code ;-)
    break;

    // File was moved or deleted
    case ($evdetails['mask'] & IN_MOVE):
    case (    $evdetails['mask'] & IN_MOVE_SELF):
    case (    $evdetails['mask'] & IN_DELETE):
    case (    $evdetails['mask'] & IN_DELETE_SELF):
    // Stop watching $file for changes
    inotify_rm_watch($fd, $watch_descriptor);
    // Close the inotify instance
    fclose($fd);
    // Return a failure
    return false;
    break;
    }
    }
    }
    }

    // Use it like that:
    $lastpos = 0;
    while (    true) {
    echo     tail($file,$lastpos);
    }
    ?>
    ＋add a note
    To Top