Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Current XBT_ATTRIB_DEPRECATED is v334. Fix last changes.
[simgrid.git] / docs / source / Plugins.rst
index 44e4b31295ac5aedc889bd2e086e2d761e28c720..dc475e5c00ccd52eac4e78b1d5e0a0ed3d4a265c 100644 (file)
@@ -33,9 +33,9 @@ Defining a Plugin
 
 A plugin can get some additional code executed within the SimGrid
 kernel, and attach the data needed by that code to the SimGrid
 
 A plugin can get some additional code executed within the SimGrid
 kernel, and attach the data needed by that code to the SimGrid
-objects. 
+objects.
 
 
-The host load plugin in 
+The host load plugin in
 `src/plugins/host_load.cpp <https://framagit.org/simgrid/simgrid/tree/master/src/plugins/host_load.cpp>`_
 constitutes a good introductory example. It defines a class
 ``HostLoad`` that is meant to be attached to each host. This class
 `src/plugins/host_load.cpp <https://framagit.org/simgrid/simgrid/tree/master/src/plugins/host_load.cpp>`_
 constitutes a good introductory example. It defines a class
 ``HostLoad`` that is meant to be attached to each host. This class
@@ -55,7 +55,7 @@ kind of objects, please let us now.
 
 .. cpp:class:: template<class R, class... P> simgrid::xbt::signal<R(P...)>
 
 
 .. cpp:class:: template<class R, class... P> simgrid::xbt::signal<R(P...)>
 
-  A signal/slot mechanism, where you can attach callbacks to a given signal, and then fire the signal. 
+  A signal/slot mechanism, where you can attach callbacks to a given signal, and then fire the signal.
 
   The template parameter is the function signature of the signal (the return value currently ignored).
 
 
   The template parameter is the function signature of the signal (the return value currently ignored).
 
@@ -77,8 +77,14 @@ Partial list of existing signals in s4u:
   :cpp:member:`Actor::on_host_change <simgrid::s4u::Actor::on_host_change>`
   :cpp:member:`Actor::on_termination <simgrid::s4u::Actor::on_termination>`
   :cpp:member:`Actor::on_destruction <simgrid::s4u::Actor::on_destruction>`
   :cpp:member:`Actor::on_host_change <simgrid::s4u::Actor::on_host_change>`
   :cpp:member:`Actor::on_termination <simgrid::s4u::Actor::on_termination>`
   :cpp:member:`Actor::on_destruction <simgrid::s4u::Actor::on_destruction>`
-- :cpp:member:`Comm::on_start <simgrid::s4u::Comm::on_start>`
+- :cpp:member:`Comm::on_send <simgrid::s4u::Comm::on_send>`
+  :cpp:member:`Comm::on_recv <simgrid::s4u::Comm::on_recv>`
   :cpp:member:`Comm::on_completion <simgrid::s4u::Comm::on_completion>`
   :cpp:member:`Comm::on_completion <simgrid::s4u::Comm::on_completion>`
+- :cpp:member:`CommImpl::on_start <simgrid::kernel::actiivty::CommImpl::on_start>`
+  :cpp:member:`CommImpl::on_completion <simgrid::kernel::activity::CommImpl::on_completion>`
+- :cpp:member:`Disk::on_creation <simgrid::s4u::Disk::on_creation>`
+  :cpp:member:`Disk::on_destruction <simgrid::s4u::Disk::on_destruction>`
+  :cpp:member:`Disk::on_state_change <simgrid::s4u::Disk::on_state_change>`
 - :cpp:member:`Engine::on_platform_creation <simgrid::s4u::Engine::on_platform_creation>`
   :cpp:member:`Engine::on_platform_created <simgrid::s4u::Engine::on_platform_created>`
   :cpp:member:`Engine::on_time_advance <simgrid::s4u::Engine::on_time_advance>`
 - :cpp:member:`Engine::on_platform_creation <simgrid::s4u::Engine::on_platform_creation>`
   :cpp:member:`Engine::on_platform_created <simgrid::s4u::Engine::on_platform_created>`
   :cpp:member:`Engine::on_time_advance <simgrid::s4u::Engine::on_time_advance>`
@@ -90,15 +96,15 @@ Partial list of existing signals in s4u:
   :cpp:member:`Host::on_destruction <simgrid::s4u::Host::on_destruction>`
   :cpp:member:`Host::on_state_change <simgrid::s4u::Host::on_state_change>`
   :cpp:member:`Host::on_speed_change <simgrid::s4u::Host::on_speed_change>`
   :cpp:member:`Host::on_destruction <simgrid::s4u::Host::on_destruction>`
   :cpp:member:`Host::on_state_change <simgrid::s4u::Host::on_state_change>`
   :cpp:member:`Host::on_speed_change <simgrid::s4u::Host::on_speed_change>`
+- :cpp:member:`Io::on_start <simgrid::s4u::Io::on_start>`
+  :cpp:member:`Io::on_completion <simgrid::s4u::Io::on_completion>`
 - :cpp:member:`Link::on_creation <simgrid::s4u::Link::on_creation>`
   :cpp:member:`Link::on_destruction <simgrid::s4u::Link::on_destruction>`
   :cpp:member:`Link::on_state_change <simgrid::s4u::Link::on_state_change>`
   :cpp:member:`Link::on_speed_change <simgrid::s4u::Link::on_bandwidth_change>`
 - :cpp:member:`Link::on_creation <simgrid::s4u::Link::on_creation>`
   :cpp:member:`Link::on_destruction <simgrid::s4u::Link::on_destruction>`
   :cpp:member:`Link::on_state_change <simgrid::s4u::Link::on_state_change>`
   :cpp:member:`Link::on_speed_change <simgrid::s4u::Link::on_bandwidth_change>`
-  :cpp:member:`Link::on_communicate <simgrid::s4u::Link::on_communicate>`
   :cpp:member:`Link::on_communication_state_change <simgrid::s4u::Link::on_communication_state_change>`
   :cpp:member:`Link::on_communication_state_change <simgrid::s4u::Link::on_communication_state_change>`
-- :cpp:member:`Netzone::on_creation <simgrid::s4u::Netzone::on_creation>`
-  :cpp:member:`Netzone::on_seal <simgrid::s4u::Netzone::on_seal>`
-  :cpp:member:`Netzone::on_route_creation <simgrid::s4u::Netzone::on_route_creation>`
+- :cpp:member:`NetZone::on_creation <simgrid::s4u::NetZone::on_creation>`
+  :cpp:member:`NetZone::on_seal <simgrid::s4u::NetZone::on_seal>`
 - :cpp:member:`VirtualMachine::on_start <simgrid::s4u::VirtualMachine::on_start>`
   :cpp:member:`VirtualMachine::on_started <simgrid::s4u::VirtualMachine::on_started>`
   :cpp:member:`VirtualMachine::on_suspend <simgrid::s4u::VirtualMachine::on_suspend>`
 - :cpp:member:`VirtualMachine::on_start <simgrid::s4u::VirtualMachine::on_start>`
   :cpp:member:`VirtualMachine::on_started <simgrid::s4u::VirtualMachine::on_started>`
   :cpp:member:`VirtualMachine::on_suspend <simgrid::s4u::VirtualMachine::on_suspend>`
@@ -153,8 +159,5 @@ File System
 
 .. doxygengroup:: plugin_filesystem
 
 
 .. doxygengroup:: plugin_filesystem
 
-.. doxygentypedef:: sg_file_t
-.. doxygentypedef:: const_sg_file_t
 
 ..  LocalWords:  SimGrid
 
 ..  LocalWords:  SimGrid
-