judsonupchurch/nanoMODBUS
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Better docs for platform funcs' byte_timeout_ms

Browse Source
This commit is contained in:
Valerio De Benedetto 2024-11-25 13:30:51 +01:00
parent b8d247f329
commit 85dd33d6dc
2 changed files with 6 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -119,7 +119,9 @@ Both methods should block until either:
- `count` bytes of data are read/written
- the byte timeout, with `byte_timeout_ms >= 0`, expires
A value `< 0` for `byte_timeout_ms` means no timeout.
A value `< 0` for `byte_timeout_ms` means infinite timeout.
With a value `== 0` for `byte_timeout_ms`, the method should read/write once in a non-blocking fashion and return
immediately.
Their return value should be the number of bytes actually read/written, or `< 0` in case of error.
A return value between `0` and `count - 1` will be treated as if a timeout occurred on the transport side. All other

4
nanomodbus.h
View File

@ -134,7 +134,9 @@ typedef enum nmbs_transport {
* - `count` bytes of data are read/written
* - the byte timeout, with `byte_timeout_ms >= 0`, expires
*
* A value `< 0` for `byte_timeout_ms` means no timeout.
* A value `< 0` for `byte_timeout_ms` means infinite timeout.
* With a value `== 0` for `byte_timeout_ms`, the method should read/write once in a non-blocking fashion and return immediately.
*
*
* Their return value should be the number of bytes actually read/written, or `< 0` in case of error.
* A return value between `0` and `count - 1` will be treated as if a timeout occurred on the transport side. All other