The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
POE-Component-DirWatch-WithCaller-1.00
River stage zero No dependents
++
/ POE::Component::DirWatch::WithCaller

NAME

POE::Component::DirWatch::WithCaller - An extension to POE::Component::DirWatch to pass through the name of the calling DirWatch instance, useful for cases where DirWatch sessions may be dynamically created while sharing callback functions whose behaviour may differ in small ways depending on the caller.

VERSION

Version 1.00

SYNOPSIS

Somewhat simple extension to POE::Component::DirWatch that passes the name of the calling DirWatch session to callback functions.

        sub filter { my ($caller,$file) = @_; return 1; }
        sub file { my ($caller,$file) = @_; }
        my $monitor = POE::Component::DirWatch::WithCaller->new(
                alias                   => 'mymonitor',
                directory               => '/my/path',
                filter                  => \&filter,
                file_callback   => \&file,
                interval                => 5,
        );

Filtering already-seen files can be achieved as such:

        sub filter { my ($caller,$file) = @_; return 1; }
        sub file { my ($caller,$file) = @_; }
        my $monitor = POE::Component::DirWatch::WithCaller->new(
                alias                   => 'mymonitor',
                directory               => '/my/path',
                filter                  => \&filter,
                file_callback   => \&file,
                interval                => 5,
                ignore_seen             => 1,
        );

In some instances, using ignore_seen may result in some files being internally marked as 'seen' without being filtered or sent through callbacks, see below.

FILTERING PREVIOUSLY-SEEN FILES

Depending on use case, it may be beneficial or necessary to filter out previously-seen files, either for performance reasons when monitoring highly populous directories for specific files, or for avoiding reprocessing files in the event that they are left in the directory after initial processing. In this case, simply specifying ignore_seen => 1 as a named argument when creating the DirWatch::WithCaller object will enable this behaviour. While testing this feature, however, it was observed that some edge cases exist in which a file will be considered 'seen' when it has not been processed despite matching a defined monitor. To account for this, each file that has been considered 'seen' will be reprocessed once around 120 seconds after it was first 'seen'. This behaviour may not be desirable, and as such is disabled by default, and can be enabled by specifying ensure_seen => 1 when creating the object.

AUTHOR

Matthew Connelly, <maff at cpan.org>

BUGS

Please report any bugs or feature requests to bug-poe-component-dirwatch-withcaller at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=POE-Component-DirWatch-WithCaller. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT

You can find documentation for this module with the perldoc command.

    perldoc POE::Component::DirWatch::WithCaller

You can also look for information at:

ACKNOWLEDGEMENTS

Guillermo Roditi, <groditi@cpan.org> Robert Rothenberg, <rrwo@cpan.org>

SEE ALSO

POE::Component::DirWatch, POE::Component::DirWatch::Object::NewFile

LICENSE AND COPYRIGHT

Copyright 2015 Matthew Connelly.

This program is free software; you can redistribute it and/or modify it under the terms of the the Artistic License (2.0). You may obtain a copy of the full license at:

http://www.perlfoundation.org/artistic_license_2_0

Any use, modification, and distribution of the Standard or Modified Versions is governed by this Artistic License. By using, modifying or distributing the Package, you accept this license. Do not use, modify, or distribute the Package, if you do not accept this license.

If your Modified Version has been derived from a Modified Version made by someone other than you, you are nevertheless required to ensure that your Modified Version complies with the requirements of this license.

This license does not grant you the right to use any trademark, service mark, tradename, or logo of the Copyright Holder.

This license includes the non-exclusive, worldwide, free-of-charge patent license to make, have made, use, offer to sell, sell, import and otherwise transfer the Package with respect to any patent claims licensable by the Copyright Holder that are necessarily infringed by the Package. If you institute patent litigation (including a cross-claim or counterclaim) against any party alleging that the Package constitutes direct or contributory patent infringement, then this Artistic License to you shall terminate on the date that such litigation is filed.

Disclaimer of Warranty: THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS IS' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES. THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY YOUR LOCAL LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR CONTRIBUTOR WILL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.