Class::Usul::IPC - List/Create/Delete processes
This documents version v0.24.$Rev: 1 $
use q(Class::Usul::IPC); my $ipc = Class::Usul::IPC->new; $result_object = $ipc->run_cmd( [ qw(ls -l) ] );
Displays the process table and allows signals to be sent to selected processes
@pids = $self->child_list( $pid );
Called with a process id for an argument this method returns a list of child process ids
$response = $self->popen( $cmd, @opts );
Uses IPC::Open3 to fork a command and pipe the lines of input into it. Returns a Class::Usul::Response::IPC object. The response object's out method returns the STDOUT from the command. Throws in the event of an error. See "run_cmd" for a full list of options and response attributes
Class::Usul::Response::IPC
out
$bool = $self->process_exists( file => $path, pid => $pid );
Tests for the existence of the specified process. Either specify a path to a file containing the process id or specify the id directly
Generates the process table data used by the HTML::FormWidget table subclass. Called by "proc_table" in Class::Usul::Model::Process
$response = $self->run_cmd( $cmd, $opts );
Runs the given command. If $cmd is a string then an implementation based on the system function is used. If $cmd is an arrayref then an implementation based on IPC::Run is used if it is installed. If IPC::Run is not installed then the arrayref is joined with spaces and the system implementation is used. The keys of the $opts hashref are:
$cmd
system
$opts
If async is true then the command is run in the background
async
Debug status. Defaults to $self->debug
$self->debug
Passing err => q(out) mixes the normal and error output together
Input to the command. Can be a string or an array ref
Destination for standard output
Directory used to store the lock file and lock table if the fcntl backend is used. Defaults to $self->tempdir
fcntl
$self->tempdir
Returns a Class::Usul::Response::IPC object or throws an error. The response object has the following methods:
core
Returns true if the command generated a core dump
err
Contains a cleaned up version of the commands STDERR
STDERR
Contains a cleaned up version of the commands STDOUT
STDOUT
pid
The id of the background process. Only set if command is running async
rv
The return value of the command
sig
If the command died as the result of receiving a signal return the signal number
stderr
Contains the commands STDERR
stdout
Contains the commands STDOUT
On MSWin32 the "popen" method is used instead. That method does not support the async option
MSWin32
Send a signal the the selected processes. Invokes the suid root wrapper
suid
$self->signal_process( [{] param => value, ... [}] );
This is called by processes running as root to send signals to selected processes. The passed parameters can be either a list of key value pairs or a hash ref. Either a single pid, or an array ref pids, or file must be passwd. The file parameter should be a path to a file containing process ids one per line. The sig defaults to TERM. If the flag parameter is set to one then the given signal will be sent once to each selected process. Otherwise each process and all of it's children will be sent the signal. If the force parameter is set to true the after a grace period each process and it's children are sent signal KILL
pids
file
TERM
flag
one
force
KILL
This interrupt handler traps the pipe signal
This interrupt handler traps the child signal
None
There are no known incompatibilities in this module
There are no known bugs in this module. Please report problems to the address below. Patches are welcome
Peter Flanigan, <Support at RoxSoft.co.uk>
<Support at RoxSoft.co.uk>
Copyright (c) 2013 Peter Flanigan. All rights reserved
This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See perlartistic
This program is distributed in the hope that it will be useful, but WITHOUT WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE
To install Class::Usul, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Class::Usul
CPAN shell
perl -MCPAN -e shell install Class::Usul
For more information on module installation, please visit the detailed CPAN module installation guide.