X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/d076b836086d9936ae9000ba6edf9525691e5c92..4f8e570fe8c24ee6194808d69af4b361f000d7af:/doc/module-msg.doc diff --git a/doc/module-msg.doc b/doc/module-msg.doc index b4b7c35fb9..2a35441fcf 100644 --- a/doc/module-msg.doc +++ b/doc/module-msg.doc @@ -1,4 +1,48 @@ -/** @addtogroup MSG_API +/** \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) + + \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. + + \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 C programming language, your are in the right + section. To use the Java programming interface, please refer to + \ref MSG_JAVA. +*/ + +/** @addtogroup MSG_C \section MSG_funct Offered functionnalities - \ref m_process_management @@ -10,33 +54,33 @@ - \ref msg_easier_life - \ref msg_simulation - \section MSG_examples Examples of use + \section MSG_examples Examples of MSG - \ref MSG_ex_master_slave */ /** @defgroup m_datatypes_management MSG Data Types - @ingroup MSG_API + @ingroup MSG_C @brief This section describes the different datatypes provided by MSG. + + \htmlonly \endhtmlonly */ /** \addtogroup m_process_management - \ingroup MSG_API */ + \ingroup MSG_C */ /** \addtogroup m_host_management - \ingroup MSG_API */ + \ingroup MSG_C */ /** \addtogroup m_task_management - \ingroup MSG_API */ + \ingroup MSG_C */ /** \addtogroup msg_gos_functions - \ingroup MSG_API */ + \ingroup MSG_C */ /** \addtogroup m_channel_management - \ingroup MSG_API */ + \ingroup MSG_C */ /** \addtogroup msg_easier_life - \ingroup MSG_API */ + \ingroup MSG_C */ /** \addtogroup msg_simulation - \ingroup MSG_API */ + \ingroup MSG_C */ /** \page MSG_ex_master_slave Master/slave application - -
[\ref MSG_API]
Simulation of a master-slave application using a realistic platform and an external description of the deployment. @@ -56,7 +100,7 @@
- \dontinclude msg/msg_test.c + \dontinclude msg/masterslave/masterslave_forwarder.c \section MSG_ext_ms_code Code of the application @@ -103,6 +147,8 @@ 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 @@ -129,7 +175,7 @@ \subsection MSG_ext_ms_application Example of application file - \include msg/small_deployment.xml + \include msg/masterslave/deployment_masterslave.xml \subsection MSG_ext_ms_platform Example of platform file