1 package MooseX::Daemonize;
2 use strict; # because Kwalitee is pedantic
12 with qw(MooseX::Getopt);
20 ( my $name = lc $_[0]->meta->name ) =~ s/::/_/g;
30 default => sub { return '/var/run' },
39 die 'Cannot write to ' . $_[0]->pidbase unless -w $_[0]->pidbase;
40 $_[0]->pidbase . '/' . $_[0]->progname . '.pid';
45 metaclass => 'Getopt',
54 if ( my $pid = $self->get_pid ) {
55 my $prog = $self->progname;
56 if ( CORE::kill 0 => $pid ) {
57 croak "$prog already running ($pid).";
59 carp "$prog not running but $pid exists. Perhaps it is stale?";
72 return if $self->check;
74 $self->daemonize unless $self->foreground;
76 # Avoid 'stdin reopened for output' warning with newer perls
77 open( NULL, '/dev/null' );
87 my $pidfile = $self->pidfile;
88 lock( $pidfile, undef, 'nonblocking' )
89 or croak "Could not lock PID file $pidfile: $!";
90 write_file( $pidfile, "$$\n" );
97 my $pidfile = $self->pidfile;
98 lock( $pidfile, undef, 'nonblocking' )
99 or croak "Could not lock PID file $pidfile: $!";
107 my $pidfile = $self->pidfile;
108 return unless -e $pidfile;
109 chomp( my $pid = read_file($pidfile) );
114 my ( $self, %args ) = @_;
115 my $pid = $self->get_pid;
116 $self->kill($pid) unless $self->foreground();
118 return 1 if $args{no_exit};
124 $self->stop( noexit => 1 );
130 $SIG{INT} = sub { $self->handle_sigint; };
131 $SIG{HUP} = sub { $self->handle_sighup };
134 sub handle_sigint { $_[0]->stop }
135 sub handle_sighup { return; }
138 my ( $self, $pid ) = @_;
139 unless ( CORE::kill 0 => $pid ) {
141 # warn "$pid already appears dead.";
147 # warn "$pid is us! Can't commit suicied.";
151 CORE::kill( 2, $pid ); # Try SIGINT
152 sleep(1) if CORE::kill( 0, $pid );
154 unless ( CORE::kill 0 => $pid or $!{EPERM} ) { # IF it is still running
155 CORE::kill( 15, $pid ); # try SIGTERM
156 sleep(1) if CORE::kill( 0, $pid );
159 unless ( CORE::kill 0 => $pid or $!{EPERM} ) { # IF it is still running
160 CORE::kill( 9, $pid ); # finally try SIGKILL
161 sleep(1) if CORE::kill( 0, $pid );
164 unless ( CORE::kill 0 => $pid or $!{EPERM} ) { # IF it is still running
165 carp "$pid doesn't seem to want to die."; # AHH EVIL DEAD!
176 MooseX::Daemonize - provides a Role that daemonizes your Moose based application.
181 This document describes MooseX::Daemonize version 0.0.1
188 with qw(MooseX::Daemonize);
191 my ( $self, $file ) = @_;
192 open( FILE, ">$file" ) || die;
198 # then in the main package ...
200 my $daemon = FileMaker->new();
202 $daemon->create_file($file);
207 Often you want to write a persistant daemon that has a pid file, and responds appropriately to Signals.
208 This module helps provide the basic infrastructure to do that.
216 The name of our daemon, defaults to $0
220 The base for our bid, defaults to /var/run/$progname
224 The file we store our PID in, defaults to /var/run/$progname/
226 =item foreground Bool
228 If true, the process won't background. Useful for debugging. This option can be set via Getopt's -f.
238 Check to see if an instance is already running.
242 Setup a pidfile, fork, then setup the signal handlers.
246 Stop the process matching the pidfile, and unlinks the pidfile.
257 Calls C<Proc::Daemon::Init> to daemonize this process.
261 Kills the process for $pid. This will try SIGINT, and SIGTERM before falling back to SIGKILL and finally giving up.
263 =item setup_signals()
265 Setup the signal handlers, by default it only sets up handlers for SIGINT and SIGHUP
267 =item handle_sigint()
269 Handle a INT signal, by default calls C<$self->stop()>;
271 =item handle_sighup()
273 Handle a HUP signal. Nothing is done by default.
283 the C<meta()> method from L<Class::MOP::Class>
289 =for author to fill in:
290 A list of all the other modules that this module relies upon,
291 including any restrictions on versions, and an indication whether
292 the module is part of the standard Perl distribution, part of the
293 module's distribution, or must be installed separately. ]
295 Obviously L<Moose>, also L<Carp>, L<Proc::Daemon>, L<File::Flock>, L<File::Slurp>
297 =head1 INCOMPATIBILITIES
299 =for author to fill in:
300 A list of any modules that this module cannot be used in conjunction
301 with. This may be due to name conflicts in the interface, or
302 competition for system or program resources, or due to internal
303 limitations of Perl (for example, many modules that use source code
304 filters are mutually incompatible).
309 =head1 BUGS AND LIMITATIONS
311 =for author to fill in:
312 A list of known problems with the module, together with some
313 indication Whether they are likely to be fixed in an upcoming
314 release. Also a list of restrictions on the features the module
315 does provide: data types that cannot be handled, performance issues
316 and the circumstances in which they may arise, practical
317 limitations on the size of data sets, special cases that are not
320 No bugs have been reported.
322 Please report any bugs or feature requests to
323 C<bug-acme-dahut-call@rt.cpan.org>, or through the web interface at
324 L<http://rt.cpan.org>.
328 L<Proc::Daemon>, L<Daemon::Generic>, L<MooseX::Getopt>
332 Chris Prather C<< <perigrin@cpan.org> >>
335 =head1 LICENCE AND COPYRIGHT
337 Copyright (c) 2007, Chris Prather C<< <perigrin@cpan.org> >>. All rights reserved.
339 This module is free software; you can redistribute it and/or
340 modify it under the same terms as Perl itself. See L<perlartistic>.
343 =head1 DISCLAIMER OF WARRANTY
345 BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
346 FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
347 OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
348 PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER
349 EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
350 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE
351 ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH
352 YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL
353 NECESSARY SERVICING, REPAIR, OR CORRECTION.
355 IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
356 WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
357 REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE
358 LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL,
359 OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE
360 THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
361 RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
362 FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
363 SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF