941f43588a
As the net-app API is removed, the documentation links to it need to be removed. Signed-off-by: Jukka Rissanen <jukka.rissanen@linux.intel.com>
212 lines
3.4 KiB
ReStructuredText
212 lines
3.4 KiB
ReStructuredText
.. _networking_api:
|
|
|
|
Networking API
|
|
##############
|
|
|
|
.. contents::
|
|
:depth: 2
|
|
:local:
|
|
:backlinks: top
|
|
|
|
This is the full set of networking public APIs. Their exposure
|
|
depends on relevant Kconfig options. For instance IPv6 related
|
|
APIs will not be present if :option:`CONFIG_NET_IPV6` has not
|
|
been selected.
|
|
|
|
.. comment
|
|
not documenting
|
|
.. doxygengroup:: networking
|
|
.. doxygengroup:: arp
|
|
|
|
Network core helpers
|
|
********************
|
|
|
|
.. doxygengroup:: net_core
|
|
:project: Zephyr
|
|
|
|
Network buffers
|
|
***************
|
|
|
|
.. doxygengroup:: net_buf
|
|
:project: Zephyr
|
|
|
|
Network packet management
|
|
*************************
|
|
|
|
.. doxygengroup:: net_pkt
|
|
:project: Zephyr
|
|
|
|
IPv4/IPv6 primitives and helpers
|
|
********************************
|
|
|
|
.. doxygengroup:: ip_4_6
|
|
:project: Zephyr
|
|
|
|
Network interface
|
|
*****************
|
|
|
|
.. doxygengroup:: net_if
|
|
:project: Zephyr
|
|
|
|
Network Management
|
|
******************
|
|
|
|
.. doxygengroup:: net_mgmt
|
|
:project: Zephyr
|
|
|
|
Network layer 2 management
|
|
**************************
|
|
|
|
.. doxygengroup:: net_l2
|
|
:project: Zephyr
|
|
|
|
Network link address
|
|
********************
|
|
|
|
.. doxygengroup:: net_linkaddr
|
|
:project: Zephyr
|
|
|
|
Application network context
|
|
***************************
|
|
|
|
.. doxygengroup:: net_context
|
|
:project: Zephyr
|
|
|
|
BSD Sockets compatible API
|
|
**************************
|
|
|
|
.. doxygengroup:: bsd_sockets
|
|
:project: Zephyr
|
|
|
|
Network configuration library
|
|
*****************************
|
|
|
|
.. doxygengroup:: net_config
|
|
:project: Zephyr
|
|
|
|
Network long timeout support
|
|
****************************
|
|
|
|
.. doxygengroup:: net_timeout
|
|
:project: Zephyr
|
|
|
|
Network offloading support
|
|
**************************
|
|
|
|
.. doxygengroup:: net_offload
|
|
:project: Zephyr
|
|
|
|
Network statistics
|
|
******************
|
|
|
|
.. doxygengroup:: net_stats
|
|
:project: Zephyr
|
|
|
|
Precision Time Protocol time
|
|
****************************
|
|
|
|
.. doxygengroup:: ptp_time
|
|
:project: Zephyr
|
|
|
|
Promiscuous mode support
|
|
************************
|
|
|
|
.. doxygengroup:: promiscuous
|
|
:project: Zephyr
|
|
|
|
Trickle timer support
|
|
*********************
|
|
|
|
.. doxygengroup:: trickle
|
|
:project: Zephyr
|
|
|
|
UDP
|
|
***
|
|
|
|
.. doxygengroup:: udp
|
|
:project: Zephyr
|
|
|
|
Hostname Configuration Library
|
|
******************************
|
|
|
|
.. doxygengroup:: net_hostname
|
|
:project: Zephyr
|
|
|
|
generic Precision Time Protocol (gPTP)
|
|
**************************************
|
|
|
|
.. doxygengroup:: gptp
|
|
:project: Zephyr
|
|
|
|
Network technologies
|
|
********************
|
|
|
|
Ethernet
|
|
========
|
|
|
|
.. doxygengroup:: ethernet
|
|
:project: Zephyr
|
|
|
|
Ethernet Management
|
|
===================
|
|
|
|
.. doxygengroup:: ethernet_mgmt
|
|
:project: Zephyr
|
|
|
|
Virtual LAN definitions and helpers
|
|
===================================
|
|
|
|
.. doxygengroup:: vlan
|
|
:project: Zephyr
|
|
|
|
Link Layer Discovery Protocol definitions and helpers
|
|
=====================================================
|
|
|
|
.. doxygengroup:: lldp
|
|
:project: Zephyr
|
|
|
|
IEEE 802.15.4
|
|
=============
|
|
|
|
.. doxygengroup:: ieee802154
|
|
:project: Zephyr
|
|
|
|
IEEE 802.15.4 Management
|
|
========================
|
|
|
|
.. doxygengroup:: ieee802154_mgmt
|
|
:project: Zephyr
|
|
|
|
Network and application libraries
|
|
*********************************
|
|
|
|
DHCPv4
|
|
======
|
|
|
|
.. doxygengroup:: dhcpv4
|
|
:project: Zephyr
|
|
|
|
MQTT 3.1.1
|
|
==========
|
|
|
|
.. doxygengroup:: mqtt_socket
|
|
:project: Zephyr
|
|
|
|
CoAP over Sockets
|
|
=================
|
|
|
|
.. doxygengroup:: coap_sock
|
|
:project: Zephyr
|
|
|
|
DNS Resolve
|
|
===========
|
|
|
|
.. doxygengroup:: dns_resolve
|
|
:project: Zephyr
|
|
|
|
TLS credentials
|
|
***************
|
|
|
|
.. doxygengroup:: tls_credentials
|
|
:project: Zephyr
|