1 package MooseX::Daemonize;
2 use strict; # because Kwalitee is pedantic
4 use MooseX::Types::Path::Class;
5 use Moose::Util::TypeConstraints;
11 use MooseX::Daemonize::PidFile;
13 with qw(MooseX::Getopt);
21 ( my $name = lc $_[0]->meta->name ) =~ s/::/_/g;
27 isa => 'Path::Class::Dir',
32 default => sub { Path::Class::Dir->new('/') },
36 isa => 'Path::Class::Dir',
41 default => sub { Path::Class::Dir->new('var', 'run') },
44 coerce 'MooseX::Daemonize::PidFile'
46 => via { MooseX::Daemonize::PidFile->new( file => $_ ) };
49 isa => 'MooseX::Daemonize::PidFile',
54 predicate => 'has_pidfile',
56 my $file = $_[0]->pidbase . '/' . $_[0]->progname . '.pid';
57 confess "Cannot write to $file" unless (-e $file ? -w $file : -w $_[0]->pidbase);
58 MooseX::Daemonize::PidFile->new( file => $file );
63 remove_pid => 'remove',
69 metaclass => 'Getopt',
90 return if Proc::Daemon::Fork;
98 confess "instance already running" if $self->check;
100 $self->daemonize unless $self->foreground;
102 return unless $self->is_daemon;
104 $self->pidfile->pid($$);
106 # Avoid 'stdin reopened for output' warning with newer perls
108 open( NULL, '/dev/null' );
113 chdir $self->basedir;
116 $self->setup_signals;
120 # Make _kill *really* private
124 my ( $self, %args ) = @_;
125 my $pid = $self->get_pid;
126 $self->$_kill($pid) unless $self->foreground();
128 return 1 if $args{no_exit};
134 $self->stop( no_exit => 1 );
140 $SIG{INT} = sub { $self->handle_sigint; };
141 $SIG{HUP} = sub { $self->handle_sighup };
144 sub handle_sigint { $_[0]->stop; }
145 sub handle_sighup { $_[0]->restart; }
148 my ( $self, $pid ) = @_;
150 unless ( CORE::kill 0 => $pid ) {
152 # warn "$pid already appears dead.";
158 # warn "$pid is us! Can't commit suicide.";
162 my $timeout = $self->stop_timeout;
164 # kill 0 => $pid returns 0 if the process is dead
165 # $!{EPERM} could also be true if we cant kill it (permission error)
167 # Try SIGINT ... 2s ... SIGTERM ... 2s ... SIGKILL ... 3s ... UNDEAD!
168 for ( [ 2, $timeout ], [15, $timeout], [9, $timeout * 1.5] ) {
169 my ($signal, $timeout) = @$_;
170 $timeout = int $timeout;
172 CORE::kill($signal, $pid);
174 last unless CORE::kill 0 => $pid or $!{EPERM};
178 last unless CORE::kill 0 => $pid or $!{EPERM};
183 return unless ( CORE::kill 0 => $pid or $!{EPERM} );
185 # IF it is still running
186 carp "$pid doesn't seem to want to die."; # AHH EVIL DEAD!
194 MooseX::Daemonize - provides a Role that daemonizes your Moose based
199 This document describes MooseX::Daemonize version 0.04
205 with qw(MooseX::Daemonize);
208 my ( $self, $file ) = @_;
209 open( FILE, ">$file" ) || die;
215 # then in the main package ...
217 my $daemon = FileMaker->new();
219 $daemon->create_file($file);
224 Often you want to write a persistant daemon that has a pid file, and responds
225 appropriately to Signals. This module helps provide the basic infrastructure
232 =item progname Path::Class::Dir | Str
234 The name of our daemon, defaults to $self->meta->name =~ s/::/_/;
236 =item pidbase Path::Class::Dir | Str
238 The base for our bid, defaults to /var/run/$progname
240 =item pidfile MooseX::Daemonize::PidFile | Str
242 The file we store our PID in, defaults to /var/run/$progname
244 =item foreground Bool
246 If true, the process won't background. Useful for debugging. This option can
247 be set via Getopt's -f.
251 If true, the process is the backgrounded process. This is useful for example
252 in an after 'start' => sub { } block
256 Number of seconds to wait for the process to stop, before trying harder to kill
257 it. Defaults to 2 seconds
267 Check to see if an instance is already running.
271 Setup a pidfile, fork, then setup the signal handlers.
275 Stop the process matching the pidfile, and unlinks the pidfile.
286 Calls C<Proc::Daemon::Init> to daemonize this process.
288 =item setup_signals()
290 Setup the signal handlers, by default it only sets up handlers for SIGINT and SIGHUP
292 =item handle_sigint()
294 Handle a INT signal, by default calls C<$self->stop()>
296 =item handle_sighup()
298 Handle a HUP signal. By default calls C<$self->restart()>
302 Lookup the pid from our pidfile.
306 Save the current pid in our pidfile
314 The C<meta()> method from L<Class::MOP::Class>
320 =for author to fill in:
321 A list of all the other modules that this module relies upon,
322 including any restrictions on versions, and an indication whether
323 the module is part of the standard Perl distribution, part of the
324 module's distribution, or must be installed separately. ]
326 Obviously L<Moose>, and L<Proc::Daemon>
328 =head1 INCOMPATIBILITIES
330 =for author to fill in:
331 A list of any modules that this module cannot be used in conjunction
332 with. This may be due to name conflicts in the interface, or
333 competition for system or program resources, or due to internal
334 limitations of Perl (for example, many modules that use source code
335 filters are mutually incompatible).
340 =head1 BUGS AND LIMITATIONS
342 =for author to fill in:
343 A list of known problems with the module, together with some
344 indication Whether they are likely to be fixed in an upcoming
345 release. Also a list of restrictions on the features the module
346 does provide: data types that cannot be handled, performance issues
347 and the circumstances in which they may arise, practical
348 limitations on the size of data sets, special cases that are not
351 No bugs have been reported.
353 Please report any bugs or feature requests to
354 C<bug-acme-dahut-call@rt.cpan.org>, or through the web interface at
355 L<http://rt.cpan.org>.
359 L<Proc::Daemon>, L<Daemon::Generic>, L<MooseX::Getopt>
363 Chris Prather C<< <perigrin@cpan.org> >>
367 Mike Boyko, Matt S. Trout, Stevan Little, Brandon Black, Ash Berlin and the
370 Some bug fixes sponsored by Takkle Inc.
372 =head1 LICENCE AND COPYRIGHT
374 Copyright (c) 2007, Chris Prather C<< <perigrin@cpan.org> >>. All rights
377 This module is free software; you can redistribute it and/or
378 modify it under the same terms as Perl itself. See L<perlartistic>.
381 =head1 DISCLAIMER OF WARRANTY
383 BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
384 FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
385 OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
386 PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER
387 EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
388 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE
389 ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH
390 YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL
391 NECESSARY SERVICING, REPAIR, OR CORRECTION.
393 IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
394 WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
395 REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE
396 LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL,
397 OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE
398 THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
399 RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
400 FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
401 SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF