From: Bartosz Golaszewski Date: Tue, 23 May 2023 13:01:34 +0000 (+0200) Subject: bindings: cxx: clarify the meaning of negative timeouts in event wait X-Git-Url: http://git.maquefel.me/?a=commitdiff_plain;h=8f3cd2b6b4c4038a8f87cd89d78edb0ec2c9dff6;p=qemu-gpiodev%2Flibgpiod.git bindings: cxx: clarify the meaning of negative timeouts in event wait 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 --- diff --git a/bindings/cxx/gpiodcxx/chip.hpp b/bindings/cxx/gpiodcxx/chip.hpp index 2553f8c..e8b3c0f 100644 --- a/bindings/cxx/gpiodcxx/chip.hpp +++ b/bindings/cxx/gpiodcxx/chip.hpp @@ -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. */ diff --git a/bindings/cxx/gpiodcxx/line-request.hpp b/bindings/cxx/gpiodcxx/line-request.hpp index 54a4e00..c1e1520 100644 --- a/bindings/cxx/gpiodcxx/line-request.hpp +++ b/bindings/cxx/gpiodcxx/line-request.hpp @@ -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. */