michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: net: sockets: Add table summarizing supported socket types

Browse source 
Add a table in sockets documentation summarizing what socket types are
being supported.

Signed-off-by: Robert Lubos <robert.lubos@nordicsemi.no>
This commit is contained in:
Robert Lubos 2025-04-03 15:16:33 +02:00 • committed by Benjamin Cabé
commit 403d921bfe
1 changed files with 35 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

35
doc/connectivity/networking/api/sockets.rst
View file

@ -57,6 +57,41 @@ there is a table mapping file descriptors to internal object pointers.
The file descriptor table is used by the BSD Sockets API even if the rest
of the POSIX subsystem (filesystem, stdin/stdout) is not enabled.
Zephyr supports multiple types of BSD sockets, the following table summarizes
what socket types are available:
+--------------+-------------+------------------+---------------------------------------------------------------------------+
| Family | Type | Protocol | Description |
+==============+=============+==================+===========================================================================+
| AF_INET |br| | SOCK_DGRAM | IPPROTO_UDP | Enabled if :kconfig:option:`CONFIG_NET_UDP` is set. |br| |
| AF_INET6 | | | Allows to send and receive UDP datagrams. |
| | +------------------+---------------------------------------------------------------------------+
| | | IPPROTO_DTLS_1_x | Enabled if :kconfig:option:`CONFIG_NET_SOCKETS_ENABLE_DTLS` is set. |br| |
| | | | Allows to send and receive DTLS datagrams. |
| +-------------+------------------+---------------------------------------------------------------------------+
| | SOCK_STREAM | IPPROTO_TCP | Enabled if :kconfig:option:`CONFIG_NET_TCP` is set. |br| |
| | | | Allows to send and receive TCP data stream. |
| | +------------------+---------------------------------------------------------------------------+
| | | IPPROTO_TLS_1_x | Enabled if :kconfig:option:`CONFIG_NET_SOCKETS_SOCKOPT_TLS` is set. |br| |
| | | | Allows to send and receive TLS data stream. |
| +-------------+------------------+---------------------------------------------------------------------------+
| | SOCK_RAW | IPPROTO_IP |br| | Enabled if :kconfig:option:`CONFIG_NET_SOCKETS_INET_RAW` is set. |br| |
| | | <proto> | Allows to send and receive IPv4/IPv6 datagrams. |br| |
| | | | Packets are filtered by L4 protocol specified. |
| | | | IPPROTO_IP is a wildcard protocol to receive all IP datagrams. |
+--------------+-------------+------------------+---------------------------------------------------------------------------+
| AF_PACKET | SOCK_DGRAM | ETH_P_ALL |br| | Enabled if :kconfig:option:`CONFIG_NET_SOCKETS_PACKET_DGRAM` is set. |br| |
| | | <proto> | Allows to send and receive packets without L2 header. |br| |
| | | | Packets are filtered by L3 protocol specified. |
| | | | ETH_P_ALL is a wildcard protocol to receive all packets. |
| +-------------+------------------+---------------------------------------------------------------------------+
| | SOCK_RAW | ETH_P_ALL | Enabled if :kconfig:option:`CONFIG_NET_SOCKETS_PACKET` is set. |br| |
| | | | Allows to send and receive packets with L2 header included. |
+--------------+-------------+------------------+---------------------------------------------------------------------------+
| AF_CAN | SOCK_RAW | CAN_RAW | Enabled if :kconfig:option:`CONFIG_NET_SOCKETS_CAN` is set. |br| |
| | | | Allows to send and receive CAN packets. |
+--------------+-------------+------------------+---------------------------------------------------------------------------+
See :zephyr:code-sample:`sockets-echo-server` and :zephyr:code-sample:`sockets-echo-client`
sample applications to learn how to create a simple server or client BSD socket based
application.