Remove useless operation.

[simgrid.git] / include / amok / peermanagement.h

diff --git a/include/amok/peermanagement.h b/include/amok/peermanagement.h
index d7b8b74..0b3e8c6 100644 (file)
--- a/include/amok/peermanagement.h
+++ b/include/amok/peermanagement.h
@@ -1,8 +1,7 @@
-/* $Id$ */
-
 /* amok peer management - servers main loop and remote peer stopping        */
 
-/* Copyright (c) 2006 Martin Quinson. All rights reserved.                  */
+/* Copyright (c) 2006, 2007, 2008, 2009, 2010. The SimGrid Team.
+ * All rights reserved.                                                     */
 
 /* This program is free software; you can redistribute it and/or modify it
  * under the terms of the license (GNU LGPL) which comes with this package. */
@@ -11,7 +10,6 @@
 #define AMOK_PEER_MANAGEMENT_H
 
 #include <gras.h>
-#include <amok/base.h>
 
 /** \addtogroup AMOK_pm
  *  \brief Managing remote servers
@@ -45,30 +43,41 @@
  *      - 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(int) 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);
 
 
 /** @} */
-#endif /* AMOK_peer_MANAGEMENT_H */
+#endif                          /* AMOK_peer_MANAGEMENT_H */