Merge doc of platform mgmt functions into simulation control ones

[simgrid.git] / src / msg / msg_host.c

diff --git a/src/msg/msg_host.c b/src/msg/msg_host.c
index 0dfb100..ce32fdf 100644 (file)
--- a/src/msg/msg_host.c
+++ b/src/msg/msg_host.c
@@ -59,6 +59,25 @@ m_host_t __MSG_host_create(smx_host_t workstation, void *data)
   return host;
 }
 
+/** \ingroup msg_host_management
+ * \brief Finds a m_host_t using its name.
+ *
+ * This is a name directory service
+ * \param name the name of an host.
+ * \return the corresponding host
+ */
+m_host_t MSG_get_host_by_name(const char *name)
+{
+  smx_host_t simix_h = NULL;
+  simix_h = simcall_host_get_by_name(name);
+
+  if (simix_h == NULL)
+    return NULL;
+
+  return (m_host_t) simcall_host_get_data(simix_h);
+}
+
+
 /** \ingroup m_host_management
  *
  * \brief Set the user data of a #m_host_t.
@@ -240,10 +259,11 @@ xbt_dict_t MSG_host_get_properties(m_host_t host)
 /** \ingroup msg_gos_functions
  * \brief Determine if a host is available.
  *
- * \param h host to test
+ * \param host host to test
+ * \return Returns 1 if host is available, 0 otherwise
  */
-int MSG_host_is_avail(m_host_t h)
+int MSG_host_is_avail(m_host_t host)
 {
-  xbt_assert((h != NULL), "Invalid parameters (host is NULL)");
-  return (simcall_host_get_state(h->simdata->smx_host));
+  xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
+  return (simcall_host_get_state(host->simdata->smx_host));
 }