NAME

Unix::PID::Tiny - Subset of Unix::PID functionality with smaller memory footprint

VERSION

This document describes Unix::PID::Tiny version 0.95.

SYNOPSIS

    use Unix::PID::Tiny;
    my $pid = Unix::PID::Tiny->new();

    print Dumper( $pid->pid_info_hash( $misc_pid ) );

    if ($pid->is_pid_running($misc_pid)) {
        $pid->kill( $misc_pid ) or die "Could not stop $misc_pid";
    }

DESCRIPTION

Like Unix::PID but supplies only a few key functions.

INTERFACE

new([$args_hr])

See Unix::PID's new(). The following options can be provided in the optional HASH, $args_hr, to enable certain extensions:

keep_open

When a true value is provided, PID files created with pid_file() will remain open.

check_proc_open_fds

When a true value is provided, this option will cause is_pidfile_running() to traverse /proc/$pid/fd to ensure a current file descriptor is held by a given process for the specified PID file.

This option is only useful when the PID in the pidfile still holds an open file descriptor to the pid file. If it does not then this will always return false.

To accomplish this in processes that use pid_file() you must create the Unix::PID::Tiny object w/ keep_open set to true.

kill()

See Unix::PID's kill()

pid_info_hash()

See Unix::PID's pid_info_hash()

is_pid_running($pid_file, [$since])

See Unix::PID's is_pid_running(). The optional argument $since may be provided, which will cause this function to not return true if the mtime of $pid_file is earlier than the value provided in $since.

pid file related

get_pid_from_pidfile()

See Unix::PID's get_pid_from_pidfile()

is_pidfile_running()

See Unix::PID's is_pidfile_running()

pid_file()

See Unix::PID's pid_file()

The "retry" configuration can also be hash ref w/ the optional keys:

num_of_passes

This number corresponds to the the array ref version’s “first item”. Defaults to 3.

passes_config

This array ref corresponds to the the array ref version’s “additional arguments”. Defaults to [1,2].

pid_file_no_unlink()

See Unix::PID's pid_file_no_unlink()

pid_file_no_cleanup()

Alias of pid_file_no_unlink(). Some folks like this name better.

_raw_ps()

See Unix::PID's _raw_ps()

If $self->{'ps_path'} is ever set to anything invalid at any point it is simply not used and 'ps' by itself will be used.

DIAGNOSTICS

See Unix::PID's DIAGNOSTICS

CONFIGURATION AND ENVIRONMENT

Unix::PID::Tiny requires no configuration files or environment variables.

DEPENDENCIES

None.

INCOMPATIBILITIES

None reported.

BUGS AND LIMITATIONS

No bugs have been reported.

Please report any bugs or feature requests to bug-unix-pid-tiny@rt.cpan.org, or through the web interface at http://rt.cpan.org.

AUTHOR

Daniel Muey <http://drmuey.com/cpan_contact.pl>

LICENCE AND COPYRIGHT

Copyright (c) 2008, Daniel Muey <http://drmuey.com/cpan_contact.pl>. All rights reserved.

This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See perlartistic.

DISCLAIMER OF WARRANTY

BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR, OR CORRECTION.

IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

cpanm Unix::PID::Tiny

perl -MCPAN -e shell
install Unix::PID::Tiny