X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/55491279cdea3f01da22d1b51874e2e168ac5116..813829e7b90c3c0106dd63c3b7aee378efc22aa6:/docs/source/app_s4u.rst diff --git a/docs/source/app_s4u.rst b/docs/source/app_s4u.rst index 1991185198..fdb8c905ac 100644 --- a/docs/source/app_s4u.rst +++ b/docs/source/app_s4u.rst @@ -169,10 +169,6 @@ use :cpp:func:`s4u::Activity::wait_for() `. Finally, to wait at most until a specified time limit, use :cpp:func:`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 ` are created with @@ -449,7 +445,7 @@ Creating actors .. 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() @@ -571,6 +567,7 @@ Specifying when actors should terminate .. 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: @@ -713,12 +710,12 @@ the execution, or start an asynchronous activity. .. 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 @@ -763,14 +760,18 @@ Initialization .. autodoxymethod:: simgrid::s4u::Engine::is_initialized() .. autodoxymethod:: simgrid::s4u::Engine::shutdown() .. autodoxymethod:: simgrid::s4u::Engine::set_config(const std::string &str) + .. autodoxymethod:: simgrid::s4u::Engine::set_config(const std::string &name, bool value) + .. autodoxymethod:: simgrid::s4u::Engine::set_config(const std::string &name, double value) + .. autodoxymethod:: simgrid::s4u::Engine::set_config(const std::string &name, int value) + .. autodoxymethod:: simgrid::s4u::Engine::set_config(const std::string &name, std::string value) .. autodoxymethod:: simgrid::s4u::Engine::load_deployment(const std::string &deploy) .. autodoxymethod:: simgrid::s4u::Engine::load_platform(const std::string &platf) .. autodoxymethod:: simgrid::s4u::Engine::register_actor(const std::string &name) .. autodoxymethod:: simgrid::s4u::Engine::register_actor(const std::string &name, F code) - .. autodoxymethod:: simgrid::s4u::Engine::register_default(int(*code)(int, char **)) - .. autodoxymethod:: simgrid::s4u::Engine::register_function(const std::string &name, int(*code)(int, char **)) + .. autodoxymethod:: simgrid::s4u::Engine::register_default(void(*code)(int, char **)) .. autodoxymethod:: simgrid::s4u::Engine::register_function(const std::string &name, void(*code)(std::vector< std::string >)) + .. autodoxymethod:: simgrid::s4u::Engine::register_function(const std::string &name, void(*code)(int, char **)) .. group-tab:: Python @@ -988,7 +989,7 @@ See :ref:`s4u_receiving_actor`. .. group-tab:: C - .. autodoxymethod:: ::sg_mailbox_set_receiver(const char *alias) + .. autodoxymethod:: sg_mailbox_set_receiver(const char *alias) .. _API_s4u_Resource: @@ -1260,16 +1261,17 @@ Platform and routing .. autodoxymethod:: simgrid::s4u::Host::get_englobing_zone() .. 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::send_to(Host *dest, double byte_amount) + .. 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 ------- @@ -1517,9 +1519,9 @@ Routing data .. 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::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() @@ -1685,8 +1687,8 @@ Querying info .. autodoxymethod:: simgrid::s4u::Activity::get_cname .. autodoxymethod:: simgrid::s4u::Activity::get_name - .. autodoxymethod:: simgrid::s4u::Activity::get_remaining() - .. autodoxymethod:: simgrid::s4u::Activity::get_state() + .. 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) @@ -1740,9 +1742,9 @@ Querying info .. group-tab:: C++ - .. autodoxymethod:: simgrid::s4u::Comm::get_dst_data_size() - .. autodoxymethod:: simgrid::s4u::Comm::get_mailbox() - .. autodoxymethod:: simgrid::s4u::Comm::get_sender() + .. 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()