Skip to content

Commit 391b864

Browse files
Sanggyu Leeyichoi
authored andcommitted
Update API platform support table for NuttX limitation (#1000)
We've specified the limitation on NuttX more explicitly. We introduced the notation '?' for partial/unstable support. The limitation is described as footer comment. IoT.js-DCO-1.0-Signed-off-by: Sanggyu Lee [email protected]
1 parent 537dc1a commit 391b864

File tree

3 files changed

+28
-23
lines changed

3 files changed

+28
-23
lines changed

docs/api/IoT.js-API-DGRAM.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,19 +4,21 @@ The following shows dgram module APIs available for each platform.
44

55
| | Linux<br/>(Ubuntu) | Raspbian<br/>(Raspberry Pi) | NuttX<br/>(STM32F4-Discovery) |
66
| :---: | :---: | :---: | :---: |
7-
| dgram.createSocket | O | O | O |
7+
| dgram.createSocket | O | O | △ ¹ |
88
| dgram.Socket.addMembership | O | O | X |
99
| dgram.Socket.address | O | O | X |
10-
| dgram.Socket.bind | O | O | O |
11-
| dgram.Socket.close | O | O | O |
10+
| dgram.Socket.bind | O | O | △ ¹ |
11+
| dgram.Socket.close | O | O | △ ² |
1212
| dgram.Socket.dropMembership | O | O | X |
13-
| dgram.Socket.send | O | O | O |
13+
| dgram.Socket.send | O | O | △ ¹ |
1414
| dgram.Socket.setBroadcast | O | O | X |
1515
| dgram.Socket.setMulticastLoopback | O | O | X |
1616
| dgram.Socket.setMulticastTTL | X | X | X |
1717
| dgram.Socket.setTTL | O | O | X |
1818

19-
※ On NuttX/STM32F4-Discovery, even a couple of sockets/server/requests might not work properly.
19+
1. On NuttX/STM32F4-Discovery, even a couple of sockets/server/requests might not work properly.
20+
21+
2. On NuttX/STM32F4-Discovery, close() may block due to a bug in poll().
2022

2123
# Dgram
2224

docs/api/IoT.js-API-HTTP.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,11 @@
44

55
| | Linux<br/>(Ubuntu) | Raspbian<br/>(Raspberry Pi) | NuttX<br/>(STM32F4-Discovery) |
66
| :---: | :---: | :---: | :---: |
7-
| http.createServer | O | O | O |
8-
| http.request | O | O | O |
9-
| http.get | O | O | O |
7+
| http.createServer | O | O | △ ¹ |
8+
| http.request | O | O | △ ¹ |
9+
| http.get | O | O | △ ¹ |
1010

11-
On NuttX/STM32F4-Discovery, even a couple of sockets/server/requests might not work properly.
11+
1. On NuttX/STM32F4-Discovery, even a couple of sockets/server/requests might not work properly.
1212

1313
# Http
1414

docs/api/IoT.js-API-Net.md

Lines changed: 17 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -4,24 +4,27 @@ The following shows net module APIs available for each platform.
44

55
| | Linux<br/>(Ubuntu) | Raspbian<br/>(Raspberry Pi) | NuttX<br/>(STM32F4-Discovery) |
66
| :---: | :---: | :---: | :---: |
7-
| net.createServer | O | O | O |
8-
| net.connect | O | O | O |
9-
| net.createConnection | O | O | O |
10-
| net.Server.listen | O | O | O |
11-
| net.Server.close | O | O | O |
12-
| net.Socket.connect | O | O | O |
13-
| net.Socket.write | O | O | O |
14-
| net.Socket.end | O | O | O |
15-
| net.Socket.destroy | O | O | O |
16-
| net.Socket.pause | O | O | O |
17-
| net.Socket.resume | O | O | O |
18-
| net.Socket.setTimeout | O | O | O |
7+
| net.createServer | O | O | △ ¹ |
8+
| net.connect | O | O | △ ¹ |
9+
| net.createConnection | O | O | △ ¹ |
10+
| net.Server.listen | O | O | △ ¹ |
11+
| net.Server.close | O | O | △ ²|
12+
| net.Socket.connect | O | O | △ ¹ |
13+
| net.Socket.write | O | O | △ ¹ |
14+
| net.Socket.end | O | O | △ ¹ ³ |
15+
| net.Socket.destroy | O | O | △ ¹ ³ |
16+
| net.Socket.pause | O | O | △ ¹ |
17+
| net.Socket.resume | O | O | △ ¹ |
18+
| net.Socket.setTimeout | O | O | △ ¹ |
1919
| net.Socket.setKeepAlive | X | X | X |
2020

21-
※ When writable stream is finished but readable stream is still alive, IoT.js tries to shutdown the socket, not destroy.
21+
1. On NuttX/STM32F4-Discovery, even a couple of sockets/server/requests might not work properly.
22+
23+
2. On NuttX/STM32F4-Discovery, close() may block due to a bug in poll().
24+
25+
3. When writable stream is finished but readable stream is still alive, IoT.js tries to shutdown the socket, not destroy.
2226
However on `NuttX` due to lack of implementation, it does nothing inside.
2327

24-
※ On NuttX/STM32F4-Discovery, even a couple of sockets/server/requests might not work properly.
2528

2629
# Net
2730

0 commit comments

Comments
 (0)