Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Cleaned doc, re-included examples, should be better now.
[simgrid.git] / doc / shared / doxygen / msg-examples.doc
diff --git a/doc/shared/doxygen/msg-examples.doc b/doc/shared/doxygen/msg-examples.doc
deleted file mode 100644 (file)
index f6a0e6a..0000000
+++ /dev/null
@@ -1,339 +0,0 @@
-/**
-@defgroup MSG_examples MSG Examples
-@ingroup MSG_User_Guide
-
-
-MSG comes with an extensive set of examples. It is sometimes difficult
-to find the one you need. This list aims at helping you finding the
-example from which you can learn what you want to.
-
-@section MSG_ex_basics Basic examples and features
-
-*/
-
-/**
-@defgroup MSG_ex_asynchronous_communications Asynchronous communications
-@ingroup MSG_examples
-
-Simulation of asynchronous communications between a sender and a receiver using a realistic platform and
-an external description of the deployment.
-
-\section MSG_ex_ms_TOC Table of contents:
- - \ref MSG_ext_icomms_code
-   - \ref MSG_ext_icomms_preliminary
-   - \ref MSG_ext_icomms_Sender
-   - \ref MSG_ext_icomms_Receiver
-   - \ref MSG_ext_icomms_core
-   - \ref MSG_ext_icomms_Main
- - \ref MSG_ext_icomms_fct_Waitall
- - \ref MSG_ext_icomms_fct_Waitany
-
-<hr>
-
-\dontinclude msg/icomms/peer.c
-
-\section MSG_ext_icomms_code Code of the application
-
-\subsection MSG_ext_icomms_preliminary Preliminary declarations
-\skip include
-\until Sender function
-
-\subsection MSG_ext_icomms_Sender Sender function
-
-The sender send to a receiver an asynchronous message with the function "MSG_task_isend()". Cause this function is non-blocking
-we have to make "MSG_comm_test()" to know   if the communication is finished for finally destroy it with function "MSG_comm_destroy()".
-It also available to "make MSG_comm_wait()" which make both of them.
-
-  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
-   - a list of host that will accept those tasks.
-   - 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 Receiver function
-
-\subsection MSG_ext_icomms_Receiver Receiver function
-
-This function executes tasks when it receives them. As the receiving is asynchronous we have to test the communication to know
-if it is completed or not with "MSG_comm_test()" or wait for the completion "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 Test function
-
-\subsection MSG_ext_icomms_core Simulation core
-
-  This function is the core of the simulation and is divided only into 3 parts
-  thanks to MSG_create_environment() and MSG_launch_application().
-     -# Simulation settings : MSG_create_environment() creates a realistic
-        environment
-     -# 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 surfxml platform description.
-       - <i>application_file</i>: the name of a file containing a valid surfxml application description
-
-\until Main function
-
-\subsection MSG_ext_icomms_Main Main function
-
-This initializes MSG, runs a simulation, and free all data-structures created by MSG.
-
-\until end_of_main
-
-\dontinclude msg/icomms/peer2.c
-
-\section MSG_ext_icomms_fct_Waitall Waitall function for sender
-
-The use of this function permit to send all messages and wait for the completion of all in one time.
-
-\skipline Sender function
-\until end_of_sender
-
-\section MSG_ext_icomms_fct_Waitany Waitany function
-
-The MSG_comm_waitany() function return the place of the first message send or receive from a xbt_dynar_t table.
-
-\subsection MSG_ext_icomms_fct_Waitany_sender From a sender
-We can use this function to wait all sent messages.
-\dontinclude msg/icomms/peer3.c
-\skipline Sender function
-\until end_of_sender
-
-\subsection MSG_ext_icomms_fct_Waitany_receiver From a receiver
-We can also wait for the arrival of all messages.
-\dontinclude msg/icomms/peer3.c
-\skipline Receiver function
-\until end_of_receiver
-
-*/
-
-
-/**
-@defgroup MSG_ex_master_slave Basic Master/Slaves
-@ingroup MSG_examples
-
-Simulation of a master-slave application using a realistic platform
-and an external description of the deployment.
-
-\section MSG_ex_ms_TOC Table of contents:
-
- - \ref MSG_ext_ms_code
-   - \ref MSG_ext_ms_preliminary
-   - \ref MSG_ext_ms_master
-   - \ref MSG_ext_ms_slave
-   - \ref MSG_ext_ms_forwarder
-   - \ref MSG_ext_ms_core
-   - \ref MSG_ext_ms_main
- - \ref MSG_ext_ms_helping
-   - \ref MSG_ext_ms_application
-   - \ref MSG_ext_ms_platform
-
-<hr>
-
-\dontinclude msg/masterslave/masterslave_forwarder.c
-
-\section MSG_ext_ms_code Code of the application
-
-\subsection MSG_ext_ms_preliminary Preliminary declarations
-
-\skip include
-\until printf
-\until }
-
-\subsection MSG_ext_ms_master Master code
-
-This function has to be assigned to a m_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 #MSG_function_register() and then automatically assigned to a
-process through #MSG_launch_application().
-
-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
-   - a list of host that will accept those tasks.
-
-Tasks are dumbly sent in a round-robin style.
-
-\until end_of_master
-
-\subsection MSG_ext_ms_slave Slave code
-
-This function has to be assigned to a #m_process_t that has to behave
-as a slave. Just like the master fuction (described in \ref
-MSG_ext_ms_master), it should not be called directly.
-
-This function keeps waiting for tasks and executes them as it receives them.
-
-\until end_of_slave
-
-\subsection MSG_ext_ms_forwarder Forwarder code
-
-This function has to be assigned to a #m_process_t that has to behave
-as a forwarder. Just like the master function (described in \ref
-MSG_ext_ms_master), it should not be called directly.
-
-C style arguments (argc/argv) are interpreted as a list of host that
-will accept those tasks.
-
-This function keeps waiting for tasks and dispathes them to its slaves.
-
-\until end_of_forwarder
-
-\subsection MSG_ext_ms_core Simulation core
-
-This function is the core of the simulation and is divided only into 3 parts
-thanks to MSG_create_environment() and MSG_launch_application().
-   -# Simulation settings : MSG_create_environment() creates a realistic
-      environment
-   -# 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 surfxml platform description.
-       - <i>application_file</i>: the name of a file containing a valid surfxml application description
-
-\until end_of_test_all
-
-\subsection MSG_ext_ms_main Main() function
-
-This initializes MSG, runs a simulation, and free all data-structures created by MSG.
-
-\until end_of_main
-
-\section MSG_ext_ms_helping Helping files
-
-\subsection MSG_ext_ms_application Example of application file
-
-\include msg/masterslave/deployment_masterslave.xml
-
-\subsection MSG_ext_ms_platform Example of platform file
-
-\include msg/small_platform.xml
-
-*/
-
-/** \page MSG_ex_master_slave_lua Master/slave Lua application
-
-    Simulation of a master-slave application using lua bindings
-       - \ref MSG_ext_ms_code_lua
-       - \ref MSG_ext_ms_master_lua
-       - \ref MSG_ext_ms_slave_lua
-       - \ref MSG_ext_ms_core_lua
-
-     - \ref MSG_ext_ms_helping
-       - \ref MSG_ext_ms_application
-       - \ref MSG_ext_ms_platform
-
-
-      \dontinclude lua/masterslave/master_slave.lua
-
-      \section MSG_ext_ms_code_lua Code of the application
-
-      \subsection MSG_ext_ms_master_lua Master code
-
-            as described ine the C native master/Slave exmaple , this function has to be assigned to a m_process_t that will behave as the master.
-
-      Lua style arguments (...) in for the master are interpreted as:
-       - the number of tasks to distribute
-       - the computation size of each task
-       - the size of the files associated to each task
-       - a list of host that will accept those tasks.
-
-      Tasks are dumbly sent in a round-robin style.
-
-      \until end_of_master
-
-
-      \subsection MSG_ext_ms_slave_lua Slave code
-
-      This function has to be assigned to a #m_process_t that has to behave as a slave.
-      This function keeps waiting for tasks and executes them as it receives them.
-
-      \until end_of_slave
-         \subsection MSG_ext_ms_core_lua Simulation core
-
-      in this section the core of the simulation which start by including the simgrid lib for bindings
-      : <i>require "simgrid" </i>
-
-         -# Simulation settings : <i>simgrid.platform</i> creates a realistic
-            environment
-         -# Application deployment : create the processes on the right locations with
-            <i>simgrid.application</i>
-         -# The simulation is run with <i>simgrid.run</i>
-
-      Its arguments are:
-       - <i>platform_file</i>: the name of a file containing an valid surfxml platform description.( first command line argument)
-       - <i>application_file</i>: the name of a file containing a valid surfxml application description ( second commande line argument )
-
-      \until simgrid.clean()
-
-*/
-
-/** \page MSG_ex_master_slave_lua_bypass Master/slave Bypass Lua application
-
-    Simulation of a master-slave application using lua bindings, Bypassing the XML parser
-       - \ref MSG_ext_ms_code_lua
-       - \ref MSG_ext_ms_master_lua
-       - \ref MSG_ext_ms_slave_lua
-       - \ref MSG_ext_ms_core_lua
-
-
-      \dontinclude lua/console/master_slave_bypass.lua
-
-      \section MSG_ext_ms_code_lua Code of the application
-
-      \subsection MSG_ext_ms_master_lua Master code
-
-            as described ine the C native master/Slave exmaple , this function has to be assigned to a m_process_t that will behave as the master.
-
-      Lua style arguments (...) in for the master are interpreted as:
-       - the number of tasks to distribute
-       - the computation size of each task
-       - the size of the files associated to each task
-       - a list of host that will accept those tasks.
-
-      Tasks are dumbly sent in a round-robin style.
-
-      \until end_of_master
-
-
-      \subsection MSG_ext_ms_slave_lua Slave code
-
-      This function has to be assigned to a #m_process_t that has to behave as a slave.
-      This function keeps waiting for tasks and executes them as it receives them.
-
-      \until end_of_slave
-         \subsection MSG_ext_ms_core_lua Simulation core
-
-      in this section the core of the simulation which start by including the simgrid lib for bindings, then create the resources we need to set up our environment bypassing the XML parser.
-      : <i>require "simgrid" </i>
-
-        -# Hosts : <i>simgrid.Host.new</i> instanciate a new host with an id, and power.
-        -# Links : <i>simgrid.Link.new</i> instanictae a new link that will require an id, bandwith and latency values.
-        -# Route : <i>simgrid.Route.new</i> define a route between two hosts specifying the links to use.
-         -# Simulation settings : <i>simgrid.register_platform();</i> register own platform without using the XML SURF parser.
-
-        we can also bypass the XML deployment file, and associate functions for each of defined hosts.
-       - <i>simgrid.Host.setFunction</i>: associate a function to a host, specifying arguments if needed.
-       - <i>simgrid.register_application()</i>: saving the deployment settings before running the simualtion.
-
-      \until simgrid.clean()
-
-*/
-