X-Git-Url: http://bilbo.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/a1958aceb8f70618dac966308391b311912a15f8..6721094a6e5bc535c446266801f713c9e99ac968:/src/kernel/resource/NetworkModel.hpp diff --git a/src/kernel/resource/NetworkModel.hpp b/src/kernel/resource/NetworkModel.hpp index 06ada6816d..350877794c 100644 --- a/src/kernel/resource/NetworkModel.hpp +++ b/src/kernel/resource/NetworkModel.hpp @@ -1,4 +1,4 @@ -/* Copyright (c) 2004-2022. The SimGrid Team. All rights reserved. */ +/* Copyright (c) 2004-2023. The SimGrid Team. All rights reserved. */ /* This program is free software; you can redistribute it and/or modify it * under the terms of the license (GNU LGPL) which comes with this package. */ @@ -18,8 +18,8 @@ namespace simgrid::kernel::resource { * Model * *********/ -/** @ingroup SURF_network_interface - * @brief SURF network model interface class +/** @ingroup Model_network_interface + * @brief Network model interface class * @details A model is an object which handles the interactions between its Resources and its Actions */ class NetworkModel : public Model, public NetworkModelFactors { @@ -53,7 +53,7 @@ public: * @param rate Allows to limit the transfer rate. Negative value means unlimited. * @return The action representing the communication */ - virtual Action* communicate(s4u::Host* src, s4u::Host* dst, double size, double rate) = 0; + virtual Action* communicate(s4u::Host* src, s4u::Host* dst, double size, double rate, bool streamed) = 0; double next_occurring_event_full(double now) override; @@ -63,8 +63,8 @@ public: /********** * Action * **********/ -/** @ingroup SURF_network_interface - * @brief SURF network action interface class +/** @ingroup Model_network_interface + * @brief Network action interface class * @details A NetworkAction represents a communication between two [hosts](@ref HostImpl) */ class NetworkAction : public Action { @@ -75,8 +75,8 @@ public: /** @brief Constructor * * @param model The NetworkModel associated to this NetworkAction - * @param cost The cost of this NetworkAction in [TODO] - * @param failed [description] + * @param cost The cost of this NetworkAction in bytes + * @param failed Actions can be created in a failed state */ NetworkAction(Model* model, s4u::Host& src, s4u::Host& dst, double cost, bool failed) : Action(model, cost, failed), src_(src), dst_(dst)