NAME
App::CLI::Plugin::Proc::PID::File - for App::CLI::Extension pidfile plugin module
VERSION
1.3
SYNOPSIS
# MyApp.pm
package MyApp;
use strict;
use base qw(App::CLI::Extension);
# extension method
__PACKAGE__->load_plugins(qw(Proc::PID::File));
# extension method
__PACKAGE__->config( proc_pid_file => { verify => 1, dir => "/var/run", name => "myapp" } );
1;
# MyApp/Hello.pm
package MyApp::Hello;
use strict;
use feature ":5.10.0";
use base qw(App::CLI::Command);
sub run {
my($self, @args) = @_;
# make pid file (/var/run/myapp.pid)
# /var/run/myapp.pid is automatically deleted (by Proc::PID::File::DESTROY)
$self->pf->touch;
}DESCRIPTION
App::CLI::Extension pidfile plugin module
pf method setting
__PACKAGE__->config( proc_pid_file => {%proc_pid_file_option} );Proc::PID::File option is Proc::PID::File please refer to
EXTENDED METHOD
Proc::PID::File::path
return pidfile path
Example:
# MyApp::Hello(App::CLI::Command base package)
sub run {
my($self, @args) = @_;
say $self->pf->path;
}METHOD
pf
return Proc::PID::File object.
Specify the process ID of the file that describes the default Proc::PID::File in the specified or default values are applied, dir, name, but you may specify a combination of an optional extension to specify the pidfile possible.
--pidfile command line option if you also have to be defined by the specified module, --pidfile file path specified in the process ID can also be used as a file that describes the
Example1. Proc::PID::File pidfile config
# in MyApp.pm
__PACKAGE__->config(
proc_pid_file => {
pidfile => "/tmp/myapp.pid",
###############################
# Following equivalent
###############################
# dir => "/tmp",
# name => "myapp"
}
);Example2. pidfile option
myapp --pidfile=/tmp/myapp.pidTIPS
Multi Launcher Lock Plugin
1. Make MultiBoot Lock Plugin
Example
package MyApp::Plugin::MultiLauncherLock;
use strict;
use feature ":5.10.0";
sub prerun {
my($self, @argv) = @_;
if ($self->pf->alive) {
my $pid = $self->pf->read;
die "already " . $self->argv0 . "[$pid] is running";
}
$self->pf->touch;
$self->maybe::next::method(@argv);
}
1;2. Load MyApp::Plugin::MultiLauncherLock
# in MyApp.pm
__PACKAGE__->load_plugins(qw(
Proc::PID::File
+MyApp::Plugin::MultiLauncherLock
));3. Make MyApp::Run
Example
package MyApp::Run;
use strict;
use feature ":5.10.0";
sub run {
my($self, @args) = @_;
sleep 60;
say "end";
}4. first execute
# 60 seconds after the "end" to exit and output
myapp run5. second execute first execute run to run the same script again before the end of the
myapp runRunning a dual 2 "already myapp [$pid] is running" is output, and end with exit code 1
Old Process Killing Plugin
Example
package MyApp::Plugin::OldProcessKill;
use strict;
use feature ":5.10.0";
use POSIX qw(SIGTERM SIGINT SA_RESTART sigaction);
sub prerun {
my($self, @argv) = @_;
my $set = POSIX::SigSet->new(SIGTERM, SIGINT);
my $act = POSIX::SigAction->new(sub {
my $signal = shift;
die "signal $signal recevied...";
}, $set, SA_RESTART);
my $old_act = POSIX::SigAction->new;
sigaction(SIGTERM, $act, $old_act);
sigaction(SIGINT, $act, $old_act);
if ($self->pf->alive) {
my $pid = $self->pf->read;
kill SIGTERM, $pid;
say "old process " . $self->argv0 . "[$pid] is killed";
}
$self->pf->touch;
$self->maybe::next::method(@argv);
}
1;2. Load MyApp::Plugin::OldProcessKill
# in MyApp.pm
__PACKAGE__->load_plugins(qw(
Proc::PID::File
+MyApp::Plugin::OldProcessKill
));3. Make MyApp::Run
Example
package MyApp::Run;
use strict;
use feature ":5.10.0";
sub run {
my($self, @args) = @_;
sleep 60;
say "end";
}4. first execute
# 60 seconds after the "end" to exit and output
myapp run5. second execute first execute run to run the same script again before the end of the
myapp run
old process myapp[9999] is killedfirst execute process is killed and dying message "signal TERM recevied..."
SEE ALSO
App::CLI::Extension Class::Accessor::Grouped Proc::PID::File
AUTHOR
Akira Horimoto
COPYRIGHT AND LICENSE
This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
Copyright (C) 2010 Akira Horimoto