X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/8de7a90b044d2c8cf008e498f533cd7131c9f106..6aa1cd51bc162ae5288aa155446fd39dc2e1b772:/examples/msg/README.doc diff --git a/examples/msg/README.doc b/examples/msg/README.doc index 5b6e08991a..56533bc205 100644 --- a/examples/msg/README.doc +++ b/examples/msg/README.doc @@ -2,7 +2,7 @@ This file follows the Doxygen syntax to be included in the documentation, but it should remain readable directly. /** - @defgroup MSG_examples MSG examples + @defgroup msg_examples MSG examples @ingroup MSG_API @brief Find the MSG example fitting your needs from the extensive set provided in the archive. @@ -38,7 +38,7 @@ documentation, but it should remain readable directly. @ref examples/msg/app-masterworker/app-masterworker.c\n Another good old example, where one Master process has a bunch of task to dispatch to a set of several Worker processes. It is fully - commented in @ref MSG_ex_master_worker. + commented in @ref msg_ex_master_worker. @section msg_ex_async Asynchronous communications @@ -64,7 +64,7 @@ shipped in the archive: The @ref MSG_comm_waitany function is useful when you want to block until one activity of the set completes, no matter which terminates first. - + @section msg_ex_process Acting on Processes - Creating processes. @@ -85,6 +85,12 @@ shipped in the archive: @ref examples/msg/process-migration/process-migration.c \n Processes can move or be moved from a host to another with the @ref MSG_process_migrate function. + - Yielding to other processes. + @ref examples/msg/process-yield/process-yield.c\n + The @ref MSG_process_yield function interrupts the execution of the + current process, leaving a chance to run to the other processes + that are ready to run at the exact same timestamp + - Controling the process life cycle from the XML. @ref examples/msg/process-startkilltime/process-startkilltime.c \n You can specify a start time and a kill time in the deployment @@ -164,10 +170,10 @@ They have to be run with the following options: @subsection msg_ex_ns3 NS3 as a SimGrid Network Model This example demonstrates how to use the bindings to the Network -Simulator, as explained in @ref pls. The most +Simulator, as explained in @ref pls_ns3. The most interesting is probably not the C files since they are unchanged from the other simulations, but the associated files, such as the platform -file to see how to declare a platform to be used with the PLS bindings +file to see how to declare a platform to be used with the ns-3 bindings of SimGrid and the tesh file to see how to actually start a simulation in these settings. @@ -225,22 +231,6 @@ also the tesh files in the example directories for details. Presents a set of event handlers reproducing classical I/O primitives (open, read, write, close, etc). -@section msg_ex_apps Examples of Full Applications - - - Parallel Matrix Multiplication. - @ref examples/msg/app-pmm/app-pmm.c \n - This little application multiplies two matrices in parallel. Each - of the 9 processes computes a sub-block of the result, with the - sub-blocks of the input matrices exchanged between the processes. \n - This is a classical assignment in MPI lectures, here implemented - in MSG. - - - Chord P2P protocol. - @ref examples/msg/dht-chord/dht-chord.c \n - This example implements the well known Chord protocol, - constituting a fully working non-trivial example. This - implementation is also very efficient, as demonstrated in - http://hal.inria.fr/inria-00602216/ @section msg_ex_misc Miscellaneous @@ -276,6 +266,7 @@ top of the example file). @example examples/msg/async-wait/async-wait.c @example examples/msg/async-waitall/async-waitall.c @example examples/msg/async-waitany/async-waitany.c +@example examples/msg/async-yield/async-yield.c @example examples/msg/process-create/process-create.c @example examples/msg/process-suspend/process-suspend.c @@ -300,9 +291,6 @@ top of the example file). @example examples/msg/actions-comm/actions-comm.c @example examples/msg/actions-storage/actions-storage.c -@example examples/msg/app-pmm/app-pmm.c -@example examples/msg/dht-chord/dht-chord.c - @example examples/msg/task-priority/task-priority.c @example examples/msg/platform-properties/platform-properties.c