X-Git-Url: http://bilbo.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/8b74edb114f75bca1004dcbea78db7b532b7b263..49d2b43b4a1132169df9baa44b51defb6528004b:/docs/source/app_msg.rst diff --git a/docs/source/app_msg.rst b/docs/source/app_msg.rst index daa47e1a54..0e5a943440 100644 --- a/docs/source/app_msg.rst +++ b/docs/source/app_msg.rst @@ -9,7 +9,10 @@ The MSG Interface (legacy interface) the process of releasing SimGrid 4. 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. + be removed from SimGrid before 2020Q4 or 2021Q1. + + This interface is disabled by default. Pass -Denable_msg=ON to + cmake if you still need it. MSG is a simple API to write algorithms organized with Concurrent Sequential Processes (CSP) that interact by exchanging messages. It @@ -44,7 +47,6 @@ The basic workflow is the following: .. doxygendefine:: MSG_init .. doxygenfunction:: MSG_launch_application .. doxygenfunction:: MSG_main -.. doxygenfunction:: MSG_set_function Process Management ================== @@ -88,7 +90,6 @@ This describes the process structure :cpp:type:`msg_process_t` and the functions .. doxygenfunction:: MSG_process_sleep .. doxygenfunction:: MSG_process_suspend .. doxygenfunction:: MSG_process_unref -.. doxygenfunction:: MSG_process_userdata_init .. doxygenfunction:: MSG_process_yield Host Management @@ -98,10 +99,8 @@ Host Management .. doxygenfunction:: MSG_host_by_name .. doxygenfunction:: MSG_get_host_by_name .. doxygenfunction:: MSG_get_host_number -.. doxygenfunction:: MSG_host_get_attached_storage_lists .. doxygenfunction:: MSG_host_get_core_number .. doxygenfunction:: MSG_host_get_data -.. doxygenfunction:: MSG_host_get_mounted_storage_list .. doxygenfunction:: MSG_host_get_name .. doxygenfunction:: MSG_host_get_nb_pstates .. doxygenfunction:: MSG_host_get_load @@ -111,7 +110,6 @@ Host Management .. doxygenfunction:: MSG_host_get_property_value .. doxygenfunction:: MSG_host_get_pstate .. doxygenfunction:: MSG_host_get_speed -.. doxygenfunction:: MSG_host_is_off .. doxygenfunction:: MSG_host_is_on .. doxygenfunction:: MSG_host_off .. doxygenfunction:: MSG_host_on @@ -127,6 +125,7 @@ Task Management Task structure of MSG :cpp:type:`msg_task_t` and associated functions. .. doxygentypedef:: msg_task_t +.. doxygentypedef:: const_msg_task_t .. doxygendefine:: MSG_TASK_UNINITIALIZED .. doxygenfunction:: MSG_parallel_task_create @@ -155,8 +154,6 @@ Task structure of MSG :cpp:type:`msg_task_t` and associated functions. .. doxygenfunction:: MSG_task_listen_from .. doxygenfunction:: MSG_task_receive .. doxygenfunction:: MSG_task_receive_bounded -.. doxygenfunction:: MSG_task_receive_ext -.. doxygenfunction:: MSG_task_receive_ext_bounded .. doxygenfunction:: MSG_task_receive_with_timeout .. doxygenfunction:: MSG_task_receive_with_timeout_bounded .. doxygendefine:: MSG_task_recv @@ -168,7 +165,6 @@ Task structure of MSG :cpp:type:`msg_task_t` and associated functions. .. doxygenfunction:: MSG_task_set_bound .. doxygenfunction:: MSG_task_set_bytes_amount .. doxygenfunction:: MSG_task_set_category -.. doxygenfunction:: MSG_task_set_copy_callback .. doxygenfunction:: MSG_task_set_data .. doxygenfunction:: MSG_task_set_flops_amount .. doxygenfunction:: MSG_task_set_name @@ -246,23 +242,6 @@ processes. .. doxygenfunction:: MSG_vm_start .. doxygenfunction:: MSG_vm_suspend -Storage Management -================== -Storage structure of MSG (:cpp:type:`msg_storage_t`) and associated functions, inspired from POSIX. - -.. doxygentypedef:: msg_storage_t -.. doxygenfunction:: MSG_storage_get_by_name -.. doxygenfunction:: MSG_storage_get_data -.. doxygenfunction:: MSG_storage_get_host -.. doxygenfunction:: MSG_storage_get_name -.. doxygenfunction:: MSG_storage_get_properties -.. doxygenfunction:: MSG_storage_get_property_value -.. doxygenfunction:: MSG_storage_read -.. doxygenfunction:: MSG_storages_as_dynar -.. doxygenfunction:: MSG_storage_set_data -.. doxygenfunction:: MSG_storage_set_property_value -.. doxygenfunction:: MSG_storage_write - NetZone Management ================== Network Zone (:cpp:class:`msg_file_t`) and associated functions. @@ -279,7 +258,7 @@ Network Zone (:cpp:class:`msg_file_t`) and associated functions. Java bindings ************* -This section describes jMSG, the Java API to Simgrid. This API mimicks +This section describes jMSG, the Java API to Simgrid. This API mimics :ref:`MSG `, which is a simple yet somehow realistic interface. The full reference documentation is provided at the end of this page. @@ -392,7 +371,6 @@ Package org.simgrid.msg Class org.simgrid.msg.Process Class org.simgrid.msg.ProcessKilledError Class org.simgrid.msg.ProcessNotFoundException - Class org.simgrid.msg.RngStream Class org.simgrid.msg.Semaphore Class org.simgrid.msg.Storage Class org.simgrid.msg.StorageNotFoundException