zephyr/doc/reference/networking/net_timeout.rst
Jukka Rissanen 575040496d doc: net: Add table of contents to networking docs
This allows easy access to different part of the page.

Signed-off-by: Jukka Rissanen <jukka.rissanen@linux.intel.com>
2019-03-03 23:50:17 -05:00

23 lines
483 B
ReStructuredText

.. _net_timeout_interface:
Network Timeout
###############
.. contents::
:local:
:depth: 2
Overview
********
The ``k_delayed_work`` API has a 1 ms accuracy for a timeout value,
so the maximum timeout can be about 24 days. Some network timeouts
are longer than this, so the net_timeout API provides a generic timeout
mechanism that tracks such wraparounds and restarts the timeout as needed.
API Reference
*************
.. doxygengroup:: net_timeout
:project: Zephyr