MooseX::Daemonize::WithPidFile - A Role with the core daemonization and pidfile management


MooseX-Daemonize documentation Contained in the MooseX-Daemonize distribution.

Index


Code Index:

NAME

Top

MooseX::Daemonize::WithPidFile - A Role with the core daemonization and pidfile management

SYNOPSIS

Top

  package My::Daemon;
  use Moose;

  with 'MooseX::Daemonize::WithPidFile';

  sub start {
      my $self = shift;
      # daemonize me ...
      $self->daemonize; # << this will write the pidfile for you
      # return from the parent,...
      return unless $self->is_daemon;
      # but continue on in the child (daemon)
  }

DESCRIPTION

Top

This is a slightly extended basic daemonization Role, it provides Pidfile management along with the core daemonization features found in MooseX::Daemonize::Core.

ATTRIBUTES

Top

pidfile (is = rw, isa => MooseX::Daemonize::Pid::File)>

This attribute holds the MooseX::Daemonize::Pid::File object used to manage the Pidfile. It will initialize the object using the init_pidfile method (which is required by this role).

REQUIRED METHODS

Top

init_pidfile

This method is used to build the pidfile attribute's object. It should return a MooseX::Daemonize::Pid::File object.

has_pidfile

This is a predicate method to tell you if your pidfile attribute has been initialized yet.

METHODS

Top

daemonize

This adds an after method modifier to the daemonize method (from MooseX::Daemonize::Core) and handles writing your Pidfile for you.

meta

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

DEPENDENCIES

Top

Moose::Role, MooseX::Getopt and MooseX::Daemonize::Pid::File

INCOMPATIBILITIES

Top

None reported.

BUGS AND LIMITATIONS

Top

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.

AUTHOR

Top

Stevan Little <stevan.little@iinteractive.com>

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.


MooseX-Daemonize documentation Contained in the MooseX-Daemonize distribution.

package MooseX::Daemonize::WithPidFile;
use strict;         # cause Perl::Critic errors are annoying
use MooseX::Getopt; # to load the Getopt metaclass
use Moose::Role;
our $VERSION   = '0.12';


use MooseX::Daemonize::Pid::File;

with 'MooseX::Daemonize::Core';

requires 'init_pidfile';

has pidfile => (
    # NOTE:
    # this should always be accessible
    # from the command line IMO
    # - SL
    metaclass => 'Getopt',
    isa       => 'MooseX::Daemonize::Pid::File',
    is        => 'rw',
    lazy      => 1,
    coerce    => 1,
    predicate => 'has_pidfile',
    builder   => 'init_pidfile',
);

after 'daemonize' => sub {
    my $self = shift;
    # NOTE:
    # make sure that we do not have
    # any bad PID values stashed around
    # - SL
    $self->pidfile->clear_pid;
    if ($self->is_daemon) {
        $self->pidfile->write;
    }
};

1;

__END__