X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/fc9d4f3e558ba9dc484b910f6d54e48f3929e1af..1f05d1f1fa51727ddeae97411f0592d78c73163d:/doc/module-msg.doc?ds=sidebyside diff --git a/doc/module-msg.doc b/doc/module-msg.doc index ea31607c4d..5a5ccb37ef 100644 --- a/doc/module-msg.doc +++ b/doc/module-msg.doc @@ -1,34 +1,5 @@ -/** \defgroup MSG_JAVA jMSG - \ingroup MSG_API - \brief Java bindings to MSG (\ref MSG_API) - - \htmlonly \endhtmlonly - - MSG was the first distributed programming environment provided within - SimGrid. While almost realistic, it remains quite simple (simplistic?). - This describes the Java bindings to this interface. - - \section jMSG_who Who should use this (and who shouldn't) - - You should use MSG if you want to study some heuristics for a - given problem you don't really want to implement. If you want to - use the Java programming language, your are in the right - section. To use the C interface, please refer to \ref MSG_C. -*/ - -/** \defgroup MSG_C MSG native - \ingroup MSG_API - \brief Native interface to MSG (\ref MSG_API) +/** \addtogroup MSG_API - \htmlonly \endhtmlonly - MSG was the first distributed programming environment provided within SimGrid. While almost realistic, it remains quite simple (simplistic?). This describes the native to MSG. @@ -38,35 +9,8 @@ You should use MSG if you want to study some heuristics for a given problem you don't really want to implement. If you want to use the C programming language, your are in the right - section. To use the Java programming interface, please refer to - \ref MSG_JAVA. -*/ - - -/** - -\defgroup MSG_LUA lMSG - \ingroup MSG_API - \brief Lua bindings to MSG (\ref MSG_API) - - \htmlonly \endhtmlonly - - MSG was the first distributed programming environment provided within - SimGrid. While almost realistic, it remains quite simple (simplistic?). - This describes the Lua bindings to this interface. - - \section lMSG_who Who should use this (and who shouldn't) - - You should use MSG if you want to study some heuristics for a - given problem you don't really want to implement. If you want to - use the Lua script language, your are in the right - section. To use the C interface, please refer to \ref MSG_C. - -*/ - -/** @addtogroup MSG_C + section. To use the Java or Ruby programming interfaces, please refer to + the documentation provided in the relevant packages. \section MSG_funct Offered functionnalities - \ref m_process_management @@ -74,49 +18,221 @@ - \ref m_host_management - \ref m_task_management - \ref msg_gos_functions - - \ref m_channel_management - \ref msg_easier_life - \ref msg_simulation - \section MSG_examples Examples of MSG + Also make sure to visit the page @ref MSG_examples. +*/ + + +/** @defgroup m_datatypes_management MSG Data Types + @ingroup MSG_API + @brief This section describes the different datatypes provided by MSG. + + \htmlonly \endhtmlonly +*/ + +/** @defgroup m_process_management Management Functions of Agents + * @ingroup MSG_API + * @brief This section describes the agent structure of MSG + * (#m_process_t) and the functions for managing it. + */ + +/** @defgroup m_host_management Management functions of Hosts + * @ingroup MSG_API + * @brief This section describes the host structure of MSG + */ + +/** @defgroup m_task_management Managing functions of Tasks + * @ingroup MSG_API + * @brief This section describes the task structure of MSG + * (#m_task_t) and the functions for managing it. + */ + +/** @defgroup msg_gos_functions MSG Operating System Functions + * @ingroup MSG_API + * @brief This section describes the functions that can be used + * by an agent for handling some task. + */ + +/** @defgroup msg_easier_life Platform and Application management + * @ingroup MSG_API + * @brief This section describes functions to manage the platform creation + * and the application deployment. Please check @ref + * MSG_examples for an overview of their usage. + */ + +/** +@defgroup msg_simulation MSG simulation Functions +@ingroup MSG_API +@brief This section describes the functions you need to know to + set up a simulation. You should have a look at \ref MSG_examples + to have an overview of their usage. + +@htmlonly @endhtmlonly +*/ + + +/** +@defgroup MSG_examples MSG Examples +@ingroup MSG_API - - \ref MSG_ex_master_slave +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 + */ -/** @addtogroup MSG_LUA +/** +@defgroup MSG_LUA Lua bindings +@ingroup MSG_API +@brief Lua bindings to MSG (\ref MSG_API) + +@htmlonly @endhtmlonly + + This is the lua bindings of the \ref MSG_API interface. + + \section lMSG_who Who should use this (and who shouldn't) + + If you want to use MSG to study your algorithm, but you don't + want to use the C language (using \ref MSG_API), then you should + use some bindings such as this one. The advantage of the lua + bindings is that they are distributed directly with the main + archive (in contrary to Java and Ruby bindings, for example, + that are distributed separately). Another advantage of lua is + that there is almost no performance loss with regard to the C + version (at least there shouln't be any -- it is still to be + precisely assessed). \section MSG_Lua_funct Lua offered functionnalities in MSG - - \ref host_management - - \ref tasks_management - - \ref environment_management + Almost all important features of the MSG interface are available + from the lua bindings. Unfortunately, since doxygen does not support + the lua modules implemented directly in C as we are using, there is + no ready to use reference documentation for this module. Even more + than for the other modules, you will have to dig into the source + code of the examples to learn how to use it. + \section Lua_examples Examples of lua MSG - \ref MSG_ex_master_slave_lua + - \ref MSG_ex_master_slave_lua_bypass + - Also, the lua version of the Chord example (in the source tree) + is a working non-trivial example of use of the lua bindings */ -/** @defgroup m_datatypes_management MSG Data Types - @ingroup MSG_C - @brief This section describes the different datatypes provided by MSG. +/** \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 + +