-/*! \page examples SimGrid Examples
+/*! @page examples SimGrid Examples
-\tableofcontents
+@tableofcontents
SimGrid comes with many examples provided in the examples/ directory.
-Those examples are described in section \ref msg_examples. Those
+Those examples are described in section @ref msg_examples. Those
examples are commented and should be easy to understand. for a first
step into SimGrid we also provide some more detailed examples in the
sections below.
-\htmlonly
+@htmlonly
You should also check our online <a href="http://simgrid.gforge.inria.fr/documentation.html"> tutorial section</a> that contains a generic tutorial about using SimGrid.
-\endhtmlonly
+@endhtmlonly
-\section using_msg Using MSG
+@section using_msg Using MSG
-\htmlonly
+@htmlonly
You should also check our online <a href="http://simgrid.gforge.inria.fr/documentation.html"> tutorial section</a> that contains a dedicated tutorial.
-\endhtmlonly
+@endhtmlonly
Here are some examples on how to use MSG, the most used API.
to find the one you need. This list aims at helping you finding the
example from which you can learn what you want to.
-\subsection MSG_ex_basics Basic examples and features
+@subsection MSG_ex_basics Basic examples and features
-\subsubsection MSG_ex_master_worker Basic Master/Workers
+@subsubsection MSG_ex_master_worker Basic Master/Workers
Simulation of a master-worker application using a realistic platform and an external description of the deployment.
-\paragraph MSG_ex_mw_TOC Table of contents:
+@paragraph MSG_ex_mw_TOC Table of contents:
- - \ref MSG_ext_mw_preliminary
- - \ref MSG_ext_mw_master
- - \ref MSG_ext_mw_worker
- - \ref MSG_ext_mw_core
- - \ref MSG_ext_mw_platform
- - \ref MSG_ext_mw_application
+ - @ref MSG_ext_mw_preliminary
+ - @ref MSG_ext_mw_master
+ - @ref MSG_ext_mw_worker
+ - @ref MSG_ext_mw_core
+ - @ref MSG_ext_mw_platform
+ - @ref MSG_ext_mw_application
<hr>
-\dontinclude msg/app-masterworker/app-masterworker.c
+@dontinclude msg/app-masterworker/app-masterworker.c
-\paragraph MSG_ext_mw_preliminary Preliminary declarations
+@paragraph MSG_ext_mw_preliminary Preliminary declarations
-\skip include
-\until example");
-\skipline Master expects
+@skip include
+@until example");
+@skipline Master expects
-\paragraph MSG_ext_mw_master Master code
+@paragraph MSG_ext_mw_master Master code
This function has to be assigned to a #msg_process_t that will behave as the master. It should not be called directly
but either given as a parameter to #MSG_process_create() or registered as a public function through
Tasks are evenly sent in a round-robin style.
-\until return 0;
-\until }
-\skipline Worker expects
+@until return 0;
+@until }
+@skipline Worker expects
-\paragraph MSG_ext_mw_worker Worker code
+@paragraph MSG_ext_mw_worker Worker code
This function has to be assigned to a #msg_process_t that has to behave as a worker. Just like the master function
-(described in \ref MSG_ext_mw_master), it should not be called directly.
+(described in @ref MSG_ext_mw_master), it should not be called directly.
C style arguments (argc/argv) are interpreted as:
- a unique id used to build the mailbox name of the worker
This function keeps waiting for tasks and executes them as it receives them. When a special task named 'finalize' is
received from the master, the process ends its execution.
-\until return 0;
-\until }
+@until return 0;
+@until }
-\paragraph MSG_ext_mw_core Main function
+@paragraph MSG_ext_mw_core Main function
This function is the core of the simulation and is divided only into 3 parts:
-# Simulation settings : #MSG_create_environment() creates a realistic
Its arguments are:
- <i>platform_file</i>: the name of a file containing an valid platform description.
- <i>deployment_file</i>: the name of a file containing a valid application description
-\line main
-\until OK;
-\until }
+@line main
+@until OK;
+@until }
-\paragraph MSG_ext_mw_platform Example of a platform file
+@paragraph MSG_ext_mw_platform Example of a platform file
-The following platform description can be found in \c examples/msg/platforms/small_platform.xml
-\include platforms/small_platform.xml
+The following platform description can be found in @c examples/msg/platforms/small_platform.xml
+@include platforms/small_platform.xml
-\paragraph MSG_ext_mw_application Example of a deployment file
+@paragraph MSG_ext_mw_application Example of a deployment file
-The following application description can be found in \c examples/msg/app-masterworker/app-masterworker_d.xml:
+The following application description can be found in @c examples/msg/app-masterworker/app-masterworker_d.xml:
-\include msg/app-masterworker/app-masterworker_d.xml
-
-\subsubsection MSG_ex_asynchronous_communications Asynchronous communications
-
-Simulation of asynchronous communications between a sender and a receiver using a realistic platform and
-an external description of the deployment.
-
- - \ref MSG_ext_async_code
- - \ref MSG_ext_async_preliminary
- - \ref MSG_ext_async_Sender
- - \ref MSG_ext_async_Receiver
- - \ref MSG_ext_async_Main
- - \ref MSG_ext_async_fct_Waitall
- - \ref MSG_ext_async_fct_Waitany
-
-<hr>
-
-\dontinclude msg/async-wait/async-wait.c
-
-\paragraph MSG_ext_async_code Code of the application
-
-\paragraph MSG_ext_async_preliminary Preliminary declarations
-\skip include
-\until Sender
-
-\paragraph MSG_ext_async_Sender Sender function
-
-A host can send an asynchronous message with \c MSG_task_isend(). %As this function is non-blocking, we have to call
-\c MSG_comm_test() to know if the communication is complete and evenetually destroy it with a call to
-\c MSG_comm_destroy(). It is also possible to call \c MSG_comm_wait() which provides a shortcut.
-
- C style arguments (argc/argv) are interpreted as:
- - the number of tasks to distribute
- - the computation size of each task
- - the size of the files associated to each task
- - the number of receivers that will accept those tasks
- - the time to sleep at the beginning of the function. This time defines the process sleep time:
- - if time = 0, use MSG_comm_wait()
- - if time > 0, use MSG_comm_test()
-
-\until Receiver
-
-\paragraph MSG_ext_async_Receiver Receiver function
-
-This function executes tasks when it receives them. %As the receiving is asynchronous, we have to test the completion of
-the communication with \c MSG_comm_test() or wait for it with \c MSG_comm_wait().
-
- C style arguments (argc/argv) are interpreted as:
- - the id to use for received the communication.
- - the time to sleep at the beginning of the function
- - This time defined the process sleep time
- - if time = 0 use of MSG_comm_wait()
- - if time > 0 use of MSG_comm_test()
-
-\until return
-\until }
-
-\paragraph MSG_ext_async_Main Main function
-
-This function is the core of the simulation and is divided only into 3 parts:
- -# Simulation settings : MSG_create_environment() loads a platform description
- -# Application deployment : create the processes on the right locations with MSG_launch_application()
- -# The simulation is run with #MSG_main()
-
- Its arguments are:
- - <i>platform_file</i>: the name of a file containing an valid platform description.
- - <i>application_file</i>: the name of a file containing a valid application deployment.
-
-\until return
-\until }
-
-\dontinclude msg/async-waitall/async-waitall.c
-
-\paragraph MSG_ext_async_fct_Waitall Waitall function
-
-The use of MSG_comm_waitall() allows a process to send all the tasks and then wait for the completion of all in one call.
-
-\skipline static
-\until return
-\until }
-
-\paragraph MSG_ext_async_fct_Waitany Waitany function
-
-The MSG_comm_waitany() function returns the place of the first message send or receive from a xbt_dynar.
-
-\skipline static
-\until return
-\until }
+@include msg/app-masterworker/app-masterworker_d.xml
*/
