Parse::Netstat::Colorizer - Searches and colorizes the output from Parse::Netstat
Version 0.0.0
use Parse::Netstat; use Parse::Netstat::Colorizer; my $pnc = Parse::Netstat::Colorizer->new(); # don't even bother parsing unix sockets... Parse::Netstat::Search, Parse::Netsat::Search::Sort; # and this only currently handle non-unix network connections my $res = parse_netstat(output => join("", `netstat -n`), tcp=>1, udp=>1, unix=>0, flavor=>$^O); # search only for connections to/from specific networks my @networks=('192.168.0.0/24', '10.10.10.0/24'); my $search=$pnc->get_search; $search->set_cidrs( \@networks ); if ( $search->error ){ warn( 'One of the passed CIDRs is bad' ); } # set it to host local sort my $sorter=$pnc->get_sort; $sorter->set_sort( 'host_l' );
Sorting and searching is handled via Parse::Netsat::Search and Parse::Netstat::Search::Sort. Their objects for tweaking can be fetched via get_sort and get_search.
Creates a new object. This will never error.
my $pnc->new;
This runs the configured search and colorizes the output.
One value is taken and that is the array ref returned by Parse::Netstat.
my $colorized=$pnc->colorize($res); if ( $pnc->error ){ warn( 'Either $res is not valid post a basic check or sorting failed. }
This returns a boolean as to if the return from the sort is inverted or not.
my $invert=$pnc->get_invert;
This gets the port_resolve value, which is if it should try to resolve port names or not.
The returned value is a boolean and defaults to 1.
my $port_resolve=$pnc->get_port_resolve;
This returns the Parse::Netstat::Search object.
my $search=$pnc->get_search;
This returns the Parse::Netstat::Search::Sort object.
my $sorter=$pnc->get_sort; # set it to host local sort $sorter->set_sort( 'host_l' );
This sets wether or not it should invert the returned sort or not.
# sets it to false, the default $pnc->set_invert; # the results will be inverted $pnc->set_invert;
This sets wether or not the ports should be resolved or not.
One value is taken and that is a perl boolean.
# sets it to true, the default $pnc->set_port_resolve(1); # set it false, don't resolve the ports $pnc->set_port_resolve;
Error handling is provided by Error::Helper.
The passed Parse::Netstat array does not appear to be properly formatted.
Parse::Netstat::Search->search errored.
Parse::Netsat::Search::Sort errored.
Zane C. Bowers-Hadley, <vvelox at vvelox.net>
<vvelox at vvelox.net>
Please report any bugs or feature requests to bug-parse-netstat-colorizer at rt.cpan.org, or through the web interface at https://rt.cpan.org/NoAuth/ReportBug.html?Queue=Parse-Netstat-Colorizer. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.
bug-parse-netstat-colorizer at rt.cpan.org
You can find documentation for this module with the perldoc command.
perldoc Parse::Netstat::Colorizer
You can also look for information at:
RT: CPAN's request tracker (report bugs here)
https://rt.cpan.org/NoAuth/Bugs.html?Dist=Parse-Netstat-Colorizer
AnnoCPAN: Annotated CPAN documentation
http://annocpan.org/dist/Parse-Netstat-Colorizer
CPAN Ratings
https://cpanratings.perl.org/d/Parse-Netstat-Colorizer
Search CPAN
https://metacpan.org/release/Parse-Netstat-Colorizer
Code Repo
https://gitea.eesdp.org/vvelox/Parse-Netstat-Colorizer
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:
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.
1 POD Error
The following errors were encountered while parsing the POD:
Unknown directive: =head
To install Parse::Netstat::Colorizer, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Parse::Netstat::Colorizer
CPAN shell
perl -MCPAN -e shell install Parse::Netstat::Colorizer
For more information on module installation, please visit the detailed CPAN module installation guide.