Bug fix on the Send function scheduled message event time (#48)

* Fixed bug affecting static source and filter applications causing incorrect synchronizations of sent messages. * Restructuring and adding comment about the sending time being relative to ns-3 sim time. Co-authored-by: Marinovici <[email protected]>
GMLC-TDC · Dec 9, 2021 · cdceb94 · cdceb94
1 parent 3d494d1
commit cdceb94
Show file tree

Hide file tree

Showing 4 changed files with 10 additions and 7 deletions.
diff --git a/model/helics-application.cc b/model/helics-application.cc
@@ -38,6 +38,7 @@
 
 #include "ns3/helics.h"
 #include "ns3/helics-application.h"
+#include "ns3/helics-simulator-impl.h"
 #include "helics/helics.hpp"
 
 #include <algorithm>
@@ -315,9 +316,9 @@ HelicsApplication::DoFilter (std::unique_ptr<helics::Message> message)
 }
 
 void 
-HelicsApplication::Send (std::string dest, std::unique_ptr<helics::Message> message)
+HelicsApplication::Send (std::string dest, helics::Time time, std::unique_ptr<helics::Message> message)
 {
-  NS_LOG_FUNCTION (this << dest << message->to_string());
+  NS_LOG_FUNCTION (this << dest << time << message->to_string());
 
   Ptr<Packet> p;
 
@@ -348,8 +349,10 @@ HelicsApplication::Send (std::string dest, std::unique_ptr<helics::Message> mess
   // call to the trace sinks before the packet is actually sent,
   // so that tags added to the packet can be sent as well
   m_txTrace (p);
-
-  int delay_ns = (int) (m_rand_delay_ns->GetValue (m_jitterMinNs,m_jitterMaxNs) + 0.5);
+
+  int64_t jitter_ns = (int) (m_rand_delay_ns->GetValue (m_jitterMinNs, m_jitterMaxNs) + 0.5);
+  // Calculate the delay between when the event happens relative to current ns-3 simulation time
+  int64_t delay_ns = Time::FromDouble (time, Time::S).GetNanoSeconds() - Simulator::Now ().GetNanoSeconds () + jitter_ns;
 
   if (Ipv4Address::IsMatchingType (m_localAddress))
   {

diff --git a/model/helics-application.h b/model/helics-application.h
@@ -102,7 +102,7 @@ class HelicsApplication : public Application
   /**
    * \brief Packet creation based on HELICS data sent to dest.
    */
-  void Send (std::string dest, std::unique_ptr<helics::Message> message);
+  void Send (std::string dest, helics::Time time, std::unique_ptr<helics::Message> message);
 
   /**
    * \brief Receive a HELICS message.

diff --git a/model/helics-filter-application.cc b/model/helics-filter-application.cc
@@ -76,7 +76,7 @@ HelicsFilterApplication::DoEndpoint (helics::Endpoint id, helics::Time time, std
 {
   NS_LOG_FUNCTION (this << id.getName() << time << message->to_string());
 
-  Send (message->original_dest, std::make_unique<helics::Message> (*message));
+  Send (message->original_dest, time, std::make_unique<helics::Message> (*message));
 }
 
 void

diff --git a/model/helics-static-sink-application.cc b/model/helics-static-sink-application.cc
@@ -105,7 +105,7 @@ HelicsStaticSinkApplication::DoEndpoint (helics::Endpoint id, helics::Time time,
 {
   NS_LOG_FUNCTION (this << id.getName() << time << message->to_string());
 
-  Send(m_destination, std::move (message));
+  Send(m_destination, time, std::move (message));
 }
 
 void