Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
s/gras_process_getpid/gras_os_getpid/
[simgrid.git] / include / gras / virtu.h
index d925db8..aab294e 100644 (file)
 
 #include "xbt/misc.h" /* BEGIN_DECL */
 
-BEGIN_DECL
-
-/**
- * gras_os_time:
- * @Returns: number of second since the Epoch.
- * (00:00:00 UTC, January 1, 1970 in Real Life, and begining of simulation in SG)
- * 
- * Get the current time.
+BEGIN_DECL()
+
+/** @addtogroup GRAS_virtu  
+ *  @brief System call abstraction layer (Virtualization).
+ *  @{
+ */
+
+/** @brief Get the current time
+ *  @return number of second since the Epoch.
+ *  (00:00:00 UTC, January 1, 1970 in Real Life, and begining of simulation in SG)
  */
 double gras_os_time(void);
 
-/**
- * gras_os_sleep:
- * @Param1: number of seconds to sleep
- * @Param2: number of microseconds to sleep
- * 
- * sleeps for the given amount of time.
+/** @brief sleeps for the given amount of time.
+ *  @param sec: number of seconds to sleep
  */
-void gras_os_sleep(unsigned long sec, unsigned long usec);
+void gras_os_sleep(double sec);
 
-/**
- * gras_get_my_fqdn:
+/** @brief get the fully-qualified name of the current host
  *
- * Returns the fully-qualified name of the host machine, or NULL if the name
+ * Returns the fully-qualified name of the host machine, or "localhost" if the name
  * cannot be determined.  Always returns the same value, so multiple calls
  * cause no problems.
  */
 const char *
-gras_get_my_fqdn(void);
+gras_os_myname(void);
+
+/** @brief get process identification
+ *
+ * Returns the process ID of the current process.  (This is often used
+   by routines that generate unique temporary file names.)
+ */
+int gras_os_getpid(void);
 
-END_DECL
+/** @} */
+END_DECL()
 
 #endif /* GRAS_VIRTU_H */