Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
s/xbt_host_t/xbt_peer_t/
[simgrid.git] / include / xbt / config.h
index 27b927a..25254ad 100644 (file)
@@ -19,11 +19,6 @@ SG_BEGIN_DECL()
 /** @addtogroup XBT_config
  *  @brief Changing the configuration of SimGrid components (grounding feature)
  *
- * <center><table><tr><td><b>Top</b>    <td> [\ref index]::[\ref XBT_API]
- *                <tr><td><b>Prev</b>   <td> [\ref XBT_error]
- *                <tr><td><b>Next</b>   <td> [\ref XBT_dynar]       
- *                <tr><td><b>Down</b>   <td> [\ref XBT_cfg_use]        </table></center>
- *
  *  All modules of the SimGrid toolkit can be configured with this API. 
  *  User modules and libraries can also use these facilities to handle 
  *  their own configuration.
@@ -82,10 +77,6 @@ SG_BEGIN_DECL()
 /** @defgroup XBT_cfg_use User interface: changing values
  *  @ingroup XBT_config
  *
- * <center><table><tr><td><b>Top</b>    <td> [\ref index]::[\ref XBT_API]::[\ref XBT_config]
- *                <tr><td>   Prev       <td> 
- *                <tr><td><b>Next</b>   <td> [\ref XBT_cfg_decl]        </table></center>
- *
  * This is the only interface you should use unless you want to let your 
  * own code become configurable with this.
  *
@@ -116,8 +107,8 @@ void xbt_cfg_set_double(xbt_cfg_t cfg, const char *name,
                        double val);
 void xbt_cfg_set_string(xbt_cfg_t cfg, const char *name, 
                        const char *val);
-void xbt_cfg_set_host  (xbt_cfg_t cfg, const char *name, 
-                       const char *host,int port);
+void xbt_cfg_set_peer  (xbt_cfg_t cfg, const char *name, 
+                       const char *peer,int port);
 
 /*
  Remove the provided value from the cell @name in @cfg.
@@ -128,8 +119,8 @@ void xbt_cfg_rm_double(xbt_cfg_t cfg, const char *name,
                       double val);
 void xbt_cfg_rm_string(xbt_cfg_t cfg, const char *name, 
                       const char *val);
-void xbt_cfg_rm_host  (xbt_cfg_t cfg, const char *name, 
-                      const char *host,int port);
+void xbt_cfg_rm_peer  (xbt_cfg_t cfg, const char *name, 
+                      const char *peer,int port);
                                  
 /*
  Remove the value at position \e pos from the config \e cfg
@@ -144,10 +135,6 @@ void xbt_cfg_empty(xbt_cfg_t cfg, const char *name);
 /** @defgroup XBT_cfg_decl Configuration type declaration and memory management
  *  @ingroup XBT_config
  *
- * <center><table><tr><td><b>Top</b>    <td> [\ref index]::[\ref XBT_API]::[\ref XBT_config]
- *                <tr><td><b>Prev</b>   <td> [\ref XBT_cfg_use]
- *                <tr><td><b>Next</b>   <td> [\ref XBT_cfg_register]        </table></center>
- *
  *  @{
  */
 
@@ -156,7 +143,7 @@ void xbt_cfg_empty(xbt_cfg_t cfg, const char *name);
     xbt_cfgelm_int=0,  /**< int */
     xbt_cfgelm_double, /**< double */
     xbt_cfgelm_string, /**< char* */
-    xbt_cfgelm_host,   /**< both a char* (representing the hostname) and an integer (representing the port) */
+    xbt_cfgelm_peer,   /**< both a char* (representing the peername) and an integer (representing the port) */
     
     xbt_cfgelm_any,    /* not shown to users to prevent errors */
     xbt_cfgelm_type_count 
@@ -175,10 +162,6 @@ void xbt_cfg_empty(xbt_cfg_t cfg, const char *name);
 /** @defgroup XBT_cfg_register  Registering stuff
  *  @ingroup XBT_config
  *
- * <center><table><tr><td><b>Top</b>    <td> [\ref index]::[\ref XBT_API]::[\ref XBT_config]
- *                <tr><td><b>Prev</b>   <td> [\ref XBT_cfg_decl]
- *                <tr><td><b>Next</b>   <td> [\ref XBT_cfg_get]        </table></center>
- *
  *  This how to add new variables to an existing configuration set. Use it to make your code 
  *  configurable.
  *
@@ -196,10 +179,6 @@ void xbt_cfg_empty(xbt_cfg_t cfg, const char *name);
 /** @defgroup XBT_cfg_get Getting the stored values
  *  @ingroup XBT_config
  *
- * <center><table><tr><td><b>Top</b>    <td> [\ref index]::[\ref XBT_API]::[\ref XBT_config]
- *                <tr><td><b>Prev</b>   <td> [\ref XBT_cfg_register]
- *                <tr><td>   Next       <td>         </table></center>
- *
  * This is how to retrieve the values stored in the configuration set. This is only 
  * intended to configurable code, naturally.
  *
@@ -214,13 +193,13 @@ void xbt_cfg_empty(xbt_cfg_t cfg, const char *name);
   int         xbt_cfg_get_int   (xbt_cfg_t cfg, const char *name);
   double      xbt_cfg_get_double(xbt_cfg_t cfg, const char *name);
   char*       xbt_cfg_get_string(xbt_cfg_t cfg, const char *name);
-  void        xbt_cfg_get_host  (xbt_cfg_t cfg, const char *name, char  **host, int *port);
+  void        xbt_cfg_get_peer  (xbt_cfg_t cfg, const char *name, char  **peer, int *port);
   xbt_dynar_t xbt_cfg_get_dynar (xbt_cfg_t cfg, const char *name);
 
   int    xbt_cfg_get_int_at   (xbt_cfg_t cfg, const char *name, int pos);
   double xbt_cfg_get_double_at(xbt_cfg_t cfg, const char *name, int pos);
   char*  xbt_cfg_get_string_at(xbt_cfg_t cfg, const char *name, int pos);
-  void   xbt_cfg_get_host_at  (xbt_cfg_t cfg, const char *name, int pos, char  **host, int *port);
+  void   xbt_cfg_get_peer_at  (xbt_cfg_t cfg, const char *name, int pos, char  **peer, int *port);
 
 /** @} */