start work on figuring out what all I want this to do, writing some initial docs, and creating empty functions

This commit is contained in:
Zane C. B-H 2019-02-17 09:19:04 -06:00
parent a879bc1634
commit 97b0224da3
2 changed files with 98 additions and 18 deletions

View File

@ -16,10 +16,8 @@ WriteMakefile(
}, },
BUILD_REQUIRES => { BUILD_REQUIRES => {
'Test::More' => '0', 'Test::More' => '0',
}, 'Net::CIDR' => '0',
PREREQ_PM => { 'Error::Helper' => '1.0.0',
#'ABC' => '1.6',
#'Foo::Bar::Module' => '5.0401',
}, },
dist => { COMPRESS => 'gzip -9f', SUFFIX => 'gz', }, dist => { COMPRESS => 'gzip -9f', SUFFIX => 'gz', },
clean => { FILES => 'Parse-Netstat-Search-*' }, clean => { FILES => 'Parse-Netstat-Search-*' },

View File

@ -6,15 +6,15 @@ use warnings;
=head1 NAME =head1 NAME
Parse::Netstat::Search - The great new Parse::Netstat::Search! Parse::Netstat::Search - Searches
=head1 VERSION =head1 VERSION
Version 0.01 Version 0.0.0
=cut =cut
our $VERSION = '0.01'; our $VERSION = '0.0.0';
=head1 SYNOPSIS =head1 SYNOPSIS
@ -25,28 +25,110 @@ Perhaps a little code snippet.
use Parse::Netstat::Search; use Parse::Netstat::Search;
my $foo = Parse::Netstat::Search->new(); my $search = Parse::Netstat::Search->new();
...
=head1 EXPORT
A list of functions that can be exported. You can delete this section =head1 methods
if you don't export anything, such as for a purely object-oriented module.
=head1 SUBROUTINES/METHODS =head2 new
=head2 function1 =cut
=cut sub new{
sub function1 {
} }
=head2 function2 =head2 get_cidrs
Retrieves the CIDR match list.
The returned value is an array.
=cut =cut
sub function2 { sub get_cidr{
}
=head2 get_protocols
Gets a list of desired protocols.
The returned value is a array.
=cut
sub get_protocols{
}
=head2 get_states
Get a list of desired sets.
The returned value is a array.
=cut
sub get_states{
}
=head2 set_cidrs
This sets the list of CIDRs to search for
in either the local or remote field.
One value is taken and that is a array of CIDRs.
Validating in is done by Net::CIDR::cidrvalidate.
=cut
sub set_cidrs{
}
=head2 set_ports
This sets the ports to search for in either
the local or remote field.
One value is taken and that is a array of ports.
=cut
sub set_ports{
}
=head2 set_protocols
Sets the list of desired protocols to match.
One value is taken and that is a array.
If this is undef, then previous settings will be cleared.
=cut
sub set_protocols{
}
=head2 set_states
Sets the list of desired states to match.
One value is taken and that is a array.
If this is undef, then previous settings will be cleared.
=cut
sub set_states{
} }
=head1 AUTHOR =head1 AUTHOR