Make mailbox matching functions return a bool.

[simgrid.git] / include / simgrid / host.h

diff --git a/include/simgrid/host.h b/include/simgrid/host.h
index d65ace3..a7cce00 100644 (file)
--- a/include/simgrid/host.h
+++ b/include/simgrid/host.h
@@ -1,4 +1,4 @@
-/* Copyright (c) 2013-2018. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2013-2019. 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. */
@@ -10,7 +10,7 @@
 #include <xbt/dynar.h>
 #include <simgrid/forward.h>
 
-SG_BEGIN_DECL()
+SG_BEGIN_DECL
 /** @brief Host datatype.
  *
  *   A <em>location</em> (or <em>host</em>) is any possible place where an actor may run. Thus it is represented as a
@@ -47,15 +47,18 @@ XBT_PUBLIC const char* sg_host_get_name(sg_host_t host);
 // ========== User Data ==============
 /** @brief Return the user data of a #sg_host_t.
  *
- * This functions returns the user data associated to @a host if it is possible.
+ * This functions returns the user data associated to @a host if any.
  */
-XBT_PUBLIC void* sg_host_user(sg_host_t host);
+XBT_PUBLIC void* sg_host_data(sg_host_t host);
+XBT_ATTRIB_DEPRECATED_v328("Please use sg_host_data()") XBT_PUBLIC void* sg_host_user(sg_host_t host);
 /** @brief Set the user data of a #sg_host_t.
  *
- * This functions attach @a data to @a host if it is possible.
+ * This functions attach @a data to @a host.
  */
-XBT_PUBLIC void sg_host_user_set(sg_host_t host, void* userdata);
-XBT_PUBLIC void sg_host_user_destroy(sg_host_t host);
+XBT_PUBLIC void sg_host_data_set(sg_host_t host, void* userdata);
+XBT_ATTRIB_DEPRECATED_v328("Please use sg_host_data_set()") XBT_PUBLIC
+    void sg_host_user_set(sg_host_t host, void* userdata);
+XBT_ATTRIB_DEPRECATED_v328("Please use sg_host_data_set(h, NULL)") XBT_PUBLIC void sg_host_user_destroy(sg_host_t host);
 
 // ========= storage related functions ============
 /** @brief Return the list of mount point names on an host.
@@ -101,7 +104,6 @@ XBT_PUBLIC void sg_host_set_pstate(sg_host_t host, int pstate);
 XBT_PUBLIC void sg_host_turn_on(sg_host_t host);
 XBT_PUBLIC void sg_host_turn_off(sg_host_t host);
 XBT_PUBLIC int sg_host_is_on(sg_host_t host);
-XBT_PUBLIC int sg_host_is_off(sg_host_t host);
 
 /** @ingroup m_host_management
  * @brief Returns a xbt_dict_t consisting of the list of properties assigned to this host
@@ -132,9 +134,11 @@ XBT_PUBLIC void sg_host_set_property_value(sg_host_t host, const char* name, con
 XBT_PUBLIC void sg_host_route(sg_host_t from, sg_host_t to, xbt_dynar_t links);
 XBT_PUBLIC double sg_host_route_latency(sg_host_t from, sg_host_t to);
 XBT_PUBLIC double sg_host_route_bandwidth(sg_host_t from, sg_host_t to);
+void sg_host_send_to(sg_host_t from, sg_host_t to, double byte_amount);
+
 XBT_PUBLIC void sg_host_dump(sg_host_t ws);
 
 XBT_PUBLIC void sg_host_get_actor_list(sg_host_t host, xbt_dynar_t whereto);
-SG_END_DECL()
+SG_END_DECL
 
 #endif /* SIMGRID_HOST_H_ */