zephyr/doc/guides/networking/networking-api-usage.rst
David B. Kinder 505cc2bb0e doc: use :zephyr_file: where appropriate
A new role :zephyr_file: is available that renders to a link to the file
or folder in GitHub.  Find appropriate references using :file: and
convert to :zephyr_file: to take advantage of its linking capability.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-03-09 09:50:27 -05:00

17 lines
635 B
ReStructuredText

.. _networking_api_usage:
Network Connectivity API
########################
Applications should use the BSD socket API defined in
:zephyr_file:`include/net/socket.h` to create a connection, send or receive data,
and close a connection. The same API can be used when working with UDP or
TCP data. See :ref:`BSD socket API <bsd_sockets_interface>` for more details.
See :ref:`sockets-echo-server-sample` and :ref:`sockets-echo-client-sample`
applications how to create a simple server or client BSD socket based
application.
The legacy connectivity API in :zephyr_file:`include/net/net_context.h` should not be
used by applications.