/ 
MooseX-Daemonize-0.04
River stage two • 9 direct dependents • 16 total dependents
/ MooseX::Daemonize

NAME

MooseX::Daemonize - provides a Role that daemonizes your Moose based application.

VERSION

This document describes MooseX::Daemonize version 0.04

SYNOPSIS

package FileMaker;
use Moose;
with qw(MooseX::Daemonize);

sub create_file {
    my ( $self, $file ) = @_;
    open( FILE, ">$file" ) || die;
    close(FILE);
}

no Moose;

# then in the main package ... 

my $daemon = FileMaker->new();
$daemon->start();
$daemon->create_file($file);
$daemon->stop();

DESCRIPTION

Often you want to write a persistant daemon that has a pid file, and responds appropriately to Signals. This module helps provide the basic infrastructure to do that.

ATTRIBUTES

progname Str

The name of our daemon, defaults to $self->meta->name =~ s/::/_/;

pidbase Str

The base for our bid, defaults to /var/run/$progname

pidfile Str

The file we store our PID in, defaults to /var/run/$progname/

foreground Bool

If true, the process won't background. Useful for debugging. This option can be set via Getopt's -f.

is_daemon Bool

If true, the process is the backgrounded process. This is useful for example in an after 'start' => sub { } block

METHODS

check()

Check to see if an instance is already running.

start()

Setup a pidfile, fork, then setup the signal handlers.

stop()

Stop the process matching the pidfile, and unlinks the pidfile.

restart()

Litterally

$self->stop();
$self->start();
daemonize()

Calls Proc::Daemon::Init to daemonize this process.

kill($pid)

Kills the process for $pid. This will try SIGINT, and SIGTERM before falling back to SIGKILL and finally giving up.

setup_signals()

Setup the signal handlers, by default it only sets up handlers for SIGINT and SIGHUP

handle_sigint()

Handle a INT signal, by default calls $self-stop()>

handle_sighup()

Handle a HUP signal. By default calls $self-restart()>

get_pid

Lookup the pid from our pidfile.

save_pid

Save the current pid in our pidfile

remove_pid

Delete our pidfile

meta()

The meta() method from Class::MOP::Class

DEPENDENCIES

Obviously Moose, also Carp, Proc::Daemon, File::Pid

INCOMPATIBILITIES

None reported.

BUGS AND LIMITATIONS

No bugs have been reported.

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

SEE ALSO

Proc::Daemon, Daemon::Generic, MooseX::Getopt

AUTHOR

Chris Prather <perigrin@cpan.org>

THANKS

Mike Boyko, Matt S. Trout, Stevan Little, Brandon Black, dec, and the #moose denzians

LICENCE AND COPYRIGHT

Copyright (c) 2007, Chris Prather <perigrin@cpan.org>. 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.