Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
doxygenification
[simgrid.git] / include / xbt / context.h
index 8e1c8ea..fd744d3 100644 (file)
@@ -8,14 +8,39 @@
 #ifndef _XBT_CONTEXT_H
 #define _XBT_CONTEXT_H
 
-typedef struct s_xbt_context *xbt_context_t;
-typedef int(*xbt_context_function_t)(int argc, char *argv[]);
+#include "xbt/misc.h"
+#include "xbt/dynar.h" /* void_f_pvoid_t */
 
-void context_init(void);
-void context_empty_trash(void);
-xbt_context_t context_create(xbt_context_function_t code, int argc, char *argv[]);
-void context_start(xbt_context_t context);
-void context_yield(xbt_context_t context);
-int context_get_id(xbt_context_t context);
+/** @addtogroup XBT_context
+ *  
+ *  INTERNALS OF SIMGRID, DON'T USE IT.
+ *
+ *  This is a portable to Unix and Windows context implementation.
+ *
+ * @{
+ */
 
+/** @name Context types
+ *  @{
+ */
+
+  /** @brief A context */
+  typedef struct s_xbt_context *xbt_context_t;
+  /** @brief A context function */
+  typedef int(*xbt_context_function_t)(int argc, char *argv[]);
+
+/*@}*/
+
+void xbt_context_init(void);
+void xbt_context_exit(void);
+void xbt_context_empty_trash(void);
+xbt_context_t xbt_context_new(xbt_context_function_t code, 
+                             void_f_pvoid_t startup_func, void *startup_arg,
+                             void_f_pvoid_t cleanup_func, void *cleanup_arg,
+                             int argc, char *argv[]);
+void xbt_context_free(xbt_context_t context);
+void xbt_context_start(xbt_context_t context);
+void xbt_context_yield(void);
+void xbt_context_schedule(xbt_context_t context);
+/*@} */
 #endif                         /* _XBT_CONTEXT_H */