kaspar/RIOT
1
0
Fork 0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2025-12-25 22:43:50 +01:00
Code Releases Activity

sys/isrpipe: clarify state after timeout

Browse Source 
This patch documents what happens when a timeout occurs when
isrpipe_read_all_timeout() has been called.
This commit is contained in:
Joshua DeWeese 2025-04-02 15:22:20 -04:00 committed by Joshua DeWeese
parent 0f7c6a8481
commit 2c8e80d474
1 changed files with 6 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
sys/include/isrpipe/read_timeout.h
View File

@ -52,6 +52,12 @@ int isrpipe_read_timeout(isrpipe_t *isrpipe, uint8_t *buf, size_t count, uint32_
* This function is like @ref isrpipe_read_timeout, but will only return on
* timeout or when @p count bytes have been received.
*
* A timeout only occurs if no data is received within @p timeout microseconds.
* Each time a byte or burst of bytes is received, the timeout is reset.
*
* @note If a timeout occurs, some bytes may have been read out of the pipe and
* placed into @p buf.
*
* @param[in] isrpipe isrpipe object to operate on
* @param[in] buf buffer to write to
* @param[in] count number of bytes to read