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: api/types/ScanResult.h
- Revision:
- 29:b6af04b77a56
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/api/types/ScanResult.h Mon Oct 27 13:42:26 2014 -0700 @@ -0,0 +1,86 @@ +/** + * 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 + + + +#include "api/WiconnectTypes.h" +#include "api/StringUtil.h" + + +namespace wiconnect +{ + +/** + * @ingroup api_network_types + * + * @brief Contains single entry from WiFi scan results + * + */ +class ScanResult +{ +public: + uint8_t getChannel() const; + NetworkSignalStrength getSignalStrength() const; + const MacAddress* getMacAddress() const; + NetworkSecurity getSecurityType() const; + uint32_t getRate() const; + const char* getRateStr(char *buffer = NULL) const; + const Ssid* getSsid() const; + + const ScanResult* getNext() const; + const ScanResult* getPrevious() const; + +protected: + ScanResult(); + + WiconnectResult init(const char *channelStr, const char *rssiStr, const char* macStr, const char *rateStr, const char *secStr, const char *ssidStr); + ScanResult *next; + ScanResult *previous; + uint8_t channel; + int16_t rssi; + MacAddress mac; + uint32_t rate; + NetworkSecurity security; + Ssid ssid; + +#ifdef WICONNECT_ENABLE_MALLOC + void* operator new(size_t size); + void operator delete(void*); +#endif + + friend class ScanResultList; +}; + + + + + + +}