Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
deprecate xbt_mutex and xbt_cond
[simgrid.git] / include / xbt / synchro.h
index 96d7556..c57b925 100644 (file)
@@ -34,10 +34,10 @@ typedef struct s_smx_mutex_* xbt_mutex_t;
 #endif
 
 /** @brief Creates a new mutex variable */
 #endif
 
 /** @brief Creates a new mutex variable */
-XBT_PUBLIC xbt_mutex_t xbt_mutex_init(void);
+XBT_ATTRIB_DEPRECATED_v327("Please use sg_mutex_init") XBT_PUBLIC xbt_mutex_t xbt_mutex_init(void);
 
 /** @brief Blocks onto the given mutex variable */
 
 /** @brief Blocks onto the given mutex variable */
-XBT_PUBLIC void xbt_mutex_acquire(xbt_mutex_t mutex);
+XBT_ATTRIB_DEPRECATED_v327("Please use sg_mutex_lock") XBT_PUBLIC void xbt_mutex_acquire(xbt_mutex_t mutex);
 
 /** @brief Tries to block onto the given mutex variable
  * Tries to lock a mutex, return 1 if the mutex is unlocked, else 0.
 
 /** @brief Tries to block onto the given mutex variable
  * Tries to lock a mutex, return 1 if the mutex is unlocked, else 0.
@@ -45,13 +45,13 @@ XBT_PUBLIC void xbt_mutex_acquire(xbt_mutex_t mutex);
  * @param mutex The mutex
  * @return 1 - mutex free, 0 - mutex used
  */
  * @param mutex The mutex
  * @return 1 - mutex free, 0 - mutex used
  */
-XBT_PUBLIC int xbt_mutex_try_acquire(xbt_mutex_t mutex);
+XBT_ATTRIB_DEPRECATED_v327("Please use sg_mutex_try_lock") XBT_PUBLIC int xbt_mutex_try_acquire(xbt_mutex_t mutex);
 
 /** @brief Releases the given mutex variable */
 
 /** @brief Releases the given mutex variable */
-XBT_PUBLIC void xbt_mutex_release(xbt_mutex_t mutex);
+XBT_ATTRIB_DEPRECATED_v327("Please use sg_mutex_unlock") XBT_PUBLIC void xbt_mutex_release(xbt_mutex_t mutex);
 
 /** @brief Destroyes the given mutex variable */
 
 /** @brief Destroyes the given mutex variable */
-XBT_PUBLIC void xbt_mutex_destroy(xbt_mutex_t mutex);
+XBT_ATTRIB_DEPRECATED_v327("Please use sg_mutex_destroy") XBT_PUBLIC void xbt_mutex_destroy(xbt_mutex_t mutex);
 
 /** @brief Thread condition data type (opaque object)
  *  @hideinitializer
 
 /** @brief Thread condition data type (opaque object)
  *  @hideinitializer
@@ -63,19 +63,20 @@ typedef struct s_smx_cond_* xbt_cond_t;
 #endif
 
 /** @brief Creates a condition variable */
 #endif
 
 /** @brief Creates a condition variable */
-XBT_PUBLIC xbt_cond_t xbt_cond_init(void);
+XBT_ATTRIB_DEPRECATED_v327("Please use sg_cond_init") XBT_PUBLIC xbt_cond_t xbt_cond_init(void);
 
 /** @brief Blocks onto the given condition variable */
 
 /** @brief Blocks onto the given condition variable */
-XBT_PUBLIC void xbt_cond_wait(xbt_cond_t cond, xbt_mutex_t mutex);
+XBT_ATTRIB_DEPRECATED_v327("Please use sg_cond_wait") 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.
  *  @return 0 on success, 1 on timeout */
 /** @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);
+XBT_ATTRIB_DEPRECATED_v327("Please use sg_cond_wait_for") XBT_PUBLIC
+    int xbt_cond_timedwait(xbt_cond_t cond, xbt_mutex_t mutex, double delay);
 /** @brief Signals the given mutex variable */
 /** @brief Signals the given mutex variable */
-XBT_PUBLIC void xbt_cond_signal(xbt_cond_t cond);
+XBT_ATTRIB_DEPRECATED_v327("Please use sg_cond_notify_one") XBT_PUBLIC void xbt_cond_signal(xbt_cond_t cond);
 /** @brief Broadcasts the given mutex variable */
 /** @brief Broadcasts the given mutex variable */
-XBT_PUBLIC void xbt_cond_broadcast(xbt_cond_t cond);
+XBT_ATTRIB_DEPRECATED_v327("Please use sg_cond_notify_all") XBT_PUBLIC void xbt_cond_broadcast(xbt_cond_t cond);
 /** @brief Destroys the given mutex variable */
 /** @brief Destroys the given mutex variable */
-XBT_PUBLIC void xbt_cond_destroy(xbt_cond_t cond);
+XBT_ATTRIB_DEPRECATED_v327("Please use sg_cond_destroy") XBT_PUBLIC void xbt_cond_destroy(xbt_cond_t cond);
 
 /** @} */
 
 
 /** @} */