Skip to content

Commit 9f807c8

Browse files
author
AnotherButler
committed
Add network socket images
Add class hierarchy images to network socket user APIs.
1 parent 16694a5 commit 9f807c8

File tree

7 files changed

+14
-0
lines changed

7 files changed

+14
-0
lines changed

docs/reference/api/connectivity/networksocket/CellularInterface.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
<h2 id="cellular-api">Cellular</h2>
22

3+
<span class="images">![](https://os.mbed.com/docs/v5.8/mbed-os-api-doxy/class_cellular_base.png)<span>CellularBase class hierarchy</span></span>
4+
35
The CellularBase provides a C++ API for connecting to the internet over a Cellular device.
46

57
Arm Mbed OS provides a [reference implementation of CellularBase](https://os.mbed.com/docs/v5.8/mbed-os-api-doxy/_easy_cellular_connection_8h_source.html), which has more information.

docs/reference/api/connectivity/networksocket/EthInterface.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
## Ethernet
22

3+
<span class="images">![](https://os.mbed.com/docs/v5.8/mbed-os-api-doxy/class_eth_interface.png)<span>Ethernet class hierarchy</span></span>
4+
35
The EthInterface provides a C++ API for connecting to the internet over Ethernet.
46

57
### EthInterface class reference

docs/reference/api/connectivity/networksocket/MeshInterface.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
<h2 id="mesh-api">Mesh</h2>
22

3+
<span class="images">![](https://os.mbed.com/docs/v5.8/mbed-os-api-doxy/class_mesh_interface.png)<span>MeshInterface class hierarchy</span></span>
4+
35
The Arm Mbed mesh API allows the application to use the IPv6 mesh network topologies through the [nanostack](/docs/v5.8/reference/technology.html#nanostack) networking stack.
46

57
**Tips:**

docs/reference/api/connectivity/networksocket/TCPServer.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
## TCPServer
22

3+
<span class="images">![](https://os.mbed.com/docs/v5.8/mbed-os-api-doxy/class_t_c_p_server.png)<span>TCPServer class hierarchy</span></span>
4+
35
The TCPServer class provides the ability to accept incoming TCP connections. The `listen` member function sets up the server to listen for incoming connections, and the `accept` member function sets up a stateful TCPSocket instance on an incoming connection.
46

57
The constructor takes in the NetworkStack pointer to open the socket on the specified NetworkInterface. If you do not pass the NetworkStack pointer in the constructor, then you must call open to initialize the socket.

docs/reference/api/connectivity/networksocket/TCPSocket.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
## TCPSocket
22

3+
<span class="images">![](https://os.mbed.com/docs/v5.8/mbed-os-api-doxy/class_t_c_p_socket.png)<span>TCPSocket class hierarchy</span></span>
4+
35
The TCPSocket class provides the ability to send a stream of data over TCP. TCPSockets maintain a stateful connection that starts with the `connect` member function. After successfully connecting to a server, you can use the `send` and `recv` member functions to send and receive data (similar to writing or reading from a file).
46

57
The constructor takes in the NetworkStack pointer to open the socket on the specified NetworkInterface. If you do not pass in the constructor, then you must call `open` to initialize the socket.

docs/reference/api/connectivity/networksocket/UDPSocket.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
## UDPSocket
22

3+
<span class="images">![](https://os.mbed.com/docs/v5.8/mbed-os-api-doxy/class_u_d_p_socket.png)<span>UDPSocket class hierarchy</span></span>
4+
35
The UDPSocket class provides the ability to send packets of data over UDP, using the `sendto` and `recvfrom` member functions. Packets can be lost or arrive out of order, so we suggest using a [TCPSocket](/docs/v5.8/reference/tcpsocket.html) when you require guaranteed delivery.
46

57
The constructor takes in the NetworkStack pointer to open the socket on the specified NetworkInterface. If you do not pass in the constructor, then you must call `open` to initialize the socket.

docs/reference/api/connectivity/networksocket/WifiInterface.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
## Wi-Fi
22

3+
<span class="images">![](https://os.mbed.com/docs/v5.8/mbed-os-api-doxy/class_wi_fi_interface.png)<span>WiFiInterface class hierarchy</span></span>
4+
35
The WifiInterface provides a simple C++ API for connecting to the internet over a Wi-Fi device.
46

57
There are multiple [Wi-Fi components](https://os.mbed.com/components/cat/wifi/) that implement the WiFiInterface class. The example below uses the [ESP8266Interface](https://github.com/armmbed/esp8266-driver).

0 commit comments

Comments
 (0)