Skip to content

Commit 4ded56c

Browse files
facchinmmanchoz
facchinm
authored and
manchoz
committed
WiFi: make library compliant with Arduino APIs
This includes non-blocking available() and allows compatibility with a broader range of existing libraries
1 parent 5f802c1 commit 4ded56c

File tree

4 files changed

+181
-71
lines changed

4 files changed

+181
-71
lines changed

‎libraries/WiFi/src/WiFiClient.cpp‎

Lines changed: 144 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,8 @@
22

33
extern WiFiClass WiFi;
44

5-
#ifndef WIFI_TCP_BUFFER_SIZE
6-
#define WIFI_TCP_BUFFER_SIZE 1508
7-
#endif
8-
95
#ifndef SOCKET_TIMEOUT
10-
#define SOCKET_TIMEOUT 1000
6+
#define SOCKET_TIMEOUT 1500
117
#endif
128

139
arduino::WiFiClient::WiFiClient():
@@ -19,45 +15,96 @@ uint8_t arduino::WiFiClient::status() {
1915
return _status;
2016
}
2117

18+
void arduino::WiFiClient::readSocket() {
19+
while (1) {
20+
event->wait_any(0xFF, 100);
21+
uint8_t data[SOCKET_BUFFER_SIZE];
22+
int ret = NSAPI_ERROR_WOULD_BLOCK;
23+
do {
24+
mutex->lock();
25+
if (rxBuffer.availableForStore() == 0) {
26+
yield();
27+
}
28+
if (sock == nullptr || (closing && borrowed_socket)) {
29+
goto cleanup;
30+
}
31+
ret = sock->recv(data, rxBuffer.availableForStore());
32+
if (ret < 0 && ret != NSAPI_ERROR_WOULD_BLOCK) {
33+
goto cleanup;
34+
}
35+
for (int i = 0; i < ret; i++) {
36+
rxBuffer.store_char(data[i]);
37+
}
38+
_status = true;
39+
mutex->unlock();
40+
} while (ret == NSAPI_ERROR_WOULD_BLOCK || ret > 0);
41+
}
42+
cleanup:
43+
_status = false;
44+
mutex->unlock();
45+
return;
46+
}
47+
2248
void arduino::WiFiClient::getStatus() {
23-
if (sock == nullptr) {
24-
_status = false;
25-
return;
49+
event->set(1);
50+
}
51+
52+
void arduino::WiFiClient::setSocket(Socket* _sock) {
53+
sock = _sock;
54+
configureSocket(sock);
55+
}
56+
57+
void arduino::WiFiClient::configureSocket(Socket* _s) {
58+
_s->set_timeout(0);
59+
_s->set_blocking(false);
60+
61+
if (event == nullptr) {
62+
event = new rtos::EventFlags;
63+
}
64+
if (mutex == nullptr) {
65+
mutex = new rtos::Mutex;
2666
}
27-
28-
uint8_t data[256];
29-
int ret = sock->recv(data, rxBuffer.availableForStore());
30-
for (int i = 0; i < ret; i++) {
31-
rxBuffer.store_char(data[i]);
32-
}
33-
if (ret < 0 && ret != NSAPI_ERROR_WOULD_BLOCK) {
34-
_status = false;
35-
}
36-
_status = true;
67+
mutex->lock();
68+
if (reader_th == nullptr) {
69+
reader_th = new rtos::Thread;
70+
reader_th->start(mbed::callback(this, &WiFiClient::readSocket));
71+
}
72+
mutex->unlock();
73+
_s->sigio(mbed::callback(this, &WiFiClient::getStatus));
74+
_status = true;
3775
}
3876

3977
int arduino::WiFiClient::connect(SocketAddress socketAddress) {
4078
if (sock == nullptr) {
41-
sock = new TCPSocket();
42-
if(static_cast<TCPSocket*>(sock)->open(WiFi.getNetwork()) != NSAPI_ERROR_OK){
43-
return 0;
44-
}
79+
sock = new TCPSocket();
80+
_own_socket = true;
4581
}
46-
//sock->sigio(mbed::callback(this, &WiFiClient::getStatus));
47-
//sock->set_blocking(false);
82+
if (sock == nullptr) {
83+
return 0;
84+
}
85+
86+
if(static_cast<TCPSocket*>(sock)->open(WiFi.getNetwork()) != NSAPI_ERROR_OK){
87+
return 0;
88+
}
89+
4890
address = socketAddress;
49-
sock->set_timeout(SOCKET_TIMEOUT);
5091
nsapi_error_t returnCode = static_cast<TCPSocket*>(sock)->connect(socketAddress);
5192
int ret = 0;
93+
5294
switch (returnCode) {
5395
case NSAPI_ERROR_IS_CONNECTED:
5496
case NSAPI_ERROR_OK: {
5597
ret = 1;
5698
break;
5799
}
58100
}
59-
if (ret == 1)
101+
102+
if (ret == 1) {
103+
configureSocket(sock);
60104
_status = true;
105+
} else {
106+
_status = false;
107+
}
61108

62109
return ret;
63110
}
@@ -73,28 +120,48 @@ int arduino::WiFiClient::connect(const char *host, uint16_t port) {
73120
return connect(socketAddress);
74121
}
75122

76-
int arduino::WiFiClient::connectSSL(SocketAddress socketAddress){
123+
int arduino::WiFiClient::connectSSL(SocketAddress socketAddress) {
77124
if (sock == nullptr) {
78125
sock = new TLSSocket();
79-
if(static_cast<TLSSocket*>(sock)->open(WiFi.getNetwork()) != NSAPI_ERROR_OK){
80-
return 0;
81-
}
126+
_own_socket = true;
127+
}
128+
if (sock == nullptr) {
129+
return 0;
82130
}
131+
83132
if (beforeConnect) {
84133
beforeConnect();
85134
}
86-
sock->set_timeout(SOCKET_TIMEOUT);
135+
136+
if(static_cast<TLSSocket*>(sock)->open(WiFi.getNetwork()) != NSAPI_ERROR_OK){
137+
return 0;
138+
}
139+
140+
address = socketAddress;
141+
142+
restart_connect:
87143
nsapi_error_t returnCode = static_cast<TLSSocket*>(sock)->connect(socketAddress);
88144
int ret = 0;
145+
89146
switch (returnCode) {
90-
case NSAPI_ERROR_IS_CONNECTED:
91-
case NSAPI_ERROR_OK: {
92-
ret = 1;
93-
break;
94-
}
147+
case NSAPI_ERROR_IS_CONNECTED:
148+
case NSAPI_ERROR_OK: {
149+
ret = 1;
150+
break;
151+
}
152+
case NSAPI_ERROR_IN_PROGRESS:
153+
case NSAPI_ERROR_ALREADY: {
154+
delay(100);
155+
goto restart_connect;
156+
}
95157
}
96-
if (ret == 1)
158+
159+
if (ret == 1) {
160+
configureSocket(sock);
97161
_status = true;
162+
} else {
163+
_status = false;
164+
}
98165

99166
return ret;
100167
}
@@ -111,36 +178,38 @@ int arduino::WiFiClient::connectSSL(const char *host, uint16_t port) {
111178
}
112179

113180
size_t arduino::WiFiClient::write(uint8_t c) {
114-
if (sock == nullptr)
115-
return 0;
116-
auto ret = sock->send(&c, 1);
117-
return ret;
181+
return write(&c, 1);
118182
}
119183

120184
size_t arduino::WiFiClient::write(const uint8_t *buf, size_t size) {
121185
if (sock == nullptr)
122186
return 0;
123187

124-
auto ret = sock->send(buf, size);
125-
return ret;
188+
sock->set_blocking(true);
189+
sock->set_timeout(SOCKET_TIMEOUT);
190+
sock->send(buf, size);
191+
configureSocket(sock);
192+
return size;
126193
}
127194

128195
int arduino::WiFiClient::available() {
129-
if (rxBuffer.available() == 0) {
130-
getStatus();
131-
}
132-
return rxBuffer.available();
196+
int ret = rxBuffer.available();
197+
return ret;
133198
}
134199

135200
int arduino::WiFiClient::read() {
201+
mutex->lock();
136202
if (!available()) {
137203
return -1;
138204
}
139205

140-
return rxBuffer.read_char();
206+
int ret = rxBuffer.read_char();
207+
mutex->unlock();
208+
return ret;
141209
}
142210

143211
int arduino::WiFiClient::read(uint8_t *data, size_t len) {
212+
mutex->lock();
144213
int avail = available();
145214

146215
if (!avail) {
@@ -154,6 +223,7 @@ int arduino::WiFiClient::read(uint8_t *data, size_t len) {
154223
for (size_t i = 0; i < len; i++) {
155224
data[i] = rxBuffer.read_char();
156225
}
226+
mutex->unlock();
157227

158228
return len;
159229
}
@@ -167,15 +237,38 @@ void arduino::WiFiClient::flush() {
167237
}
168238

169239
void arduino::WiFiClient::stop() {
170-
if (sock != nullptr) {
171-
sock->close();
240+
if (mutex != nullptr) {
241+
mutex->lock();
242+
}
243+
if (sock != nullptr && borrowed_socket == false) {
244+
if (_own_socket) {
245+
delete sock;
246+
} else {
247+
sock->close();
248+
}
172249
sock = nullptr;
173250
}
251+
closing = true;
252+
if (mutex != nullptr) {
253+
mutex->unlock();
254+
}
255+
if (reader_th != nullptr) {
256+
reader_th->join();
257+
delete reader_th;
258+
reader_th = nullptr;
259+
}
260+
if (event != nullptr) {
261+
delete event;
262+
event = nullptr;
263+
}
264+
if (mutex != nullptr) {
265+
delete mutex;
266+
mutex = nullptr;
267+
}
174268
_status = false;
175269
}
176270

177271
uint8_t arduino::WiFiClient::connected() {
178-
getStatus();
179272
return _status;
180273
}
181274

‎libraries/WiFi/src/WiFiClient.h‎

Lines changed: 33 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -26,13 +26,33 @@
2626
#include "api/IPAddress.h"
2727
#include "TLSSocket.h"
2828
#include "TCPSocket.h"
29+
#include "rtos.h"
30+
31+
#ifndef SOCKET_BUFFER_SIZE
32+
#define SOCKET_BUFFER_SIZE 256
33+
#endif
2934

3035
namespace arduino {
3136

3237
class WiFiClient : public arduino::Client {
3338

3439
public:
3540
WiFiClient();
41+
WiFiClient(WiFiClient* orig) {
42+
/*
43+
this->reader_th = orig->reader_th;
44+
this->event = orig->event;
45+
this->mutex = orig->mutex;
46+
this->sock = orig->sock;
47+
this->_status = orig->_status;
48+
this->rxBuffer = orig->rxBuffer;
49+
*/
50+
this->sock = orig->sock;
51+
orig->borrowed_socket = true;
52+
orig->stop();
53+
this->setSocket(orig->sock);
54+
}
55+
3656
virtual ~WiFiClient() {
3757
stop();
3858
}
@@ -54,12 +74,11 @@ class WiFiClient : public arduino::Client {
5474
void stop();
5575
uint8_t connected();
5676
operator bool() {
57-
return sock != NULL;
77+
return sock != nullptr;
5878
}
5979

60-
void setSocket(Socket* _sock) {
61-
sock = _sock;
62-
}
80+
void setSocket(Socket* _sock);
81+
void configureSocket(Socket* _s);
6382

6483
IPAddress remoteIP();
6584
uint16_t remotePort();
@@ -76,13 +95,19 @@ class WiFiClient : public arduino::Client {
7695
}
7796

7897
private:
79-
static uint16_t _srcport;
80-
Socket* sock;
81-
RingBufferN<256> rxBuffer;
82-
bool _status;
98+
Socket* sock = nullptr;
99+
RingBufferN<SOCKET_BUFFER_SIZE> rxBuffer;
100+
bool _status = false;
101+
bool borrowed_socket = false;
102+
bool _own_socket = false;
103+
bool closing = false;
83104
mbed::Callback<int(void)> beforeConnect;
84105
SocketAddress address;
106+
rtos::Thread* reader_th = nullptr;
107+
rtos::EventFlags* event = nullptr;
108+
rtos::Mutex* mutex = nullptr;
85109

110+
void readSocket();
86111
void getStatus();
87112
};
88113

‎libraries/WiFi/src/WiFiSSLClient.h‎

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -40,13 +40,6 @@ class WiFiSSLClient : public arduino::WiFiClient {
4040
int connect(const char* host, uint16_t port) {
4141
return connectSSL(host, port);
4242
}
43-
void stop() {
44-
if (sock != NULL) {
45-
sock->close();
46-
delete ((TLSSocket*)sock);
47-
sock = NULL;
48-
}
49-
}
5043

5144
private:
5245
int setRootCA() {

0 commit comments

Comments
 (0)