Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
xbt_cond_timedwait: catch C++ timeouts; convert into a C-complient return
[simgrid.git] / include / xbt / synchro.h
index ba772f7..e5f7d06 100644 (file)
@@ -58,9 +58,9 @@ XBT_PUBLIC(xbt_cond_t) xbt_cond_init(void);
 
 /** @brief Blocks onto the given condition variable */
 XBT_PUBLIC(void) xbt_cond_wait(xbt_cond_t cond, xbt_mutex_t mutex);
-/** @brief Blocks onto the given condition variable, but only for the given amount of time. a timeout exception is
- *   raised if it was impossible to acquire it in the given time frame */
-XBT_PUBLIC(void) xbt_cond_timedwait(xbt_cond_t cond, xbt_mutex_t mutex, double delay);
+/** @brief Blocks onto the given condition variable, but only for the given amount of time.
+ *  @return 0 on success, 1 on timeout */
+XBT_PUBLIC(int) xbt_cond_timedwait(xbt_cond_t cond, xbt_mutex_t mutex, double delay);
 /** @brief Signals the given mutex variable */
 XBT_PUBLIC(void) xbt_cond_signal(xbt_cond_t cond);
 /** @brief Broadcasts the given mutex variable */