X-Git-Url: http://bilbo.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/691d7c891da0352a6fa38507a482b287c7e086de..8b74edb114f75bca1004dcbea78db7b532b7b263:/docs/source/app_s4u.rst diff --git a/docs/source/app_s4u.rst b/docs/source/app_s4u.rst index 3c8c2064d9..43afc8e08b 100644 --- a/docs/source/app_s4u.rst +++ b/docs/source/app_s4u.rst @@ -343,14 +343,13 @@ Memory Management For sake of simplicity, we use `RAII `_ -everywhere in S4U. This is an idiom where resources are automatically +for many classes in S4U. This is an idiom where resources are automatically managed through the context. Provided that you never manipulate objects of type Foo directly but always FooPtr references (which are defined as `boost::intrusive_ptr `_ ), you will never have to explicitely release the resource that you use nor to free the memory of unused objects. - Here is a little example: .. code-block:: cpp @@ -365,6 +364,11 @@ Here is a little example: } // The mutex gets automatically freed because the only existing reference gets out of scope +Note that Mailboxes, Hosts and Links are not handled thought smart +pointers (yet?). This means that it is currently impossible to destroy a +mailbox or a link. You can still destroy an host (but probably +shouldn't), using :cpp:func:`simgrid::s4u::Host::destroy`. + C++ API Reference ***************** @@ -464,6 +468,32 @@ s4u::Exec :protected-members: :undoc-members: +.. _API_s4u_ExecSeq: + +============ +s4u::ExecSeq +============ + +.. doxygentypedef:: ExecSeqPtr + +.. doxygenclass:: simgrid::s4u::ExecSeq + :members: + :protected-members: + :undoc-members: + +.. _API_s4u_ExecPar: + +============ +s4u::ExecPar +============ + +.. doxygentypedef:: ExecParPtr + +.. doxygenclass:: simgrid::s4u::ExecPar + :members: + :protected-members: + :undoc-members: + .. _API_s4u_Host: ========= @@ -592,6 +622,13 @@ Class Actor .. autoclass:: simgrid.Actor :members: +========== +Class Comm +========== + +.. autoclass:: simgrid.Comm + :members: + ============ Class Engine ============ @@ -599,6 +636,13 @@ Class Engine .. autoclass:: simgrid.Engine :members: +========== +Class Exec +========== + +.. autoclass:: simgrid.Exec + :members: + ========== Class Host ==========