Skip to content

Commit 691cca4

Browse files
nuttxsacassis
authored andcommitted
11_network.rst: Add a "Network Interfaces Overview" section and
reorganize the content structure: - Add the new "Network Interfaces Overview" section - Reorganize the document structure and optimize formatting Signed-off-by: nuttxs <zhaoqing.zhang@sony.com>
1 parent 2440b4e commit 691cca4

File tree

1 file changed

+34
-3
lines changed

1 file changed

+34
-3
lines changed

Documentation/reference/user/11_network.rst

Lines changed: 34 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,43 @@
22
Network Interfaces
33
==================
44

5+
.. _network_interfaces_overview:
6+
7+
Network Interfaces Overview
8+
============================
9+
10+
**Overview**. NuttX includes a comprehensive network stack that provides
11+
standard BSD socket interface and DNS resolution capabilities. The network
12+
subsystem is optional and can be configured based on application requirements.
13+
14+
**BSD Socket Interface**. NuttX supports a BSD-compatible socket interface layer
15+
that provides familiar networking APIs for application developers. These socket
16+
interfaces can be enabled by settings in the architecture configuration file.
17+
The socket layer supports multiple protocol families including IPv4 (AF_INET)
18+
and IPv6 (AF_INET6), as well as various socket types such as stream sockets
19+
(SOCK_STREAM), datagram sockets (SOCK_DGRAM), and raw sockets.
20+
21+
**DNS Resolution**. The NuttX network stack includes a lightweight DNS resolver
22+
that allows applications to resolve hostnames to IP addresses. The DNS resolver
23+
supports multiple nameservers, both IPv4 and IPv6 queries, and provides a
24+
callback mechanism for nameserver change notifications.
25+
26+
**Programming Interface**. The network interfaces provided by NuttX closely
27+
follow POSIX standards, making it easy to port existing network applications
28+
to NuttX.
29+
30+
Network Functions
31+
=================
32+
33+
Socket Functions (``sys/socket.h``)
34+
-----------------------------------
35+
536
NuttX supports a BSD-compatible socket interface layer. These socket
637
interface can be enabled by settings in the architecture configuration
738
file. Those socket APIs are discussed in
839
the following paragraphs.
940

41+
1042
- :c:func:`socket`
1143
- :c:func:`bind`
1244
- :c:func:`connect`
@@ -413,9 +445,8 @@ the following paragraphs.
413445
- ``NOBUFS``. Insufficient resources are available in the system to
414446
complete the call.
415447
416-
=============
417-
DNS Functions
418-
=============
448+
DNS Functions (``net/dns.h``)
449+
-----------------------------------
419450
420451
NuttX provides DNS resolver functions for configuring and managing DNS
421452
servers. These functions are defined in ``nuttx/net/dns.h`` and allow

0 commit comments

Comments
 (0)