NAME

AnyEvent::Filesys::Notify::Event - Object to report changes in the monitored filesystem

VERSION

version 1.23

SYNOPSIS

    use AnyEvent::Filesys::Notify;

    my $notifier = AnyEvent::Filesys::Notify->new(
        dir      => [ qw( this_dir that_dir ) ],
        interval => 2.0,    # Optional depending on underlying watcher
        cb       => sub {
            my (@events) = @_;

            for my $event (@events){
                process_created_file($event->path)  if $event->is_created;
                process_modified_file($event->path) if $event->is_modified;
                process_deleted_file($event->path)  if $event->is_deleted;
            }
        },
    );

DESCRIPTION

Simple object to encapsulate information about the filesystem modifications.

METHODS

path()

    my $modified_file = $event->path();

Returns the path to the modified file. This is the path as given by the user, ie not modified by abs_path.

type()

    my $modificaiton_type = $event->type();

Returns the type of change made to the file or directory. Will be one of "created", "modified", or "deleted".

is_dir()

    my $is_dir  = $event->is_dir();

Returns a true value if the path is a directory.

is_created()

    do_something($event) if $event->is_created;

True if "$event->type eq 'created'".

is_modified()

    do_something($event) if $event->is_modified;

True if "$event->type eq 'modified'".

is_deleted()

    do_something($event) if $event->is_deleted;

True if "$event->type eq 'deleted'".

AUTHOR

Mark Grimes, <mgrimes@cpan.org>

CONTRIBUTORS

Gasol Wu <gasol.wu@gmail.com> who contributed the BSD support for IO::KQueue
Dave Hayes <dave@jetcafe.org>
Carsten Wolff <carsten@wolffcarsten.de>
Ettore Di Giacinto (@mudler)
Martin Barth (@ufobat)

SOURCE

Source repository is at <https://github.com/mvgrimes/AnyEvent-Filesys-Notify>.

BUGS

Please report any bugs or feature requests on the bugtracker website <http://github.com/mvgrimes/AnyEvent-Filesys-Notify/issues>

When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.

COPYRIGHT AND LICENSE

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.