The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
Net-Wireless-802_11-WPA-CLI-Helper-0.0.0
River stage zero No dependents
++
/ Net::Wireless::802_11::WPA::CLI::Helper

NAME

Net::Wireless::802_11::WPA::CLI::Helper - Provides various helper functions for working with Net::Wireless::802_11::WPA::CLI.

VERSION

Version 0.0.0

SYNOPSIS

    use Net::Wireless::802_11::WPA::CLI::Helper;
    use Net::Wireless::802_11::WPA::CLI;

    my $cli=Net::Wireless::802_11::WPA::CLI->new;

    my $foo = Net::Wireless::802_11::WPA::CLI::Helper->new($cli);
    ...

METHODS

new

This initializes the object.

There is one argument taken and that is a Net::Wireless::802_11::WPA::CLI object. If not specified, a Net::Wireless::802_11::WPA::CLI object is initiated with the defaults.

    my $foo=Net::Wireless::802_11::WPA::CLI::Helper->new($cli);
    if ( $foo->error ){
        warn('Error:'.$foo->error.': '.$foo->errorString);
        }

apObj2network

This writes a Net::Wireless::802_11::AP to a network ID.

One argument is taken and that is the Net::Wireless::802_11::AP object. It requires the variable 'networkID' to be specified. This is the network ID that it will be writen to.

    $foo->apObj2network($ap);
    if ($foo->error){
        warn('Error:'.$foo->error.': '.$foo->errorString);
    }

network2APobj

This converts a specified configured network to a Net::Wireless::802_11::AP object.

One agrument is required and it is a network ID.

    my %APobj=$foo->network2APobj('0');
    if ($foo->error){
        warn('Error:'.$foo->error.': '.$foo->errorString);
    }

networks2APobjs

This converts all configured networks to a hash of Net::Wireless::802_11::AP objects. The keys used is the network ID.

    my %APobj=$foo->networks2APobj;
    if ($foo->error){
        warn('Error:'.$foo->error.': '.$foo->errorString);
    }

NIDexists

This verifies a that a network ID exists.

One argument is taken and it is the numeric network ID.

The returned value is boolean.

    my $exists=$foo->NIDexists('0');
    if( $foo->error ){
        warn('Error:'.$foo->error.': '.$foo->errorString);
    }

ERROR CODES

1

No Net::Wireless::802_11::WPA::CLI::Helper specified or initialize a new instance.

This is a permanent error.

2

There was an error with the argument.

3

Net::Wireless::802_11::WPA::CLI errored.

4

The network ID does not exist.

5

Unable to fetch a SSID for a network ID.

6

The Net::Wireless::802_11::AP does not have a the variable 'networkID' specified.

AUTHOR

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

BUGS " Please report any bugs or feature requests to bug-net-wireless-802_11-wpa-cli-helper at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Net-Wireless-802_11-WPA-CLI-Helper. 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 Net::Wireless::802_11::WPA::CLI::Helper

You can also look for information at:

ACKNOWLEDGEMENTS

LICENSE AND COPYRIGHT

Copyright 2011 Zane C. Bowers-Hadley.

This program is free software; you can redistribute it and/or modify it under the terms of either: the GNU General Public License as published by the Free Software Foundation; or the Artistic License.

See http://dev.perl.org/licenses/ for more information.