X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/b7c3da37d0776e2e3daadc7ea96dffdee4e809a4..f04cb933da95f9df2da6d58a72a7b1da12582f7d:/doc/doxygen/module-msg.doc?ds=sidebyside diff --git a/doc/doxygen/module-msg.doc b/doc/doxygen/module-msg.doc deleted file mode 100644 index 5f3c420730..0000000000 --- a/doc/doxygen/module-msg.doc +++ /dev/null @@ -1,105 +0,0 @@ -/** -@defgroup MSG_API MSG: Legacy handling of CSP algorithms -@brief Simple programming environment - - -MSG is a simple API to write algorithms organized with Concurrent -Sequential Processes (CSP) that interact by exchanging messages. It -constitutes a convenient simplification of the reality of distributed -systems. It can be used to build rather realistic simulations, but -remains simple to use: most unpleasant technical elements can be -abstracted away rather easily. - -@warning MSG used to be the main API of SimGrid 3, but we are - currently in the process of releasing SimGrid 4. The - tentative release date is Summer 2018. So MSG is frozen and - will probably never evolve. If you are starting a new - project, you should consider S4U instead. Note that the - support for MSG will not be removed from SimGrid before 2020 - at least. - -@section MSG_funct Offered functionalities - - @ref msg_simulation - - @ref m_process_management - - @ref m_host_management - - @ref m_task_management - - @ref msg_mailbox_management - - @ref msg_file - - @ref msg_task_usage - - @ref msg_VMs - - @ref msg_synchro - - @ref msg_examples - -*/ - -/** -@defgroup msg_simulation Main MSG simulation Functions -@ingroup MSG_API -@brief How to setup and control your simulation. - -The basic workflow is the following (check the @ref msg_examples for -details). - - -# Initialize the library with #MSG_init - -# Create a platform (usually by parsing a file with - #MSG_create_environment) - -# Register the functions that your processes are supposed to run with - #MSG_function_register (and maybe #MSG_function_register_default) - -# Launch your processes from a deployment file with #MSG_launch_application - -# Run the simulation with #MSG_main -*/ - -/** @defgroup m_process_management Process Management Functions - * @ingroup MSG_API - * @brief This section describes the process structure of MSG - * (#msg_process_t) and the functions for managing it. - */ - -/** @defgroup m_host_management Host Management Functions - * @ingroup MSG_API - * @brief Host structure of MSG - */ - -/** @defgroup m_task_management Task Management Functions - * @ingroup MSG_API - * @brief Task structure of MSG (#msg_task_t) and associated functions. See - * @ref msg_task_usage to see how to put the tasks in action. - */ - -/** @defgroup msg_mailbox_management Mailbox Management Functions - * @ingroup MSG_API - * @brief Functions associated to mailboxes. - */ - -/** @defgroup msg_task_usage Task Actions - * @ingroup MSG_API - * @brief This section describes the functions that can be used - * by a process to execute, communicate or otherwise handle some task. - */ - -/** @defgroup msg_synchro Explicit Synchronization Functions - * @ingroup MSG_API - * @brief Explicit synchronization mechanisms: semaphores (#msg_sem_t) and friends. - * - * In some situations, these things are very helpful to synchronize processes without message exchanges. - */ - -/** @defgroup msg_VMs VMs - * @ingroup MSG_API - * @brief Interface created to mimic IaaS clouds. - * - * With it, you can create virtual machines to put your processes - * into, and interact directly with the VMs to manage groups of - * processes. - * - */ - -/** @defgroup msg_storage_management Storage Management Functions - * @ingroup MSG_API - * @brief Storage structure of MSG (#msg_storage_t) and associated functions, inspired from POSIX. - */ - -/** @defgroup msg_file File Management Functions - @ingroup MSG_API - @brief MSG files (#msg_file_t) and associated functions, inspired from POSIX. -*/