diff mbox series

bindings: cxx: clarify the meaning of negative timeouts in event wait

Message ID 20230523130504.151607-1-brgl@bgdev.pl
State New
Headers show
Series bindings: cxx: clarify the meaning of negative timeouts in event wait | expand

Commit Message

Bartosz Golaszewski May 23, 2023, 1:05 p.m. UTC 
From: Bartosz Golaszewski <bartosz.golaszewski@linaro.org>

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 <bartosz.golaszewski@linaro.org>
---
 bindings/cxx/gpiodcxx/chip.hpp         | 5 ++++-
 bindings/cxx/gpiodcxx/line-request.hpp | 5 ++++-
 2 files changed, 8 insertions(+), 2 deletions(-)
diff mbox series

Patch

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.
 	 */