![]() |
WiConnect Host Library- API Reference Guide | ||
Network utility methods. More...
Functions | |
WiconnectResult | wiconnect::NetworkInterface::scan (ScanResultList &resultList, const uint8_t *channelList=NULL, const char *ssid=NULL) |
Scan for available WiFi networks. More... | |
WiconnectResult | wiconnect::NetworkInterface::ping (const char *domain=NULL, uint32_t *timeMsPtr=NULL) |
Ping a WiFi network. More... | |
WiconnectResult | wiconnect::NetworkInterface::lookup (const char *domain, uint32_t *ipAddressPtr) |
Resolve domain name into IP address. More... | |
Network utility methods.
WiconnectResult wiconnect::NetworkInterface::lookup | ( | const char * | domain, |
uint32_t * | ipAddressPtr | ||
) |
Resolve domain name into IP address.
[in] | domain | The domain name to resolve |
[out] | ipAddressPtr | pointer to uint32 to hold resolved IP address. Note, the IP address is in network-byte-order. |
WiconnectResult wiconnect::NetworkInterface::ping | ( | const char * | domain = NULL , |
uint32_t * | timeMsPtr = NULL |
||
) |
Ping a WiFi network.
Optionally ping a specific server and return the time in milliseconds it took for the network to response. If no domain is supplied, the module pings to gateway (i.e router it's connected to).
[in] | domain | Optional, the domain name to ping |
[out] | timeMsPtr | Optional, pointer to uint32 to hold time in milliseconds the ping took |
WiconnectResult wiconnect::NetworkInterface::scan | ( | ScanResultList & | resultList, |
const uint8_t * | channelList = NULL , |
||
const char * | ssid = NULL |
||
) |
Scan for available WiFi networks.
The populate the supplied ScanResultList with ScanResult of each found network.
Optionally only scan of specific channels by supplying a null terminated list of channels. Example:
[out] | resultList | List to populate with scan results. |
[in] | channelList | Optional, null terminated list of channels to scan. |
[in] | ssid | Optional, specific network name to scan for. |