Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Write the lesson 10 on RPC in GRAS
[simgrid.git] / doc / gtut-tour.doc
index 0f27376..0f37190 100644 (file)
@@ -12,40 +12,125 @@ all features available in GRAS.
       DOXYGEN_NAVBAR_CHILD "2: Simple messaging"=GRAS_tut_tour_simpleexchange.html
       DOXYGEN_NAVBAR_CHILD "3: Process args"=GRAS_tut_tour_args.html
       DOXYGEN_NAVBAR_CHILD "4: Callbacks"=GRAS_tut_tour_callbacks.html
-      DOXYGEN_NAVBAR_CHILD "5: Callbacks"=GRAS_tut_tour_globals.html
+      DOXYGEN_NAVBAR_CHILD "5: Globals"=GRAS_tut_tour_globals.html
       DOXYGEN_NAVBAR_CHILD "6: Logs"=GRAS_tut_tour_logs.html
+      DOXYGEN_NAVBAR_CHILD "7: Timers"=GRAS_tut_tour_timers.html
+      DOXYGEN_NAVBAR_CHILD "8: Exceptions"=GRAS_tut_tour_exceptions.html
+      DOXYGEN_NAVBAR_CHILD "9: Data exchange"=GRAS_tut_tour_simpledata.html
+      DOXYGEN_NAVBAR_CHILD "10: RPC"=GRAS_tut_tour_rpc.html
+      DOXYGEN_NAVBAR_CHILD "11: Static data definition"=GRAS_tut_tour_staticstruct.html
+      DOXYGEN_NAVBAR_CHILD "12: Pointers definition"=GRAS_tut_tour_pointers.html
+      DOXYGEN_NAVBAR_CHILD "13: Dynars definition"=GRAS_tut_tour_dynars.html
+      DOXYGEN_NAVBAR_CHILD "14: Manual data definition"=GRAS_tut_tour_manualdatadef.html
+      DOXYGEN_NAVBAR_CHILD "15: Advanced data definition"=GRAS_tut_tour_exchangecb.html
     --> \endhtmlonly
 
- - \ref GRAS_tut_tour_install
- - \ref GRAS_tut_tour_setup
- - \ref GRAS_tut_tour_simpleexchange
- - \ref GRAS_tut_tour_args
- - \ref GRAS_tut_tour_callbacks
- - \ref GRAS_tut_tour_globals
- - \ref GRAS_tut_tour_logs
+<b>Part 1: Bases</b>
+
+   - \ref GRAS_tut_tour_install
+
+   - \ref GRAS_tut_tour_setup
+      - \ref GRAS_tut_tour_setup_C
+      - \ref GRAS_tut_tour_setup_plat
+      - \ref GRAS_tut_tour_setup_deploy
+      - \ref GRAS_tut_tour_setup_glue
+      - \ref GRAS_tut_tour_setup_make
+      - \ref GRAS_tut_tour_setup_start
+  
+<b>Part 2: Message passing</b>
+  
+   - \ref GRAS_tut_tour_simpleexchange
+      - \ref GRAS_tut_tour_simpleexchange_msgtype
+      - \ref GRAS_tut_tour_simpleexchange_socks
+      - \ref GRAS_tut_tour_simpleexchange_exchange
+      - \ref GRAS_tut_tour_simpleexchange_recaping
+    
+   - \ref GRAS_tut_tour_args
+      - \ref GRAS_tut_tour_args_use
+      - \ref GRAS_tut_tour_args_sg
+      - \ref GRAS_tut_tour_args_recap
+    
+   - \ref GRAS_tut_tour_callbacks
+      - \ref GRAS_tut_tour_callbacks_declare
+      - \ref GRAS_tut_tour_callbacks_attach
+      - \ref GRAS_tut_tour_callbacks_handle
+      - \ref GRAS_tut_tour_callback_recap
+     
+   - \ref GRAS_tut_tour_globals
+      - \ref GRAS_tut_tour_globals_intro
+      - \ref GRAS_tut_tour_globals_use
+      - \ref GRAS_tut_tour_callback_pitfall
+      - \ref GRAS_tut_tour_callback_recap
+      
+   - \ref GRAS_tut_tour_logs
+      - \ref GRAS_tut_tour_logs_intro
+      - \ref GRAS_tut_tour_logs_practice
+      - \ref GRAS_tut_tour_logs_recap
+      - \ref GRAS_tut_tour_logs_config
+    
+   - \ref GRAS_tut_tour_timers
+      - \ref GRAS_tut_tour_timers_intro
+      - \ref GRAS_tut_tour_timers_use
+      - \ref GRAS_tut_tour_timers_recap
+    
+   - \ref GRAS_tut_tour_exceptions
+      - \ref GRAS_tut_tour_exceptions_intro
+      - \ref GRAS_tut_tour_exceptions_use
+      - \ref GRAS_tut_tour_exceptions_recap
+     
+   - \ref GRAS_tut_tour_simpledata
+      - \ref GRAS_tut_tour_simpledata_intro
+         - \ref GRAS_tut_tour_simpledata_intro_conv
+         - \ref GRAS_tut_tour_simpledata_intro_gras
+         - \ref GRAS_tut_tour_simpledata_use
+      - \ref GRAS_tut_tour_simpledata_example
+      - \ref GRAS_tut_tour_simpledata_recap
+      
+   - \ref GRAS_tut_tour_rpc
+      - \ref GRAS_tut_tour_rpc_intro
+      - \ref GRAS_tut_tour_rpc_use
+      - \ref GRAS_tut_tour_rpc_recap
+  
+<b>Part 3: Data description</b>
+
+   - \ref GRAS_tut_tour_staticstruct Automatic parsing of static data types
+      - \ref GRAS_tut_tour_staticstruct_intro
+      - \ref GRAS_tut_tour_staticstruct_use
+      - \ref GRAS_tut_tour_staticstruct_recap
+      
+   - \ref GRAS_tut_tour_pointers Automatic parsing of datatypes containing pointers
+      - \ref GRAS_tut_tour_pointers_intro
+      - \ref GRAS_tut_tour_pointers_use
+      - \ref GRAS_tut_tour_pointers_recap
+      
+   - \ref GRAS_tut_tour_dynar Exchanging dynars (and matrices)
+      - \ref GRAS_tut_tour_dynar_intro
+      - \ref GRAS_tut_tour_dynar_use
+      - \ref GRAS_tut_tour_dynar_recap
+      
+   - \ref GRAS_tut_tour_manualdatadef Manual data description: the full power
+      - \ref GRAS_tut_tour_manualdatadef_intro
+      - \ref GRAS_tut_tour_manualdatadef_use
+      - \ref GRAS_tut_tour_manualdatadef_recap
+      
+   - \ref GRAS_tut_tour_exchangecb Exchange callbacks: yes you can
+      - \ref GRAS_tut_tour_exchangecb_intro
+      - \ref GRAS_tut_tour_exchangecb_use
+      - \ref GRAS_tut_tour_exchangecb_recap
+
+<b>Part 4: Advanced topics</b>
+
+Unfortunately, the tour is not terminated yet, but I already know the kind
+of missi^W lessons I want to add:
+
+   - Computation virtualization
+   - Splitting in several files (logs, datadesc)
+   - Debugging GRAS programs
+   - Doing proper GRAS modules
+  
 <hr>
 
 
-\section GRAS_tut_tour_todo TODO
-
-Unfortunately, the tour is not terminated yet, and here are some ideas of
-missing missi^W lessons:
-
-- Lesson 5: Globals (for a kill message)
-- Lesson 6: Timers
-- Lesson 7: Using logs
-
-- Lesson 8: Exchanging simple data through ping-pong
-- Lesson 9: More complex data description (automatic parsing, manual description) and example
-
-- Lesson 10: Splitting in several files
-
-- Lesson 11: RPC mecanism and dealing with exceptions
-
-- Lesson 12: Debuging GRAS programs
-
-- Lesson   : Doing proper modules
 
 */