Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Initial revision
[simgrid.git] / cruft / doc / tmpl / Globals.sgml
diff --git a/cruft/doc/tmpl/Globals.sgml b/cruft/doc/tmpl/Globals.sgml
new file mode 100644 (file)
index 0000000..a0a65ae
--- /dev/null
@@ -0,0 +1,43 @@
+<!-- ##### SECTION Title ##### -->
+Globals API
+
+<!-- ##### SECTION Short_Description ##### -->
+Handling globals
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>In GRAS, using globals is forbidden since the daemons will        
+sometimes run as a thread inside the same process. So, you have to put 
+all globals in a structure, and tell GRAS that it's your globals.</para>
+
+<para>Use the grasUserdataNew() macro to create a new user data (or malloc it
+yourself and use grasUserdataSet yourself), and grasUserdataGet() to
+retrive a reference to it.</para>
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+
+</para>
+
+<!-- ##### FUNCTION gras_userdata_get ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### FUNCTION gras_userdata_set ##### -->
+<para>
+
+</para>
+
+@ud: 
+
+
+<!-- ##### MACRO gras_userdata_new ##### -->
+<para>
+
+</para>
+
+@type: 
+
+