Finally, to wait at most until a specified time limit, use
:cpp:func:`s4u::Activity::wait_until() <simgrid::s4u::Activity::wait_until>`.
-.. todo::
-
- wait_for and wait_until are currently not implemented for Exec and Io activities.
-
Every kind of activity can be asynchronous:
- :ref:`s4u::CommPtr <API_s4u_Comm>` are created with
.. group-tab:: C
.. autodoxymethod:: sg_actor_init(const char *name, sg_host_t host)
- .. autodoxymethod:: sg_actor_start(sg_actor_t actor, xbt_main_func_t code, int argc, char **argv)
+ .. autodoxymethod:: sg_actor_start(sg_actor_t actor, xbt_main_func_t code, int argc, const char *const *argv)
.. autodoxymethod:: sg_actor_attach(const char *name, void *data, sg_host_t host, xbt_dict_t properties)
.. autodoxymethod:: sg_actor_detach()
.. autodoxymethod:: sg_actor_restart(sg_actor_t actor)
.. autodoxymethod:: sg_actor_daemonize(sg_actor_t actor)
+ .. autodoxymethod:: sg_actor_is_daemon
.. _API_s4u_Actor_end:
.. autodoxyvar:: simgrid::s4u::Actor::on_creation
.. autodoxyvar:: simgrid::s4u::Actor::on_suspend
+ .. cpp:var:: xbt::signal<void(const Actor&, const Host & previous_location)> Actor::on_host_change
+
+ Signal fired when an actor is migrated from one host to another.
+
.. autodoxyvar:: simgrid::s4u::Actor::on_resume
.. autodoxyvar:: simgrid::s4u::Actor::on_sleep
.. autodoxyvar:: simgrid::s4u::Actor::on_wake_up
.. group-tab:: C++
.. autodoxymethod:: simgrid::s4u::this_actor::exec_async(double flops_amounts)
- .. autodoxymethod:: simgrid::s4u::this_actor::exec_init(const std::vector< s4u::Host * > &hosts, const std::vector< double > &flops_amounts, const std::vector< double > &bytes_amounts)
+ .. autodoxymethod:: simgrid::s4u::this_actor::exec_init(const std::vector< s4u::Host *> &hosts, const std::vector< double > &flops_amounts, const std::vector< double > &bytes_amounts)
.. autodoxymethod:: simgrid::s4u::this_actor::exec_init(double flops_amounts)
.. autodoxymethod:: simgrid::s4u::this_actor::execute(double flop)
.. autodoxymethod:: simgrid::s4u::this_actor::execute(double flop, double priority)
- .. autodoxymethod:: simgrid::s4u::this_actor::parallel_execute(const std::vector< s4u::Host * > &hosts, const std::vector< double > &flops_amounts, const std::vector< double > &bytes_amounts)
- .. autodoxymethod:: simgrid::s4u::this_actor::parallel_execute(const std::vector< s4u::Host * > &hosts, const std::vector< double > &flops_amounts, const std::vector< double > &bytes_amounts, double timeout)
+ .. autodoxymethod:: simgrid::s4u::this_actor::parallel_execute(const std::vector< s4u::Host *> &hosts, const std::vector< double > &flops_amounts, const std::vector< double > &bytes_amounts)
+ .. autodoxymethod:: simgrid::s4u::this_actor::parallel_execute(const std::vector< s4u::Host *> &hosts, const std::vector< double > &flops_amounts, const std::vector< double > &bytes_amounts, double timeout)
.. group-tab:: Python
.. group-tab:: C++
- .. autodoxymethod:: simgrid::s4u::Mailbox::get_cname()
- .. autodoxymethod:: simgrid::s4u::Mailbox::get_name()
+ .. autodoxymethod:: simgrid::s4u::Mailbox::get_cname() const
+ .. autodoxymethod:: simgrid::s4u::Mailbox::get_name() const
.. group-tab:: Python
.. group-tab:: C
- .. autodoxymethod:: ::sg_mailbox_set_receiver(const char *alias)
+ .. autodoxymethod:: sg_mailbox_set_receiver(const char *alias)
.. _API_s4u_Resource:
.. group-tab:: C++
- .. autodoxymethod:: simgrid::s4u::Disk::get_cname()
- .. autodoxymethod:: simgrid::s4u::Disk::get_host()
- .. autodoxymethod:: simgrid::s4u::Disk::get_name()
- .. autodoxymethod:: simgrid::s4u::Disk::get_properties()
- .. autodoxymethod:: simgrid::s4u::Disk::get_property(const std::string &key)
- .. autodoxymethod:: simgrid::s4u::Disk::get_read_bandwidth()
- .. autodoxymethod:: simgrid::s4u::Disk::get_write_bandwidth()
+ .. autodoxymethod:: simgrid::s4u::Disk::get_cname() const
+ .. autodoxymethod:: simgrid::s4u::Disk::get_host() const
+ .. autodoxymethod:: simgrid::s4u::Disk::get_name() const
+ .. autodoxymethod:: simgrid::s4u::Disk::get_properties() const
+ .. autodoxymethod:: simgrid::s4u::Disk::get_property(const std::string &key) const
+ .. autodoxymethod:: simgrid::s4u::Disk::get_read_bandwidth() const
+ .. autodoxymethod:: simgrid::s4u::Disk::get_write_bandwidth() const
.. autodoxymethod:: simgrid::s4u::Disk::set_property(const std::string &, const std::string &value)
I/O operations
.. group-tab:: C++
- .. autodoxymethod:: simgrid::s4u::Host::get_cname()
- .. autodoxymethod:: simgrid::s4u::Host::get_core_count()
- .. autodoxymethod:: simgrid::s4u::Host::get_name()
- .. autodoxymethod:: simgrid::s4u::Host::get_available_speed()
- .. autodoxymethod:: simgrid::s4u::Host::get_load()
- .. autodoxymethod:: simgrid::s4u::Host::get_speed()
+ .. autodoxymethod:: simgrid::s4u::Host::get_cname() const
+ .. autodoxymethod:: simgrid::s4u::Host::get_core_count() const
+ .. autodoxymethod:: simgrid::s4u::Host::get_name() const
+ .. autodoxymethod:: simgrid::s4u::Host::get_available_speed() const
+ .. autodoxymethod:: simgrid::s4u::Host::get_load() const
+ .. autodoxymethod:: simgrid::s4u::Host::get_speed() const
.. group-tab:: Python
.. group-tab:: C++
- .. autodoxymethod:: simgrid::s4u::Host::get_properties()
- .. autodoxymethod:: simgrid::s4u::Host::get_property(const std::string &key)
+ .. autodoxymethod:: simgrid::s4u::Host::get_properties() const
+ .. autodoxymethod:: simgrid::s4u::Host::get_property(const std::string &key) const
.. autodoxymethod:: simgrid::s4u::Host::set_properties(const std::map< std::string, std::string > &properties)
.. autodoxymethod:: simgrid::s4u::Host::set_property(const std::string &key, const std::string &value)
.. group-tab:: C++
.. autodoxymethod:: simgrid::s4u::Host::add_disk(Disk *disk)
- .. autodoxymethod:: simgrid::s4u::Host::get_actor_count()
- .. autodoxymethod:: simgrid::s4u::Host::get_all_actors()
- .. autodoxymethod:: simgrid::s4u::Host::get_disks()
+ .. autodoxymethod:: simgrid::s4u::Host::get_actor_count() const
+ .. autodoxymethod:: simgrid::s4u::Host::get_all_actors() const
+ .. autodoxymethod:: simgrid::s4u::Host::get_disks() const
.. autodoxymethod:: simgrid::s4u::Host::remove_disk(const std::string &disk_name)
.. group-tab:: C
.. group-tab:: C++
- .. autodoxymethod:: simgrid::s4u::Host::is_on()
+ .. autodoxymethod:: simgrid::s4u::Host::is_on() const
.. autodoxymethod:: simgrid::s4u::Host::turn_off()
.. autodoxymethod:: simgrid::s4u::Host::turn_on()
.. group-tab:: C++
- .. autodoxymethod:: simgrid::s4u::Host::get_pstate()
- .. autodoxymethod:: simgrid::s4u::Host::get_pstate_count()
- .. autodoxymethod:: simgrid::s4u::Host::get_pstate_speed(int pstate_index)
+ .. autodoxymethod:: simgrid::s4u::Host::get_pstate() const
+ .. autodoxymethod:: simgrid::s4u::Host::get_pstate_count() const
+ .. autodoxymethod:: simgrid::s4u::Host::get_pstate_speed(int pstate_index) const
.. autodoxymethod:: simgrid::s4u::Host::set_pstate(int pstate_index)
.. autodoxymethod:: simgrid::s4u::Host::set_speed_profile(kernel::profile::Profile *p)
.. autodoxymethod:: simgrid::s4u::Host::set_state_profile(kernel::profile::Profile *p)
.. group-tab:: C++
.. autodoxymethod:: simgrid::s4u::Host::get_englobing_zone()
- .. autodoxymethod:: simgrid::s4u::Host::get_netpoint()
- .. autodoxymethod:: simgrid::s4u::Host::route_to(const Host *dest, std::vector< Link * > &links, double *latency)
- .. autodoxymethod:: simgrid::s4u::Host::route_to(const Host *dest, std::vector< kernel::resource::LinkImpl * > &links, double *latency)
- .. autodoxymethod:: simgrid::s4u::Host::send_to(Host *dest, double byte_amount)
+ .. autodoxymethod:: simgrid::s4u::Host::get_netpoint() const
+ .. autodoxymethod:: simgrid::s4u::Host::route_to(const Host *dest, std::vector< Link *> &links, double *latency) const
+ .. autodoxymethod:: simgrid::s4u::Host::route_to(const Host *dest, std::vector< kernel::resource::LinkImpl *> &links, double *latency) const
+ .. autodoxymethod:: simgrid::s4u::Host::sendto(Host *dest, double byte_amount)
+ .. autodoxymethod:: simgrid::s4u::Host::sendto_async(Host *dest, double byte_amount)
.. group-tab:: C
.. autodoxymethod:: sg_host_route(const_sg_host_t from, const_sg_host_t to, xbt_dynar_t links)
.. autodoxymethod:: sg_host_route_bandwidth(const_sg_host_t from, const_sg_host_t to)
.. autodoxymethod:: sg_host_route_latency(const_sg_host_t from, const_sg_host_t to)
- .. autodoxymethod:: sg_host_send_to(sg_host_t from, sg_host_t to, double byte_amount)
+ .. autodoxymethod:: sg_host_sendto(sg_host_t from, sg_host_t to, double byte_amount)
Signals
-------
.. group-tab:: C++
- .. autodoxymethod:: simgrid::s4u::Link::get_bandwidth()
- .. autodoxymethod:: simgrid::s4u::Link::get_cname()
- .. autodoxymethod:: simgrid::s4u::Link::get_latency()
- .. autodoxymethod:: simgrid::s4u::Link::get_name()
- .. autodoxymethod:: simgrid::s4u::Link::get_sharing_policy()
- .. autodoxymethod:: simgrid::s4u::Link::get_usage()
- .. autodoxymethod:: simgrid::s4u::Link::is_used()
+ .. autodoxymethod:: simgrid::s4u::Link::get_bandwidth() const
+ .. autodoxymethod:: simgrid::s4u::Link::get_cname() const
+ .. autodoxymethod:: simgrid::s4u::Link::get_latency() const
+ .. autodoxymethod:: simgrid::s4u::Link::get_name() const
+ .. autodoxymethod:: simgrid::s4u::Link::get_sharing_policy() const
+ .. autodoxymethod:: simgrid::s4u::Link::get_usage() const
+ .. autodoxymethod:: simgrid::s4u::Link::is_used() const
.. group-tab:: C
.. group-tab:: C++
- .. autodoxymethod:: simgrid::s4u::Link::get_property(const std::string &key)
+ .. autodoxymethod:: simgrid::s4u::Link::get_property(const std::string &key) const
.. autodoxymethod:: simgrid::s4u::Link::set_property(const std::string &key, const std::string &value)
.. group-tab:: C
See also :cpp:func:`simgrid::s4u::Link::set_state_profile`.
- .. autodoxymethod:: simgrid::s4u::Link::is_on()
+ .. autodoxymethod:: simgrid::s4u::Link::is_on() const
.. autodoxymethod:: simgrid::s4u::Link::turn_off()
.. autodoxymethod:: simgrid::s4u::Link::turn_on()
.. group-tab:: C++
- .. autodoxymethod:: simgrid::s4u::NetZone::get_cname()
- .. autodoxymethod:: simgrid::s4u::NetZone::get_name()
+ .. autodoxymethod:: simgrid::s4u::NetZone::get_cname() const
+ .. autodoxymethod:: simgrid::s4u::NetZone::get_name() const
.. group-tab:: C
- .. autodoxymethod:: ::sg_zone_get_name(const_sg_netzone_t zone)
+ .. autodoxymethod:: sg_zone_get_name(const_sg_netzone_t zone)
User data and properties
------------------------
.. group-tab:: C++
- .. autodoxymethod:: simgrid::s4u::NetZone::get_properties()
- .. autodoxymethod:: simgrid::s4u::NetZone::get_property(const std::string &key)
+ .. autodoxymethod:: simgrid::s4u::NetZone::get_properties() const
+ .. autodoxymethod:: simgrid::s4u::NetZone::get_property(const std::string &key) const
.. autodoxymethod:: simgrid::s4u::NetZone::set_property(const std::string &key, const std::string &value)
.. group-tab:: C
- .. autodoxymethod:: ::sg_zone_get_property_value(const_sg_netzone_t as, const char *name)
- .. autodoxymethod:: ::sg_zone_set_property_value(sg_netzone_t netzone, const char *name, const char *value)
+ .. autodoxymethod:: sg_zone_get_property_value(const_sg_netzone_t as, const char *name)
+ .. autodoxymethod:: sg_zone_set_property_value(sg_netzone_t netzone, const char *name, const char *value)
Retrieving components
---------------------
.. group-tab:: C++
- .. autodoxymethod:: simgrid::s4u::NetZone::get_all_hosts()
- .. autodoxymethod:: simgrid::s4u::NetZone::get_host_count()
+ .. autodoxymethod:: simgrid::s4u::NetZone::get_all_hosts() const
+ .. autodoxymethod:: simgrid::s4u::NetZone::get_host_count() const
.. group-tab:: C
.. group-tab:: C++
- .. autodoxymethod:: simgrid::s4u::NetZone::add_bypass_route(kernel::routing::NetPoint *src, kernel::routing::NetPoint *dst, kernel::routing::NetPoint *gw_src, kernel::routing::NetPoint *gw_dst, std::vector< kernel::resource::LinkImpl * > &link_list, bool symmetrical)
+ .. autodoxymethod:: simgrid::s4u::NetZone::add_bypass_route(kernel::routing::NetPoint *src, kernel::routing::NetPoint *dst, kernel::routing::NetPoint *gw_src, kernel::routing::NetPoint *gw_dst, std::vector< kernel::resource::LinkImpl *> &link_list, bool symmetrical)
.. autodoxymethod:: simgrid::s4u::NetZone::add_component(kernel::routing::NetPoint *elm)
- .. autodoxymethod:: simgrid::s4u::NetZone::add_route(kernel::routing::NetPoint *src, kernel::routing::NetPoint *dst, kernel::routing::NetPoint *gw_src, kernel::routing::NetPoint *gw_dst, std::vector< kernel::resource::LinkImpl * > &link_list, bool symmetrical)
- .. autodoxymethod:: simgrid::s4u::NetZone::get_children()
+ .. autodoxymethod:: simgrid::s4u::NetZone::add_route(kernel::routing::NetPoint *src, kernel::routing::NetPoint *dst, kernel::routing::NetPoint *gw_src, kernel::routing::NetPoint *gw_dst, std::vector< kernel::resource::LinkImpl *> &link_list, bool symmetrical)
+ .. autodoxymethod:: simgrid::s4u::NetZone::get_children() const
.. autodoxymethod:: simgrid::s4u::NetZone::get_father()
.. group-tab:: C
.. autodoxyvar:: simgrid::s4u::NetZone::on_route_creation
.. autodoxyvar:: simgrid::s4u::NetZone::on_seal
-
-.. doxygenclass:: simgrid::s4u::NetZone
- :members:
- :protected-members:
- :undoc-members:
-
.. _API_s4u_VirtualMachine:
=======================
class VirtualMachine
=======================
-.. doxygenclass:: simgrid::s4u::VirtualMachine
- :members:
- :protected-members:
- :undoc-members:
-
-.. autodoxymethod:: sg_vm_create_core
-.. autodoxymethod:: sg_vm_create_multicore
-.. autodoxymethod:: sg_vm_get_name
-.. autodoxymethod:: sg_vm_get_pm
-.. autodoxymethod:: sg_vm_is_created
-.. autodoxymethod:: sg_vm_is_running
-.. autodoxymethod:: sg_vm_is_suspended
-.. autodoxymethod:: sg_vm_start
-.. autodoxymethod:: sg_vm_suspend
-.. autodoxymethod:: sg_vm_resume
-.. autodoxymethod:: sg_vm_shutdown
-.. autodoxymethod:: sg_vm_destroy
+
+.. autodoxyclass:: simgrid::s4u::VirtualMachine
+
+Basic management
+----------------
+.. tabs::
+
+ .. group-tab:: C++
+
+ .. code-block:: C++
+
+ #include <simgrid/s4u/VirtualMachine.hpp>
+
+ Note that there is no VirtualMachinePtr type, and that you cannot use the RAII
+ idiom on virtual machines. There is no good reason for that and should change in the future.
+
+ .. group-tab:: C
+
+ .. code:: C
+
+ #include <simgrid/vm.h>
+
+ .. doxygentypedef:: sg_vm_t
+ .. cpp:type:: const s4u_VirtualMachine* const_sg_vm_t
+
+ Pointer to a constant virtual machine object.
+
+Creating VMs
+------------
+
+.. tabs::
+
+ .. group-tab:: C++
+
+ .. autodoxymethod:: simgrid::s4u::VirtualMachine::VirtualMachine(const std::string &name, Host *physical_host, int core_amount)
+ .. autodoxymethod:: simgrid::s4u::VirtualMachine::VirtualMachine(const std::string &name, Host *physical_host, int core_amount, size_t ramsize)
+ .. autodoxymethod:: simgrid::s4u::VirtualMachine::destroy
+
+ .. group-tab:: C
+
+ .. autodoxymethod:: sg_vm_create_core
+ .. autodoxymethod:: sg_vm_create_multicore
+ .. autodoxymethod:: sg_vm_destroy
+
+Querying info
+--------------
+
+.. tabs::
+
+ .. group-tab:: C++
+
+ .. autodoxymethod:: simgrid::s4u::VirtualMachine::get_pm() const
+ .. autodoxymethod:: simgrid::s4u::VirtualMachine::get_ramsize() const
+ .. autodoxymethod:: simgrid::s4u::VirtualMachine::get_state()
+
+ .. autodoxymethod:: simgrid::s4u::VirtualMachine::set_bound(double bound)
+ .. autodoxymethod:: simgrid::s4u::VirtualMachine::set_pm(Host *pm)
+ .. autodoxymethod:: simgrid::s4u::VirtualMachine::set_ramsize(size_t ramsize)
+
+ .. group-tab:: C
+
+ .. autodoxymethod:: sg_vm_get_ramsize(const_sg_vm_t vm)
+ .. autodoxymethod:: sg_vm_set_bound(sg_vm_t vm, double bound)
+ .. autodoxymethod:: sg_vm_set_ramsize(sg_vm_t vm, size_t size)
+
+ .. autodoxymethod:: sg_vm_get_name
+ .. autodoxymethod:: sg_vm_get_pm
+ .. autodoxymethod:: sg_vm_is_created
+ .. autodoxymethod:: sg_vm_is_running
+ .. autodoxymethod:: sg_vm_is_suspended
+
+Life cycle
+----------
+
+.. tabs::
+
+ .. group-tab:: C++
+
+ .. autodoxymethod:: simgrid::s4u::VirtualMachine::resume()
+ .. autodoxymethod:: simgrid::s4u::VirtualMachine::shutdown()
+ .. autodoxymethod:: simgrid::s4u::VirtualMachine::start()
+ .. autodoxymethod:: simgrid::s4u::VirtualMachine::suspend()
+
+ .. group-tab:: C
+
+ .. autodoxymethod:: sg_vm_start
+ .. autodoxymethod:: sg_vm_suspend
+ .. autodoxymethod:: sg_vm_resume
+ .. autodoxymethod:: sg_vm_shutdown
+
+Signals
+-------
+
+.. tabs::
+
+ .. group-tab:: C++
+
+ .. autodoxyvar:: simgrid::s4u::VirtualMachine::on_migration_end
+ .. autodoxyvar:: simgrid::s4u::VirtualMachine::on_migration_start
+ .. autodoxyvar:: simgrid::s4u::VirtualMachine::on_resume
+ .. autodoxyvar:: simgrid::s4u::VirtualMachine::on_shutdown
+ .. autodoxyvar:: simgrid::s4u::VirtualMachine::on_start
+ .. autodoxyvar:: simgrid::s4u::VirtualMachine::on_started
+ .. autodoxyvar:: simgrid::s4u::VirtualMachine::on_suspend
.. _API_s4u_Activity:
:ref:`I/O <API_s4u_Io>` (started on and consumming disks).
See also the :ref:`section on activities <s4u_Activities>` above.
-Querying info about activities
-------------------------------
+Basic management
+----------------
- .. autodoxymethod:: simgrid::s4u::Activity::get_remaining()
- .. autodoxymethod:: simgrid::s4u::Activity::get_state()
- .. autodoxymethod:: simgrid::s4u::Activity::set_remaining(double remains)
- .. autodoxymethod:: simgrid::s4u::Activity::get_impl
+.. tabs::
-Activities lifecycle
---------------------
+ .. group-tab:: C++
+
+ .. code-block:: C++
- .. autodoxymethod:: simgrid::s4u::Activity::start
- .. autodoxymethod:: simgrid::s4u::Activity::cancel
- .. autodoxymethod:: simgrid::s4u::Activity::test
- .. autodoxymethod:: simgrid::s4u::Activity::wait
- .. autodoxymethod:: simgrid::s4u::Activity::wait_for
- .. autodoxymethod:: simgrid::s4u::Activity::wait_until(double time_limit)
+ #include <simgrid/s4u/Activity.hpp>
+
+ .. doxygentypedef:: ActivityPtr
+
+Querying info
+-------------
+
+.. tabs::
+
+ .. group-tab:: C++
+
+ .. autodoxymethod:: simgrid::s4u::Activity::get_cname
+ .. autodoxymethod:: simgrid::s4u::Activity::get_name
+ .. autodoxymethod:: simgrid::s4u::Activity::get_remaining() const
+ .. autodoxymethod:: simgrid::s4u::Activity::get_state() const
+ .. autodoxymethod:: simgrid::s4u::Activity::set_remaining(double remains)
+ .. autodoxymethod:: simgrid::s4u::Activity::set_state(Activity::State state)
+
+
+Activities life cycle
+---------------------
+
+.. tabs::
+
+ .. group-tab:: C++
+
+ .. autodoxymethod:: simgrid::s4u::Activity::start
+ .. autodoxymethod:: simgrid::s4u::Activity::cancel
+ .. autodoxymethod:: simgrid::s4u::Activity::test
+ .. autodoxymethod:: simgrid::s4u::Activity::wait
+ .. autodoxymethod:: simgrid::s4u::Activity::wait_for
+ .. autodoxymethod:: simgrid::s4u::Activity::wait_until(double time_limit)
+ .. autodoxymethod:: simgrid::s4u::Activity::vetoable_start()
.. _API_s4u_Comm:
class Comm
=============
-.. doxygentypedef:: CommPtr
+.. autodoxyclass:: simgrid::s4u::Comm
+
+Basic management
+----------------
+
+.. tabs::
-.. doxygenclass:: simgrid::s4u::Comm
- :members:
- :protected-members:
- :undoc-members:
+ .. group-tab:: C++
+
+ .. code-block:: C++
+
+ #include <simgrid/s4u/Comm.hpp>
+
+ .. doxygentypedef:: CommPtr
+
+ .. group-tab:: Python
+
+ .. code:: Python
+
+ from simgrid import Comm
+
+Querying info
+-------------
+
+.. tabs::
+
+ .. group-tab:: C++
+
+ .. autodoxymethod:: simgrid::s4u::Comm::get_dst_data_size() const
+ .. autodoxymethod:: simgrid::s4u::Comm::get_mailbox() const
+ .. autodoxymethod:: simgrid::s4u::Comm::get_sender() const
+ .. autodoxymethod:: simgrid::s4u::Comm::set_dst_data(void **buff)
+ .. autodoxymethod:: simgrid::s4u::Comm::set_dst_data(void **buff, size_t size)
+ .. autodoxymethod:: simgrid::s4u::Comm::detach()
+ .. autodoxymethod:: simgrid::s4u::Comm::detach(void(*clean_function)(void *))
+ .. autodoxymethod:: simgrid::s4u::Comm::set_rate(double rate)
+ .. autodoxymethod:: simgrid::s4u::Comm::set_src_data(void *buff)
+ .. autodoxymethod:: simgrid::s4u::Comm::set_src_data(void *buff, size_t size)
+ .. autodoxymethod:: simgrid::s4u::Comm::set_src_data_size(size_t size)
+ .. autodoxymethod:: simgrid::s4u::Comm::set_tracing_category(const std::string &category)
+
+Life cycle
+----------
+
+.. tabs::
+
+ .. group-tab:: C++
+
+ .. autodoxymethod:: simgrid::s4u::Comm::cancel
+ .. autodoxymethod:: simgrid::s4u::Comm::start
+ .. autodoxymethod:: simgrid::s4u::Comm::test
+ .. autodoxymethod:: simgrid::s4u::Comm::test_any(const std::vector< CommPtr > *comms)
+ .. autodoxymethod:: simgrid::s4u::Comm::wait
+ .. autodoxymethod:: simgrid::s4u::Comm::wait_all(const std::vector< CommPtr > *comms)
+ .. autodoxymethod:: simgrid::s4u::Comm::wait_any(const std::vector< CommPtr > *comms)
+ .. autodoxymethod:: simgrid::s4u::Comm::wait_any_for(const std::vector< CommPtr > *comms_in, double timeout)
+ .. autodoxymethod:: simgrid::s4u::Comm::wait_for
+
+ .. group-tab:: Python
+
+ .. automethod:: simgrid.Comm.test
+ .. automethod:: simgrid.Comm.wait
+ .. automethod:: simgrid.Comm.wait_all
+ .. automethod:: simgrid.Comm.wait_any
+
+Signals
+-------
+
+.. tabs::
+
+ .. group-tab:: C++
+
+ .. autodoxyvar:: simgrid::s4u::Comm::on_completion
+ .. autodoxyvar:: simgrid::s4u::Comm::on_receiver_start
+ .. autodoxyvar:: simgrid::s4u::Comm::on_sender_start
.. _API_s4u_Exec:
class Exec
=============
-.. doxygentypedef:: ExecPtr
+.. autodoxyclass:: simgrid::s4u::Exec
-.. doxygenclass:: simgrid::s4u::Exec
- :members:
- :protected-members:
- :undoc-members:
+Basic management
+----------------
-.. _API_s4u_ExecSeq:
+.. tabs::
-==================
- class ExecSeq
-==================
+ .. group-tab:: C++
-.. doxygentypedef:: ExecSeqPtr
+ .. code-block:: C++
-.. doxygenclass:: simgrid::s4u::ExecSeq
- :members:
- :protected-members:
- :undoc-members:
+ #include <simgrid/s4u/Exec.hpp>
-.. _API_s4u_ExecPar:
+ .. doxygentypedef:: ExecPtr
-==================
- class ExecPar
-==================
+ .. group-tab:: Python
-.. doxygentypedef:: ExecParPtr
+ .. code:: Python
+
+ from simgrid import Exec
+
+Querying info
+-------------
-.. doxygenclass:: simgrid::s4u::ExecPar
- :members:
- :protected-members:
- :undoc-members:
+.. tabs::
+
+ .. group-tab:: C++
+
+ .. autodoxymethod:: simgrid::s4u::Exec::get_cost() const
+ .. autodoxymethod:: simgrid::s4u::Exec::get_finish_time() const
+ .. autodoxymethod:: simgrid::s4u::Exec::get_host() const
+ .. autodoxymethod:: simgrid::s4u::Exec::get_host_number() const
+ .. cpp:function:: double Exec::get_remaining()
+
+ On sequential executions, returns the amount of flops that remain to be done;
+ This cannot be used on parallel executions.
+
+ .. autodoxymethod:: simgrid::s4u::Exec::get_remaining_ratio
+ .. autodoxymethod:: simgrid::s4u::Exec::get_start_time() const
+ .. autodoxymethod:: simgrid::s4u::Exec::set_bound(double bound)
+ .. autodoxymethod:: simgrid::s4u::Exec::set_host
+ .. autodoxymethod:: simgrid::s4u::Exec::set_priority(double priority)
+
+ .. group-tab:: Python
+
+ .. autoattribute:: simgrid.Exec.host
+ .. autoattribute:: simgrid.Exec.remaining
+ .. autoattribute:: simgrid.Exec.remaining_ratio
+
+Life cycle
+----------
+
+.. tabs::
+
+ .. group-tab:: C++
+
+ .. autodoxymethod:: simgrid::s4u::Exec::cancel
+ .. autodoxymethod:: simgrid::s4u::Exec::set_timeout(double timeout)
+ .. autodoxymethod:: simgrid::s4u::Exec::start
+ .. autodoxymethod:: simgrid::s4u::Exec::test
+ .. autodoxymethod:: simgrid::s4u::Exec::wait
+ .. autodoxymethod:: simgrid::s4u::Exec::wait_any(std::vector< ExecPtr > *execs)
+ .. autodoxymethod:: simgrid::s4u::Exec::wait_any_for(std::vector< ExecPtr > *execs, double timeout)
+ .. autodoxymethod:: simgrid::s4u::Exec::wait_for
+
+ .. group-tab:: Python
+
+ .. automethod:: simgrid.Exec.cancel
+ .. automethod:: simgrid.Exec.start
+ .. automethod:: simgrid.Exec.test
+ .. automethod:: simgrid.Exec.wait
+
+Signals
+-------
+
+.. tabs::
+
+ .. group-tab:: C++
+
+ .. cpp:var:: xbt::signal<void(Actor const&, Exec const&)> Exec::on_completion
+ .. cpp:var:: xbt::signal<void(Actor const&, Exec const&)> Exec::on_start
.. _API_s4u_Io:
class Io
===========
-.. doxygentypedef:: IoPtr
+.. autodoxyclass:: simgrid::s4u::Io
+
+Basic management
+----------------
+
+.. tabs::
+
+ .. group-tab:: C++
+
+ .. code-block:: C++
+
+ #include <simgrid/s4u/Io.hpp>
+
+ .. doxygentypedef:: IoPtr
+
+Querying info
+-------------
+
+.. tabs::
+
+ .. group-tab:: C++
+
+ .. autodoxymethod:: simgrid::s4u::Io::get_performed_ioops() const
+ .. autodoxymethod:: simgrid::s4u::Io::get_remaining
+
+Life cycle
+----------
+
+.. tabs::
+
+ .. group-tab:: C++
-.. doxygenclass:: simgrid::s4u::Io
- :members:
- :protected-members:
- :undoc-members:
+ .. autodoxymethod:: simgrid::s4u::Io::cancel
+ .. autodoxymethod:: simgrid::s4u::Io::start
+ .. autodoxymethod:: simgrid::s4u::Io::test
+ .. autodoxymethod:: simgrid::s4u::Io::wait
+ .. autodoxymethod:: simgrid::s4u::Io::wait_for
.. _API_s4u_Synchronizations:
#include <simgrid/cond.h>
.. doxygentypedef:: sg_cond_t
- .. doxygenfunction:: sg_cond_init
- .. doxygenfunction:: sg_cond_destroy
+ .. autodoxymethod:: sg_cond_init
+ .. autodoxymethod:: sg_cond_destroy
Waiting and notifying
---------------------
.. group-tab:: C
- .. doxygenfunction:: sg_cond_notify_all
- .. doxygenfunction:: sg_cond_notify_one
- .. doxygenfunction:: sg_cond_wait
- .. doxygenfunction:: sg_cond_wait_for
+ .. autodoxymethod:: sg_cond_notify_all
+ .. autodoxymethod:: sg_cond_notify_one
+ .. autodoxymethod:: sg_cond_wait
+ .. autodoxymethod:: sg_cond_wait_for
.. _API_s4u_Semaphore:
