Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Update copyright lines for 2022.
[simgrid.git] / docs / source / app_msg.rst
index 472f4ec..d3dc33e 100644 (file)
@@ -32,7 +32,7 @@ The basic workflow is the following:
  - Initialize the library with :c:macro:`MSG_init`
  - Create a platform (usually by parsing a file with :cpp:func:`MSG_create_environment`)
  - Register the functions that your processes are supposed to run with
-   :cpp:func:`MSG_function_register` (and maybe :cpp:func:`MSG_function_register_default`) 
+   :cpp:func:`MSG_function_register` (and maybe :cpp:func:`MSG_function_register_default`)
  - Launch your processes from a deployment file with :cpp:func:`MSG_launch_application`
  - Run the simulation with :cpp:func:`MSG_main`
 
@@ -61,12 +61,10 @@ This describes the process structure :cpp:type:`msg_process_t` and the functions
 .. doxygenfunction:: MSG_process_create_with_environment
 .. doxygenfunction:: MSG_process_daemonize
 .. doxygenfunction:: MSG_process_detach
-.. doxygenfunction:: MSG_processes_as_dynar
 .. doxygenfunction:: MSG_process_from_PID
 .. doxygenfunction:: MSG_process_get_data
 .. doxygenfunction:: MSG_process_get_host
 .. doxygenfunction:: MSG_process_get_name
-.. doxygenfunction:: MSG_process_get_number
 .. doxygenfunction:: MSG_process_get_PID
 .. doxygenfunction:: MSG_process_get_PPID
 .. doxygenfunction:: MSG_process_get_properties
@@ -113,7 +111,6 @@ Host Management
 .. doxygenfunction:: MSG_host_is_on
 .. doxygenfunction:: MSG_host_off
 .. doxygenfunction:: MSG_host_on
-.. doxygenfunction:: MSG_hosts_as_dynar
 .. doxygenfunction:: MSG_host_self
 .. doxygenfunction:: MSG_host_set_data
 .. doxygenfunction:: MSG_host_set_property_value
@@ -125,6 +122,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
@@ -169,7 +167,7 @@ Task structure of MSG :cpp:type:`msg_task_t` and associated functions.
 .. doxygenfunction:: MSG_task_set_name
 .. doxygenfunction:: MSG_task_set_priority
 
-                  
+
 Mailbox Management
 ==================
 
@@ -179,7 +177,7 @@ Communications
 ==============
 
 .. doxygentypedef:: msg_comm_t
-
+.. doxygentypedef:: const_msg_comm_t
 .. doxygenfunction:: MSG_comm_destroy
 .. doxygenfunction:: MSG_comm_get_status
 .. doxygenfunction:: MSG_comm_get_task
@@ -206,7 +204,7 @@ Barriers
 
 Semaphores
 ----------
-                    
+
 .. doxygentypedef:: msg_sem_t
 .. doxygenfunction:: MSG_sem_acquire
 .. doxygenfunction:: MSG_sem_acquire_timeout
@@ -243,7 +241,7 @@ processes.
 
 NetZone Management
 ==================
-Network Zone (:cpp:class:`msg_file_t`) and associated functions.
+Network Zone (:cpp:type:`msg_netzone_t`) and associated functions.
 
 .. doxygentypedef:: msg_netzone_t
 .. doxygenfunction:: MSG_zone_get_by_name
@@ -254,10 +252,12 @@ Network Zone (:cpp:class:`msg_file_t`) and associated functions.
 .. doxygenfunction:: MSG_zone_get_sons
 .. doxygenfunction:: MSG_zone_set_property_value
 
+.. _Java_doc:
+
 Java bindings
 *************
 
-This section describes jMSG, the Java API to Simgrid. This API mimics 
+This section describes jMSG, the Java API to Simgrid. This API mimics
 :ref:`MSG <MSG_doc>`, which is a simple yet somehow realistic interface.
 The full reference documentation is provided at the end of this page.
 
@@ -279,17 +279,17 @@ Using the Java bindings
 In most cases, you can use the SimGrid bindings as if it was a Java
 library:
 
-.. code-block:: shell
+.. code-block:: console
 
    $ javac -classpath .:path/to/simgrid.jar your/java/Code.java
    $ java -classpath .:path/to/simgrid.jar your.java.Code the/parameter/to/your/code
 
 For example:
 
-.. code-block:: shell
+.. code-block:: console
 
    $ cd examples/deprecated/java
-   $ java -classpath ../../simgrid.jar:. .:../../simgrid.jar app.pingpong.Main ../platforms/platform.xml 
+   $ java -classpath ../../simgrid.jar:. .:../../simgrid.jar app.pingpong.Main ../platforms/platform.xml
 
 Any SimGrid simulation (java or not) is usually constituted of several
 kind of actors or processes (classes extending @c Msg.Process) that
@@ -336,7 +336,7 @@ When using jMSG, your program can crash for 3 main reasons:
   you should read carefully MSG samples and/or documentation.
 - Something has crashed in the C part. Okay, here comes the tricky
   thing. It happens mainly for 2 reasons:
-  
+
   - When something goes wrong in your simulation, sometimes the C part stops
     because you used SimGrid incorrectly, and JNI bindings are not fond of that.
     It means that you'll have something that looks ugly, but you should be able
@@ -359,7 +359,6 @@ Package org.simgrid.msg
 
    Class org.simgrid.msg.As <java/org/simgrid/msg/As>
    Class org.simgrid.msg.Comm <java/org/simgrid/msg/Comm>
-   Class org.simgrid.msg.File <java/org/simgrid/msg/File>
    Class org.simgrid.msg.Host <java/org/simgrid/msg/Host>
    Class org.simgrid.msg.HostFailureException <java/org/simgrid/msg/HostFailureException>
    Class org.simgrid.msg.HostNotFoundException <java/org/simgrid/msg/HostNotFoundException>
@@ -371,8 +370,6 @@ Package org.simgrid.msg
    Class org.simgrid.msg.ProcessKilledError <java/org/simgrid/msg/ProcessKilledError>
    Class org.simgrid.msg.ProcessNotFoundException <java/org/simgrid/msg/ProcessNotFoundException>
    Class org.simgrid.msg.Semaphore <java/org/simgrid/msg/Semaphore>
-   Class org.simgrid.msg.Storage <java/org/simgrid/msg/Storage>
-   Class org.simgrid.msg.StorageNotFoundException <java/org/simgrid/msg/StorageNotFoundException>
    Class org.simgrid.msg.Task <java/org/simgrid/msg/Task>
    Class org.simgrid.msg.TaskCancelledException <java/org/simgrid/msg/TaskCancelledException>
    Class org.simgrid.msg.TimeoutException <java/org/simgrid/msg/TimeoutException>