X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/95ed9f116988b265540bb92e8de3666ba60ab533..ea74f5d95928a521a588737e81f1de94eef25d19:/docs/source/Plugins.rst diff --git a/docs/source/Plugins.rst b/docs/source/Plugins.rst index 620da83e75..dc475e5c00 100644 --- a/docs/source/Plugins.rst +++ b/docs/source/Plugins.rst @@ -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 -objects. +objects. -The host load plugin in +The host load plugin in `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 simgrid::xbt::signal - 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). @@ -77,8 +77,14 @@ Partial list of existing signals in s4u: :cpp:member:`Actor::on_host_change ` :cpp:member:`Actor::on_termination ` :cpp:member:`Actor::on_destruction ` -- :cpp:member:`Comm::on_start ` +- :cpp:member:`Comm::on_send ` + :cpp:member:`Comm::on_recv ` :cpp:member:`Comm::on_completion ` +- :cpp:member:`CommImpl::on_start ` + :cpp:member:`CommImpl::on_completion ` +- :cpp:member:`Disk::on_creation ` + :cpp:member:`Disk::on_destruction ` + :cpp:member:`Disk::on_state_change ` - :cpp:member:`Engine::on_platform_creation ` :cpp:member:`Engine::on_platform_created ` :cpp:member:`Engine::on_time_advance ` @@ -90,15 +96,15 @@ Partial list of existing signals in s4u: :cpp:member:`Host::on_destruction ` :cpp:member:`Host::on_state_change ` :cpp:member:`Host::on_speed_change ` +- :cpp:member:`Io::on_start ` + :cpp:member:`Io::on_completion ` - :cpp:member:`Link::on_creation ` :cpp:member:`Link::on_destruction ` :cpp:member:`Link::on_state_change ` :cpp:member:`Link::on_speed_change ` - :cpp:member:`Link::on_communicate ` :cpp:member:`Link::on_communication_state_change ` - :cpp:member:`NetZone::on_creation ` :cpp:member:`NetZone::on_seal ` - :cpp:member:`NetZone::on_route_creation ` - :cpp:member:`VirtualMachine::on_start ` :cpp:member:`VirtualMachine::on_started ` :cpp:member:`VirtualMachine::on_suspend ` @@ -153,8 +159,5 @@ File System .. doxygengroup:: plugin_filesystem -.. doxygentypedef:: sg_file_t -.. doxygentypedef:: const_sg_file_t .. LocalWords: SimGrid -