1 package MooseX::Daemonize;
2 use strict; # because Kwalitee is pedantic
4 use MooseX::Types::Path::Class;
9 MooseX::Daemonize::WithPidFile
19 ( my $name = lc $_[0]->meta->name ) =~ s/::/_/g;
25 isa => 'Path::Class::Dir',
30 default => sub { Path::Class::Dir->new('var', 'run') },
34 isa => 'Path::Class::Dir',
39 default => sub { Path::Class::Dir->new('/') },
43 metaclass => 'Getopt',
58 my $file = $self->pidbase . '/' . $self->progname . '.pid';
59 confess "Cannot write to $file" unless (-e $file ? -w $file : -w $self->pidbase);
60 MooseX::Daemonize::Pid::File->new( file => $file );
66 confess "instance already running" if $self->pidfile->is_running;
68 $self->daemonize unless $self->foreground;
70 return unless $self->is_daemon;
72 $self->pidfile->pid($$);
74 # Avoid 'stdin reopened for output'
75 # warning with newer perls
76 open( NULL, '/dev/null' );
82 $self->pidfile->write;
87 # Make _kill *really* private
91 my ( $self, %args ) = @_;
92 my $pid = $self->pidfile->pid;
93 $self->$_kill($pid) unless $self->foreground();
94 $self->pidfile->remove;
95 return 1 if $args{no_exit};
101 $self->stop( no_exit => 1 );
107 $SIG{'INT'} = sub { $self->handle_sigint };
108 $SIG{'HUP'} = sub { $self->handle_sighup };
111 sub handle_sigint { $_[0]->stop; }
112 sub handle_sighup { $_[0]->restart; }
115 my ( $self, $pid ) = @_;
117 unless ( CORE::kill 0 => $pid ) {
119 # warn "$pid already appears dead.";
125 # warn "$pid is us! Can't commit suicide.";
129 my $timeout = $self->stop_timeout;
131 # kill 0 => $pid returns 0 if the process is dead
132 # $!{EPERM} could also be true if we cant kill it (permission error)
134 # Try SIGINT ... 2s ... SIGTERM ... 2s ... SIGKILL ... 3s ... UNDEAD!
135 for ( [ 2, $timeout ], [15, $timeout], [9, $timeout * 1.5] ) {
136 my ($signal, $timeout) = @$_;
137 $timeout = int $timeout;
139 CORE::kill($signal, $pid);
141 last unless CORE::kill 0 => $pid or $!{EPERM};
145 last unless CORE::kill 0 => $pid or $!{EPERM};
150 return unless ( CORE::kill 0 => $pid or $!{EPERM} );
152 # IF it is still running
153 Carp::carp "$pid doesn't seem to want to die."; # AHH EVIL DEAD!
163 MooseX::Daemonize - provides a Role that daemonizes your Moose based
168 This document describes MooseX::Daemonize version 0.04
174 with qw(MooseX::Daemonize);
177 my ( $self, $file ) = @_;
178 open( FILE, ">$file" ) || die;
184 # then in the main package ...
186 my $daemon = FileMaker->new();
188 $daemon->create_file($file);
193 Often you want to write a persistant daemon that has a pid file, and responds
194 appropriately to Signals. This module helps provide the basic infrastructure
201 =item progname Path::Class::Dir | Str
203 The name of our daemon, defaults to $self->meta->name =~ s/::/_/;
205 =item pidbase Path::Class::Dir | Str
207 The base for our bid, defaults to /var/run/$progname
209 =item pidfile MooseX::Daemonize::Pid::File | Str
211 The file we store our PID in, defaults to /var/run/$progname
213 =item foreground Bool
215 If true, the process won't background. Useful for debugging. This option can
216 be set via Getopt's -f.
220 If true, the process is the backgrounded process. This is useful for example
221 in an after 'start' => sub { } block
225 Number of seconds to wait for the process to stop, before trying harder to kill
226 it. Defaults to 2 seconds
236 Setup a pidfile, fork, then setup the signal handlers.
240 Stop the process matching the pidfile, and unlinks the pidfile.
251 Calls daemonize from MooseX::Daemonize::Core.
253 =item setup_signals()
255 Setup the signal handlers, by default it only sets up handlers for SIGINT and SIGHUP
257 =item handle_sigint()
259 Handle a INT signal, by default calls C<$self->stop()>
261 =item handle_sighup()
263 Handle a HUP signal. By default calls C<$self->restart()>
267 The C<meta()> method from L<Class::MOP::Class>
273 =for author to fill in:
274 A list of all the other modules that this module relies upon,
275 including any restrictions on versions, and an indication whether
276 the module is part of the standard Perl distribution, part of the
277 module's distribution, or must be installed separately. ]
279 Obviously L<Moose>, and L<Proc::Daemon>
281 =head1 INCOMPATIBILITIES
283 =for author to fill in:
284 A list of any modules that this module cannot be used in conjunction
285 with. This may be due to name conflicts in the interface, or
286 competition for system or program resources, or due to internal
287 limitations of Perl (for example, many modules that use source code
288 filters are mutually incompatible).
293 =head1 BUGS AND LIMITATIONS
295 =for author to fill in:
296 A list of known problems with the module, together with some
297 indication Whether they are likely to be fixed in an upcoming
298 release. Also a list of restrictions on the features the module
299 does provide: data types that cannot be handled, performance issues
300 and the circumstances in which they may arise, practical
301 limitations on the size of data sets, special cases that are not
304 No bugs have been reported.
306 Please report any bugs or feature requests to
307 C<bug-acme-dahut-call@rt.cpan.org>, or through the web interface at
308 L<http://rt.cpan.org>.
312 L<Proc::Daemon>, L<Daemon::Generic>, L<MooseX::Getopt>
316 Chris Prather C<< <perigrin@cpan.org> >>
320 Mike Boyko, Matt S. Trout, Stevan Little, Brandon Black, Ash Berlin and the
323 Some bug fixes sponsored by Takkle Inc.
325 =head1 LICENCE AND COPYRIGHT
327 Copyright (c) 2007, Chris Prather C<< <perigrin@cpan.org> >>. All rights
330 This module is free software; you can redistribute it and/or
331 modify it under the same terms as Perl itself. See L<perlartistic>.
334 =head1 DISCLAIMER OF WARRANTY
336 BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
337 FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
338 OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
339 PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER
340 EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
341 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE
342 ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH
343 YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL
344 NECESSARY SERVICING, REPAIR, OR CORRECTION.
346 IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
347 WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
348 REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE
349 LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL,
350 OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE
351 THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
352 RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
353 FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
354 SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF