Dave Rolsky > File-ChangeNotify-0.23 > File::ChangeNotify::Watcher



Annotate this POD


Open  4
Stalled  1
View/Report Bugs
Module Version: 0.23   Source   Latest Release: File-ChangeNotify-0.26


File::ChangeNotify::Watcher - Base class for all watchers


version 0.23


    my $watcher =
            ( directories => [ '/my/path', '/my/other' ],
              filter      => qr/\.(?:pm|conf|yml)$/,
              exclude     => ['t', 'root', qr(/(?!\.)[^/]+$)],

    if ( my @events = $watcher->new_events() ) { ... }

    # blocking
    while ( my @events = $watcher->wait_for_events() ) { ... }


A File::ChangeNotify::Watcher class monitors a directory for changes made to any file. You can provide a regular expression to filter out files you are not interested in. It handles the addition of new subdirectories by adding them to the watch list.

Note that the actual granularity of what each watcher subclass reports may vary across subclasses. Implementations that hook into some sort of kernel event interface (Inotify, for example) have much better knowledge of exactly what changes are happening than one implemented purely in userspace code (like the Default subclass).

By default, events are returned in the form File::ChangeNotify::Event objects, but this can be overridden by providing an "event_class" attribute to the constructor.

The watcher can operate in a blocking/callback style, or you can simply ask it for a list of new events as needed.



This method creates a new watcher. It accepts the following arguments:


This method causes the watcher to block until it sees interesting events, and then return them as a list.

Some watcher subclasses may implement blocking as a sleep loop, while others may actually block.


This method returns a list of any interesting events seen since the last time the watcher checked.


If this is true, the watcher will report on all events.

Some watchers, like the Default subclass, are not smart enough to track things like a file being created and then immediately deleted, and can only detect changes between snapshots of the file system.

Other watchers, like the Inotify subclass, see all events that happen and report on them.


Dave Rolsky <autarch@urth.org>


This software is Copyright (c) 2013 by Dave Rolsky.

This is free software, licensed under:

  The Artistic License 2.0 (GPL Compatible)
syntax highlighting: