The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
Parse-Netstat-Search-Sort-0.0.1
River stage zero No dependents
++
/ Parse::Netstat::Search::Sort

NAME

Parse::Netstat::Search::Sort - Sorts the returned array from Parse::Netstat::Search.

VERSION

Version 0.0.1

SYNOPSIS

    use Parse::Netstat::Search;
    use Parse::Netstat::Search::Sort;
    use Parse::Netstat qw(parse_netstat);

    my $res = parse_netstat(output => join("", `netstat -n`), tcp=>1, udp=>1, unix=>0,  flavor=>$^O);

    my $pn-search=Parse::Netstat::Search->new;

    my @found=$pn-search->search( $res );

    my $sorter = Parse::Netstat::Search::Sort->new;

    @found = $sorter->sort( \@found );

The supported sort methods are as below.

    host_f     Host, Foreign (default)
    host_l     Host, Local
    port_f     Port, Foriegn
    port_l     Port, Local
    state      State
    protocol   Protocol
    q_r        Queue, Receive
    q_s        Queue, Send
    none       No sorting is done.

These dual sort can take noticably longer than the ones above.

    host_ff    Host, Foreign First
    host_lf    Host, Local First
    port_ff    Port, Foreign First
    port_lf    Port, Local First
    q_rf       Queue, Receive First
    q_sf       Queue, Send First

Methods

new

Initiates the object.

    my $sorter=Parse::Netstat::Search->new;

get_sort

This returns the current sort method.

    my $sort=$pnc->get_sort;

set_sort

This sets the sort method to be used and if it should be inverted.

The first argument is the sort method name and the second is a boolean on if it should be inverted or not.

Leaving either undef resets the undef value back to the default.

The supported sorting methods are as below.

    $ sorter->set_sort( $sort_method );
    if( $sorter->error ){
        warn( '"'.$sort_method.'"' is not a valid sort method );
    }
    
    # reset to defaults
    $sorter->set_sort
    
    # Set the sort method to host_f and invert.
    $sorter->set_sort( 'host_f' )

sort

Sorts the provided array from Parse::Netstat::Search.

    my @sorted=$sorter->sort( \@found );

host_sort_helper

Internal function.

Takes a host and converts it to a number.

port_sort_helper

Internal function.

Makes sure a port number is always returned.

ERROR CODES / FLAGS

Error handling is provided by Error::Helper.

1 / badSort

Invalid value specified for sort.

2 / badArray

The passed item is not a array.

AUTHOR

Zame C. Bowers-Hadley, <vvelox at vvelox.net>

BUGS

Please report any bugs or feature requests to bug-parse-netstat-search-sort at rt.cpan.org, or through the web interface at https://rt.cpan.org/NoAuth/ReportBug.html?Queue=Parse-Netstat-Search-Sort. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT

You can find documentation for this module with the perldoc command.

    perldoc Parse::Netstat::Search::Sort

You can also look for information at:

ACKNOWLEDGEMENTS

LICENSE AND COPYRIGHT

Copyright 2019 Zame 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.