|
21 | 21 | #define WIFI_INTERFACE_H
|
22 | 22 |
|
23 | 23 | #include <string.h>
|
24 |
| -#include "Callback.h" |
25 | 24 | #include "netsocket/NetworkInterface.h"
|
26 | 25 | #include "netsocket/WiFiAccessPoint.h"
|
27 | 26 |
|
@@ -91,17 +90,14 @@ class WiFiInterface: public NetworkInterface
|
91 | 90 |
|
92 | 91 | /** Scan for available networks
|
93 | 92 | *
|
94 |
| - * The scan will |
95 |
| - * If the network interface is set to non-blocking mode, scan will attempt to scan |
96 |
| - * for WiFi networks asynchronously and return NSAPI_ERROR_WOULD_BLOCK. If a callback |
97 |
| - * is attached, the callback will be called when the operation has completed. |
| 93 | + * This function will block. If the @a count is 0, function will only return count of available networks, so that |
| 94 | + * user can allocated necessary memory. If the @count is grater than 0 and the @a ap is not NULL it'll be populated |
| 95 | + * with discovered networks up to value of @a count. |
98 | 96 | *
|
99 |
| - * @param ap Pointer to allocated array to store discovered AP |
100 |
| - * @param count Size of allocated @a res array, or 0 to only count available AP |
101 |
| - * @param timeout Timeout in milliseconds; 0 for no timeout (Default: 0) |
102 |
| - * @return Number of entries in @a, or if @a count was 0 number of available networks, |
103 |
| - * negative on error |
104 |
| - * see @a nsapi_error |
| 97 | + * @param ap Pointer to allocated array to store discovered AP |
| 98 | + * @param count Size of allocated @a res array, or 0 to only count available AP |
| 99 | + * @return Number of entries in @a, or if @a count was 0 number of available networks, |
| 100 | + * negative on error see @a nsapi_error |
105 | 101 | */
|
106 | 102 | virtual nsapi_size_or_error_t scan(WiFiAccessPoint *res, nsapi_size_t count) = 0;
|
107 | 103 | };
|
|
0 commit comments