Host library for controlling a WiConnect enabled Wi-Fi module.
Dependents: wiconnect-ota_example wiconnect-web_setup_example wiconnect-test-console wiconnect-tcp_server_example ... more
Diff: NetworkInterface.h
- Revision:
- 21:17bb3eddcbae
- Parent:
- 17:7268f365676b
- Child:
- 26:8067e3d463d3
diff -r 7b67c3f94de9 -r 17bb3eddcbae NetworkInterface.h --- a/NetworkInterface.h Sat Aug 23 05:57:52 2014 -0700 +++ b/NetworkInterface.h Tue Aug 26 16:38:19 2014 -0700 @@ -1,30 +1,30 @@ -/** - * ACKme WiConnect Host Library is licensed under the BSD licence: - * - * Copyright (c)2014 ACKme Networks. - * All rights reserved. - * - * Redistribution and use in source and binary forms, with or without modification, - * are permitted provided that the following conditions are met: - * - * 1. Redistributions of source code must retain the above copyright notice, - * this list of conditions and the following disclaimer. - * 2. Redistributions in binary form must reproduce the above copyright notice, - * this list of conditions and the following disclaimer in the documentation - * and/or other materials provided with the distribution. - * 3. The name of the author may not be used to endorse or promote products - * derived from this software without specific prior written permission. - * - * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS AND ANY EXPRESS OR IMPLIED - * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF - * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT - * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, - * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT - * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS - * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN - * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING - * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY - * OF SUCH DAMAGE. +/** + * ACKme WiConnect Host Library is licensed under the BSD licence: + * + * Copyright (c)2014 ACKme Networks. + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without modification, + * are permitted provided that the following conditions are met: + * + * 1. Redistributions of source code must retain the above copyright notice, + * this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright notice, + * this list of conditions and the following disclaimer in the documentation + * and/or other materials provided with the distribution. + * 3. The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS AND ANY EXPRESS OR IMPLIED + * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF + * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT + * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, + * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT + * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS + * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN + * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING + * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY + * OF SUCH DAMAGE. */ #pragma once @@ -113,12 +113,12 @@ * is specified. If enabled, the library will poll the module every second * for the join status (essentially it'll call getNetworkStatus() every * second in the background). When the module join sequence complete the callback will be executed. - * The background processing is disabled when leave() is called. - * - * * If completeHandler parameter is NOT specified: - * This command will BLOCK/return WICONNECT_PROCESSING until the module has - * either successfully joined the network or failed. - * * If the completeHandler parameter IS specified: + * The background processing is disabled when leave() is called. + * + * * If completeHandler parameter is NOT specified: + * This command will BLOCK/return WICONNECT_PROCESSING until the module has + * either successfully joined the network or failed. + * * If the completeHandler parameter IS specified: * This command will return and use the background processing feature described above. * * @note only the 'result' parameter of the callback handler is valid. @@ -262,19 +262,19 @@ */ WiconnectResult getSignalStrength(NetworkSignalStrength *signalStrengthPtr); - - /** - * @ingroup api_network_settings - * - * @note This method is only supported in blocking mode. - * - * @brief Return the current IP address of the module if possible, else - * return 0.0.0.0 - * @param[in] buffer Optional, buffer to IP address string. If omitted, - * the IP address string is stored in a local static buffer (this is non-reentrant!) - */ - const char* getIpAddress(char *buffer = NULL); - + + /** + * @ingroup api_network_settings + * + * @note This method is only supported in blocking mode. + * + * @brief Return the current IP address of the module if possible, else + * return 0.0.0.0 + * @param[in] buffer Optional, buffer to IP address string. If omitted, + * the IP address string is stored in a local static buffer (this is non-reentrant!) + */ + const char* getIpAddress(char *buffer = NULL); + // ------------------------------------------------------------------------