File::PidSimple - Handle and create pidfiles easy


File-PidSimple documentation  | view source Contained in the File-PidSimple distribution.

Index


NAME

Top

File::PidSimple - Handle and create pidfiles easy

VERSION

Top

This document describes File::PidSimple version 0.05

SYNOPSIS

Top

    use File::PidSimple;

  # create a pid object, but do not write anything
  my $pid = File::PidSimple->new( piddir => File::Spec->tmpdir );

  # exit if we runnig already
  exit 0 if ( $pid->running );
  $pid->write;




  my $pid = File::PidSimple->new( piddir => File::Spec->tmpdir )->write_unless_running;
  exit 0 unless $pid;

  # for a daemon this is enough
  File::PidSimple->new->write_unless_running || exit 0;

DESCRIPTION

Top

This module make the handling of pidfiles simple.

INTERFACE

Top

pidfile_name

  filename of the pidfiles.

piddir

return the directory, where the pidfile is stored

see new to set the piddir

new

  piddir         ( default => '/var/run' )
  progname       default basename($0)

running

write

writes a new pidfile. by default with the actual pid ( $$ ) or with

$pidfile->write

$pidfile->write(1234); # force to write

write_unless_running

write the pidfile, but only if no old pidfile exists, or the process described in the old pidfile is not running anymore

progname

progname ( basename )

remove

remove the pidfile

DIAGNOSTICS

Top

This module Croak on fatal errors. Thats any failed IO operation on the pidfiles. open, close and print.

CONFIGURATION AND ENVIRONMENT

Top

File::PidSimple requires no configuration files or environment variables.

DEPENDENCIES

Top

only core modules

  Carp
  File::Basename
  File::Spec




INCOMPATIBILITIES

Top

None reported.

BUGS AND LIMITATIONS

Top

No bugs have been reported.

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

AUTHOR

Top

Boris Zentner <bzm@2bz.de>

LICENCE AND COPYRIGHT

Top

DISCLAIMER OF WARRANTY

Top

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.


File-PidSimple documentation  | view source Contained in the File-PidSimple distribution.