add WChan support and update some docs

This commit is contained in:
Zane C. B-H 2019-08-18 23:12:55 -05:00
parent 81ad052283
commit 0f2aaacf53
8 changed files with 231 additions and 12 deletions

View File

@ -41,9 +41,9 @@ our $VERSION = '0.0.0';
This intiates the object.
It takes a hash reference with one key. One key is required and
that is 'uids', which is a array of UIDs to match.
that is 'pids', which is a array of PIDs to match.
The UID values can be prefixed with the equalities below for doing
The PID values can be prefixed with the equalities below for doing
additional comparisons.
<

View File

@ -6,7 +6,7 @@ use warnings;
=head1 NAME
Proc::ProcessTable::Match::PctCPU - Check if the PctCPU of a process matches.
Proc::ProcessTable::Match::PctCPU - Check if a process matches based on the CPU usaged percentage.
=head1 VERSION

View File

@ -6,7 +6,7 @@ use warnings;
=head1 NAME
Proc::ProcessTable::Match::PctMem - Check if the PctMem of a process matches.
Proc::ProcessTable::Match::PctMem - Check if the memory usage by percent of a process matches.
=head1 VERSION
@ -41,7 +41,7 @@ our $VERSION = '0.0.0';
This intiates the object.
It takes a hash reference with one key. One key is required and
that is 'PctMems', which is a array of PctMems values to match.
that is 'PctMems', which is a array of PctMem values to match.
The PctMem values can be prefixed with the equalities below for doing
additional comparisons.

View File

@ -41,7 +41,7 @@ our $VERSION = '0.0.0';
This intiates the object.
It takes a hash reference with one key. One key is required and
that is 'priorities', which is a array of Prioritys to match.
that is 'priorities', which is a array of priority values to match.
The Priority values can be prefixed with the equalities below for doing
additional comparisons.

View File

@ -6,7 +6,7 @@ use warnings;
=head1 NAME
Proc::ProcessTable::Match::RSS - Check if the RSS of a process matches.
Proc::ProcessTable::Match::RSS - Check if the resident set size of a process matches.
=head1 VERSION
@ -41,7 +41,7 @@ our $VERSION = '0.0.0';
This intiates the object.
It takes a hash reference with one key. One key is required and
that is 'rss', which is a array of RSSs to match.
that is 'rss', which is a array of RSS values to match.
The RSS values can be prefixed with the equalities below for doing
additional comparisons.

View File

@ -6,7 +6,7 @@ use warnings;
=head1 NAME
Proc::ProcessTable::Match::Start - Check if the Start of a process matches.
Proc::ProcessTable::Match::Start - Check if the start time of a process matches.
=head1 VERSION
@ -41,7 +41,7 @@ our $VERSION = '0.0.0';
This intiates the object.
It takes a hash reference with one key. One key is required and
that is 'starts', which is a array of Starts to match.
that is 'starts', which is a array of start times to match.
The Start values can be prefixed with the equalities below for doing
additional comparisons.

View File

@ -6,7 +6,7 @@ use warnings;
=head1 NAME
Proc::ProcessTable::Match::Time - Check if the Time of a process matches.
Proc::ProcessTable::Match::Time - Check if the user + system time of a process matches.
=head1 VERSION
@ -41,7 +41,7 @@ our $VERSION = '0.0.0';
This intiates the object.
It takes a hash reference with one key. One key is required and
that is 'times', which is a array of Times to match.
that is 'times', which is a array of time values to match.
The Time values can be prefixed with the equalities below for doing
additional comparisons.

View File

@ -0,0 +1,219 @@
package Proc::ProcessTable::Match::WChan;
use 5.006;
use strict;
use warnings;
=head1 NAME
Proc::ProcessTable::Match::WChan - Check if the wait channel of a process matches.
=head1 VERSION
Version 0.0.0
=cut
our $VERSION = '0.0.0';
=head1 SYNOPSIS
use Proc::ProcessTable::Match::WChan;
my %args=(
wchans=>[
'syslogd',
],
);
my $checker=Proc::ProcessTable::Match::WChan->new( \%args );
if ( $checker->match( $proc ) ){
print "It matches.\n";
}
=head1 METHODS
=head2 new
This intiates the object.
It takes a hash reference with one key. One key is required and
that is 'wchans', which is a array of wait channels to match.
Atleast one wchan must be specified.
If the new method fails, it dies.
my %args=(
wchans=>[
'select',
],
);
my $checker=Proc::ProcessTable::Match::WChan->new( \%args );
=cut
sub new{
my %args;
if(defined($_[1])){
%args= %{$_[1]};
};
# run some basic checks to make sure we have the minimum stuff required to work
if ( ! defined( $args{wchans} ) ){
die ('No wchans key specified in the argument hash');
}
if ( ref( \$args{wchans} ) eq 'ARRAY' ){
die ('The wchans key is not a array');
}
if ( ! defined $args{wchans}[0] ){
die ('Nothing defined in the wchans array');
}
my $self = {
wchans=>$args{wchans},
};
bless $self;
return $self;
}
=head2 match
Checks if a single Proc::ProcessTable::Process object matches the stack.
One argument is taken and that is a Proc::ProcessTable::Process object.
The returned value is a boolean.
if ( $checker->match( $proc ) ){
print "The connection matches.\n";
}
=cut
sub match{
my $self=$_[0];
my $object=$_[1];
if ( !defined( $object ) ){
return 0;
}
if ( ref( $object ) ne 'Proc::ProcessTable::Process' ){
return 0;
}
my $proc_wchan;
eval{
$proc_wchan=$object->wchan;
};
# don't bother proceeding, the object won't match ever
# as it does not have a wchan
if ( ! defined( $proc_wchan ) ){
return 0;
}
foreach my $wchan ( @{ $self->{wchans} } ){
if ( $proc_wchan =~ /$wchan/ ){
return 1;
}
}
return 0;
}
=head1 AUTHOR
Zane C. Bowers-Hadley, C<< <vvelox at vvelox.net> >>
=head1 BUGS
Please report any bugs or feature requests to C<bug-Proc-ProcessTable-Match at rt.cpan.org>, or through
the web interface at L<https://rt.cpan.org/NoAuth/ReportBug.html?Queue=Proc-ProcessTable-Match>. I will be notified, and then you'll
automatically be notified of progress on your bug as I make changes.
=head1 SUPPORT
You can find documentation for this module with the perldoc command.
perldoc Proc::ProcessTable::Match
You can also look for information at:
=over 4
=item * RT: CPAN's request tracker (report bugs here)
L<https://rt.cpan.org/NoAuth/Bugs.html?Dist=Proc-ProcessTable-Match>
=item * AnnoCPAN: Annotated CPAN documentation
L<http://annocpan.org/dist/Proc-ProcessTable-Match>
=item * CPAN Ratings
L<https://cpanratings.perl.org/d/Proc-ProcessTable-Match>
=item * Search CPAN
L<https://metacpan.org/release/Proc-ProcessTable-Match>
=back
=head1 ACKNOWLEDGEMENTS
=head1 LICENSE AND COPYRIGHT
Copyright 2019 Zane C. Bowers-Hadley.
This program is free software; you can redistribute it and/or modify it
under the terms of the the Artistic License (2.0). You may obtain a
copy of the full license at:
L<http://www.perlfoundation.org/artistic_license_2_0>
Any use, modification, and distribution of the Standard or Modified
Versions is governed by this Artistic License. By using, modifying or
distributing the Package, you accept this license. Do not use, modify,
or distribute the Package, if you do not accept this license.
If your Modified Version has been derived from a Modified Version made
by someone other than you, you are nevertheless required to ensure that
your Modified Version complies with the requirements of this license.
This license does not grant you the right to use any trademark, service
mark, tradename, or logo of the Copyright Holder.
This license includes the non-exclusive, worldwide, free-of-charge
patent license to make, have made, use, offer to sell, sell, import and
otherwise transfer the Package with respect to any patent claims
licensable by the Copyright Holder that are necessarily infringed by the
Package. If you institute patent litigation (including a cross-claim or
counterclaim) against any party alleging that the Package constitutes
direct or contributory patent infringement, then this Artistic License
to you shall terminate on the date that such litigation is filed.
Disclaimer of Warranty: THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER
AND CONTRIBUTORS "AS IS' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES.
THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY
YOUR LOCAL LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR
CONTRIBUTOR WILL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR
CONSEQUENTIAL DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE,
EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
=cut
1; # End of Proc::ProcessTable::Match