Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Change the way we specify the sizes of bandwidth tests to be able to send really...
[simgrid.git] / include / amok / peermanagement.h
index d7b8b74..bd7689b 100644 (file)
@@ -11,7 +11,6 @@
 #define AMOK_PEER_MANAGEMENT_H
 
 #include <gras.h>
-#include <amok/base.h>
 
 /** \addtogroup AMOK_pm
  *  \brief Managing remote servers
  *      - wait a moment for the slaves registration (using gras_msg_handleall())
  *      - run its algoritpm. For this, it may call RPC on slaves, or explicitely wait (with gras_msg_wait()) for the answers it expects.
 
- *
+ * \section AMOK_pm_compat Compatibility issues
+ * 
+ * The API described here is as of SimGrid 3.2 and higher. In version 3.1
+ * (where this module were introduced), all functions were named amok_hm_*
+ * This was because the module used to be named HostManagement, but it was
+ * renamed before being released to betterly express its purpose.
+ * Unfortunately, the rename was not done properly before version 3.2.
+ * 
  * @{
  */
 
 /* module handling */
-void amok_pm_init(void);
-void amok_pm_exit(void);
+XBT_PUBLIC void amok_pm_init(void);
+XBT_PUBLIC void amok_pm_exit(void);
 
-void amok_pm_mainloop(double timeOut);
+XBT_PUBLIC void amok_pm_mainloop(double timeOut);
 
-void amok_pm_kill_hp(char *name,int port);
-void amok_pm_kill(gras_socket_t buddy);
-void amok_pm_kill_sync(gras_socket_t buddy);
+XBT_PUBLIC void amok_pm_kill_hp(char *name,int port);
+XBT_PUBLIC void amok_pm_kill(gras_socket_t buddy);
+XBT_PUBLIC void amok_pm_kill_sync(gras_socket_t buddy);
 
-xbt_dynar_t amok_pm_group_new(const char *group_name);
-xbt_dynar_t amok_pm_group_get(gras_socket_t master, const char *group_name);
+XBT_PUBLIC xbt_dynar_t amok_pm_group_new(const char *group_name);
+XBT_PUBLIC xbt_dynar_t amok_pm_group_get(gras_socket_t master, const char *group_name);
 
-void        amok_pm_group_join(gras_socket_t master, const char *group_name);
-void        amok_pm_group_leave(gras_socket_t master, const char *group_name);
+XBT_PUBLIC void        amok_pm_group_join(gras_socket_t master, const char *group_name);
+XBT_PUBLIC void        amok_pm_group_leave(gras_socket_t master, const char *group_name);
 
 
-void amok_pm_group_shutdown(const char *group_name);
-void amok_pm_group_shutdown_remote(gras_socket_t master, const char *group_name);
+XBT_PUBLIC void amok_pm_group_shutdown(const char *group_name);
+XBT_PUBLIC void amok_pm_group_shutdown_remote(gras_socket_t master, const char *group_name);
 
 
 /** @} */