mirror of
https://github.com/zephyrproject-rtos/zephyr
synced 2025-09-15 14:31:56 +00:00
c8954d3544
CoAP library is migrated to support over socket based applications or other higher layer protocols. Most of the API's and functionality is kept as it is except few changes. net_pkt/net_buf is removed from CoAP library. Now it expects a pre-allocated flat buffer and length. If there is not enough space to append any data, library simply returns an error. It's user's responsibility to allocate and free memory. One change in functionality is, earlier coap_pending_clear() used to clear the memory, but now it's user's responsibility to free the memory. Signed-off-by: Ravi kumar Veeramally <ravikumar.veeramally@linux.intel.com>
206 lines
3.2 KiB
ReStructuredText
206 lines
3.2 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 offloading support
|
|
**************************
|
|
|
|
.. doxygengroup:: net_offload
|
|
:project: Zephyr
|
|
|
|
Network statistics
|
|
******************
|
|
|
|
.. doxygengroup:: net_stats
|
|
: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
|
|
*********************************
|
|
|
|
Network application
|
|
===================
|
|
|
|
.. doxygengroup:: net_app
|
|
:project: Zephyr
|
|
|
|
DHCPv4
|
|
======
|
|
|
|
.. doxygengroup:: dhcpv4
|
|
:project: Zephyr
|
|
|
|
MQTT 3.1.1
|
|
==========
|
|
|
|
.. doxygengroup:: mqtt
|
|
:project: Zephyr
|
|
|
|
CoAP over Sockets
|
|
=================
|
|
|
|
.. doxygengroup:: coap_sock
|
|
:project: Zephyr
|
|
|
|
DNS Resolve
|
|
===========
|
|
|
|
.. doxygengroup:: dns_resolve
|
|
:project: Zephyr
|
|
|
|
HTTP
|
|
====
|
|
|
|
.. doxygengroup:: http
|
|
:project: Zephyr
|
|
|
|
Websocket
|
|
=========
|
|
|
|
.. doxygengroup:: websocket
|
|
:project: Zephyr
|
|
|
|
Websocket console
|
|
=================
|
|
|
|
.. doxygengroup:: websocket_console
|
|
:project: Zephyr
|