Commit 9146237f authored by Jukka Rissanen's avatar Jukka Rissanen Committed by Anas Nashif
Browse files

doc: net: Enhance net_timeout API documentation 



Add overview to net_timeout API documentation.

Signed-off-by: default avatarJukka Rissanen <jukka.rissanen@linux.intel.com>
parent b364cf4b

doc/reference/networking/net_timeout.rst

+4 −0
Original line number Diff line number Diff line
@@ -6,6 +6,10 @@ Network Timeout 
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

*************

CRA Git | Maintained and supported by SUSTech CRA and CCSE