bindings: cxx: clarify the meaning of negative timeouts in event wait
PATCH 1/1 bindings: cxx: clarify the meaning of negative timeouts in event wait
From: Bartosz Golaszewski <[email protected]>
chip::wait_info_event() and line_request::wait_edge_events() behave the same as their C counterparts in that they block indefinitely when passed a negative timeout value. State it explicitly in the docs.
Signed-off-by Bartosz Golaszewski <[email protected]>
--- bindings/cxx/gpiodcxx/chip.hpp | 5 ++++- bindings/cxx/gpiodcxx/line-request.hpp | 5 ++++- 2 files changed, 8 insertions(+), 2 deletions(-)
bindings/cxx/gpiodcxx/chip.hpp +4 -1
@@ -125,7 +125,10 @@ public: /** * @brief Wait for line status events on any of the watched lines * exposed by this chip. - * @param timeout Wait time limit in nanoseconds. + * @param timeout Wait time limit in nanoseconds. If set to 0, the + * function returns immediatelly. If set to a negative + * number, the function blocks indefinitely until an + * event becomes available. * @return True if at least one event is ready to be read. False if the * wait timed out. */
bindings/cxx/gpiodcxx/line-request.hpp +4 -1
@@ -176,7 +176,10 @@ public: /** * @brief Wait for edge events on any of the lines requested with edge * detection enabled. - * @param timeout Wait time limit in nanoseconds. + * @param timeout Wait time limit in nanoseconds. If set to 0, the + * function returns immediatelly. If set to a negative + * number, the function blocks indefinitely until an + * event becomes available. * @return True if at least one event is ready to be read. False if the * wait timed out. */
Signature · 1 line
2.39.2