Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
py: another example: actor-join
[simgrid.git] / examples / s4u / README.rst
index e730f21..48bded2 100644 (file)
@@ -38,7 +38,8 @@ Starting and Stoping Actors
   - **Creating actors:**
     Most actors are started from the deployment XML file, but there is other methods.
     This example show them all.
-    |br| `examples/s4u/actor-create/s4u-actor-create.cpp <https://framagit.org/simgrid/simgrid/tree/master/examples/s4u/actor-create/s4u-actor-create.cpp>`_
+    |br| |cpp| `examples/s4u/actor-create/s4u-actor-create.cpp <https://framagit.org/simgrid/simgrid/tree/master/examples/s4u/actor-create/s4u-actor-create.cpp>`_
+    |br|  |py| `examples/python/actor-create/actor-create.py <https://framagit.org/simgrid/simgrid/tree/master/examples/python/actor-create/actor-create.py>`_
     
   - **Kill actors:**
     Actors can forcefully stop other actors with the 
@@ -67,20 +68,27 @@ Inter-Actors Interactions
     |br| `examples/s4u/actor-suspend/s4u-actor-suspend.cpp <https://framagit.org/simgrid/simgrid/tree/master/examples/s4u/actor-suspend/s4u-actor-suspend.cpp>`_
 
   - **Migrating Actors:**
-    Actors can move or be moved from a host to another with
-    :cpp:func:`simgrid::s4u::this_actor::migrate()`.
-    |br| `examples/s4u/actor-migration/s4u-actor-migration.cpp <https://framagit.org/simgrid/simgrid/tree/master/examples/s4u/actor-migration/s4u-actor-migration.cpp>`_
+    Actors can move or be moved from a host to another very easily.
+    |br| |cpp| `examples/s4u/actor-migration/s4u-actor-migration.cpp <https://framagit.org/simgrid/simgrid/tree/master/examples/s4u/actor-migration/s4u-actor-migration.cpp>`_
+    :cpp:func:`simgrid::s4u::this_actor::migrate()` |cpp|
+    |br|  |py| `examples/python/actor-migration/actor-migration.py <https://framagit.org/simgrid/simgrid/tree/master/examples/python/actor-migration/actor-migration.py>`_
+    :py:func:`simgrid.this_actor.migrate()` |py|
 
   - **Waiting for the termination of an actor:** (joining on it)
-    :cpp:func:`simgrid::s4u::Actor::join()` allows to block the current
-    actor until the end of the receiving actor.
-    |br| `examples/s4u/actor-join/s4u-actor-join.cpp <https://framagit.org/simgrid/simgrid/tree/master/examples/s4u/actor-join/s4u-actor-join.cpp>`_
-
-  - **Yielding to other actor**.
-    The :cpp:func:`simgrid::s4u::this_actor::yield()` function interrupts the
-    execution of the current actor, leaving a chance to the other actors
-    that are ready to run at this timestamp.
-    |br| `examples/s4u/actor-yield/s4u-actor-yield.cpp <https://framagit.org/simgrid/simgrid/tree/master/examples/s4u/actor-yield/s4u-actor-yield.cpp>`_
+    You can block the current actor until the end of another actor.
+    |br| |cpp| `examples/s4u/actor-join/s4u-actor-join.cpp <https://framagit.org/simgrid/simgrid/tree/master/examples/s4u/actor-join/s4u-actor-join.cpp>`_
+    :cpp:func:`simgrid::s4u::Actor::join()` |cpp|
+    |br| |py| `examples/python/actor-join/actor-join.py <https://framagit.org/simgrid/simgrid/tree/master/examples/python/actor-join/actor-join.py>`_
+    :cpp:func:`simgrid.Actor.join()` |py|
+
+  - **Yielding to other actors**.
+    The ```yield()``` function interrupts the execution of the current
+    actor, leaving a chance to the other actors that are ready to run
+    at this timestamp. 
+    |br| |cpp| `examples/s4u/actor-yield/s4u-actor-yield.cpp <https://framagit.org/simgrid/simgrid/tree/master/examples/s4u/actor-yield/s4u-actor-yield.cpp>`_
+    :cpp:func:`simgrid::s4u::this_actor::yield()` |cpp|
+    |br|  |py| `examples/python/actor-yield/actor-yield.py <https://framagit.org/simgrid/simgrid/tree/master/examples/python/actor-yield/actor-yield.py>`_
+    :py:func:`simgrid.this_actor.yield_()` |py|
 
 Traces Replay as a Workload
 ---------------------------