mpm: Add mpmutils module, includes poll_with_timeout

This is a convenience function for polling with sleeps and timeouts.

1 files changed, 38 insertions, 0 deletions

diff --git a/mpm/python/usrp_mpm/mpmutils.py b/mpm/python/usrp_mpm/mpmutils.py
new file mode 100644
index 000000000..ad4457419
--- /dev/null
+++ b/mpm/python/usrp_mpm/mpmutils.py
@@ -0,0 +1,38 @@
+#
+# Copyright 2017 Ettus Research, National Instruments Company
+#
+# SPDX-License-Identifier: GPL-3.0
+#
+"""
+Miscellaneous utilities for MPM
+"""
+
+import time
+
+def poll_with_timeout(state_check, timeout_ms, interval_ms):
+    """
+    Calls state_check() every interval_ms until it returns a positive value, or
+    until a timeout is exceeded.
+
+    Returns True if state_check() returned True within the timeout.
+
+    Arguments:
+    state_check -- Functor that returns a Boolean success value, and takes no
+                   arguments.
+    timeout_ms -- The total timeout in milliseconds. state_check() has to
+                  return True within this time.
+    interval_ms -- Sleep time between calls to state_check(). Note that if
+                   interval_ms is larger than timeout_ms, state_check() will be
+                   called exactly once, and then poll_with_timeout() will still
+                   sleep for interval_ms milliseconds. Typically, interval_ms
+                   should be chosen much smaller than timeout_ms, but not too
+                   small for this to become a busy loop.
+    """
+    max_time = time.time() + (float(timeout_ms) / 1000)
+    interval_s = float(interval_ms) / 1000
+    while time.time() < max_time:
+        if state_check():
+            return True
+        time.sleep(interval_s)
+    return False
+