X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/04fa61785ae1ecb5e5233ef0cb6d24145120d95e..effadf994078b5f7bbc589d3ac0ba2aae8aaa59f:/doc/doxygen/examples.doc diff --git a/doc/doxygen/examples.doc b/doc/doxygen/examples.doc index fa63cedfdb..fa473b21e2 100644 --- a/doc/doxygen/examples.doc +++ b/doc/doxygen/examples.doc @@ -108,93 +108,6 @@ The following application description can be found in \c examples/msg/app-master \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 - -
- -\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: - - platform_file: the name of a file containing an valid platform description. - - application_file: 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 } - */