NetworkTests.h

00001 /**
00002  * ACKme WiConnect Host Library is licensed under the BSD licence: 
00003  * 
00004  * Copyright (c)2014 ACKme Networks.
00005  * All rights reserved. 
00006  * 
00007  * Redistribution and use in source and binary forms, with or without modification, 
00008  * are permitted provided that the following conditions are met: 
00009  * 
00010  * 1. Redistributions of source code must retain the above copyright notice, 
00011  * this list of conditions and the following disclaimer. 
00012  * 2. Redistributions in binary form must reproduce the above copyright notice, 
00013  * this list of conditions and the following disclaimer in the documentation 
00014  * and/or other materials provided with the distribution. 
00015  * 3. The name of the author may not be used to endorse or promote products 
00016  * derived from this software without specific prior written permission. 
00017  * 
00018  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS AND ANY EXPRESS OR IMPLIED 
00019  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 
00020  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT 
00021  * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 
00022  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT 
00023  * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 
00024  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 
00025  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING 
00026  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY 
00027  * OF SUCH DAMAGE.
00028  */
00029 #pragma once
00030 
00031 
00032 #define NETWORK_TEST_CMD_LIST \
00033     ADD_HEADER("Network commands:"), \
00034     ADD_CMD("setup",            networkSetupWeb,             "start/stop/check web setup", \
00035                                                              "Usage: setup <start/stop/status> [<ssid> [<password>]]\n" \
00036                                                              "Examples:\n" \
00037                                                              "> setup start MySSID password\n" \
00038                                                              "> setup check\n" \
00039                                                              "> setup stop"), \
00040     ADD_CMD("join",             networkJoin,                 "Join a network", \
00041                                                              "Usage: join [<ssid> [<password>]]"), \
00042     ADD_CMD("leave",            networkLeave,                "Leave a network", \
00043                                                              "Usage: leave"), \
00044     ADD_CMD("netstat",          networkStats,                "Get network information", \
00045                                                              "Usage: netstat"), \
00046     ADD_CMD("scan",             networkScan,                 "Return list of available networks", \
00047                                                              "Usage: scan [<channel list>/<all> [<ssid>]]\n" \
00048                                                              "Examples:\n" \
00049                                                              "> scan 1,6,11\n" \
00050                                                              "> scan all \"My Network's Name\""), \
00051     ADD_CMD("ping",             networkPing,                 "Ping a network", \
00052                                                              "Usage: ping [<host/IP address>]\n" \
00053                                                              "Examples:\n" \
00054                                                              "> ping    // ping the gateway\n" \
00055                                                              "> ping www.ack.me"), \
00056     ADD_CMD("lookup",           networkLookup,               "Resolve domain name to IP address", \
00057                                                              "Usage: lookup <domain>\n" \
00058                                                              "Examples:\n" \
00059                                                              "> lookup www.ack.me")
00060 
00061 
00062 WiconnectResult networkSetupWebCommand(int argc, char **argv);
00063 WiconnectResult networkJoinCommand(int argc, char **argv);
00064 WiconnectResult networkLeaveCommand(int argc, char **argv);
00065 WiconnectResult networkStatsCommand(int argc, char **argv);
00066 WiconnectResult networkScanCommand(int argc, char **argv);
00067 WiconnectResult networkPingCommand(int argc, char **argv);
00068 WiconnectResult networkLookupCommand(int argc, char **argv);