X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/d7377843192020efb1b215c504e36e84558ac520..a2d16cd78c8d1a779948aa69d6e396028c788a5e:/docs/source/app_s4u.rst?ds=sidebyside diff --git a/docs/source/app_s4u.rst b/docs/source/app_s4u.rst index 9e9be4ed83..ec9dc5ade7 100644 --- a/docs/source/app_s4u.rst +++ b/docs/source/app_s4u.rst @@ -332,7 +332,7 @@ garbage-collected. If your simulation creates many short-lived actors that marked as permanent receiver, you should call ``mailbox->set_receiver(nullptr)`` by the end of the actors so that their memory gets properly reclaimed. This call should be at the end of the -actor's function, not in a on_exit callback. +actor's function, not in an on_exit callback. .. _s4u_raii: @@ -364,7 +364,7 @@ Here is a little example: 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 +mailbox or a link. You can still destroy a host (but probably shouldn't), using :cpp:func:`simgrid::s4u::Host::destroy`. .. THE EXAMPLES @@ -509,8 +509,8 @@ Querying info .. autodoxymethod:: sg_actor_get_host(const_sg_actor_t actor) .. autodoxymethod:: sg_actor_set_host(sg_actor_t actor, sg_host_t host) - .. autodoxymethod:: sg_actor_data(const_sg_actor_t actor) - .. autodoxymethod:: sg_actor_data_set(sg_actor_t actor, void *userdata) + .. autodoxymethod:: sg_actor_get_data(const_sg_actor_t actor) + .. autodoxymethod:: sg_actor_set_data(sg_actor_t actor, void *userdata) Suspending and resuming actors ------------------------------ @@ -644,8 +644,8 @@ Querying info .. group-tab:: C - .. autodoxymethod:: sg_actor_self_data() - .. autodoxymethod:: sg_actor_self_data_set(void *data) + .. autodoxymethod:: sg_actor_self_get_data() + .. autodoxymethod:: sg_actor_self_set_data(void *data) .. autodoxymethod:: sg_actor_self_get_name() .. autodoxymethod:: sg_actor_self_get_pid() .. autodoxymethod:: sg_actor_self_get_ppid() @@ -714,8 +714,8 @@ the execution, or start an asynchronous activity. .. 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 @@ -1157,8 +1157,8 @@ Querying info .. autodoxymethod:: sg_host_core_count(const_sg_host_t host) .. autodoxymethod:: sg_host_dump(const_sg_host_t ws) .. autodoxymethod:: sg_host_get_name(const_sg_host_t host) - .. autodoxymethod:: sg_host_load(const_sg_host_t host) - .. autodoxymethod:: sg_host_speed(const_sg_host_t host) + .. autodoxymethod:: sg_host_get_load(const_sg_host_t host) + .. autodoxymethod:: sg_host_get_speed(const_sg_host_t host) User data and properties ------------------------ @@ -1268,9 +1268,9 @@ Platform and routing .. 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_get_route(const_sg_host_t from, const_sg_host_t to, xbt_dynar_t links) + .. autodoxymethod:: sg_host_get_route_bandwidth(const_sg_host_t from, const_sg_host_t to) + .. autodoxymethod:: sg_host_get_route_latency(const_sg_host_t from, const_sg_host_t to) .. autodoxymethod:: sg_host_sendto(sg_host_t from, sg_host_t to, double byte_amount) Signals @@ -1360,10 +1360,10 @@ Querying info .. group-tab:: C - .. autodoxymethod:: sg_link_bandwidth(const_sg_link_t link) + .. autodoxymethod:: sg_link_get_bandwidth(const_sg_link_t link) + .. autodoxymethod:: sg_link_get_latency(const_sg_link_t link) + .. autodoxymethod:: sg_link_get_name(const_sg_link_t link) .. autodoxymethod:: sg_link_is_shared(const_sg_link_t link) - .. autodoxymethod:: sg_link_latency(const_sg_link_t link) - .. autodoxymethod:: sg_link_name(const_sg_link_t link) Modifying characteristics ------------------------- @@ -1375,6 +1375,11 @@ Modifying characteristics .. autodoxymethod:: simgrid::s4u::Link::set_bandwidth(double value) .. autodoxymethod:: simgrid::s4u::Link::set_latency(double value) + .. group-tab:: C + + .. autodoxymethod:: sg_link_set_bandwidth(const_sg_link_t link, double value) + .. autodoxymethod:: sg_link_set_latency(const_sg_link_t link, double value) + User data and properties ------------------------ @@ -1387,8 +1392,8 @@ User data and properties .. group-tab:: C - .. autodoxymethod:: sg_link_data(const_sg_link_t link) - .. autodoxymethod:: sg_link_data_set(sg_link_t link, void *data) + .. autodoxymethod:: sg_link_get_data(const_sg_link_t link) + .. autodoxymethod:: sg_link_set_data(sg_link_t link, void *data) On/Off ------