Added time reasonability subscription settings

Fixes #1

Author: ritchiecarroll

src/lib/transport/DataSubscriber.cpp

@@ -1255,6 +1255,7 @@ void DataSubscriber::Subscribe()
     connectionStream << "throttled=" << m_subscriptionInfo.Throttled << ";";
     connectionStream << "publishInterval=" << m_subscriptionInfo.PublishInterval << ";";
     connectionStream << "includeTime=" << m_subscriptionInfo.IncludeTime << ";";
+    connectionStream << "enableTimeReasonabilityCheck=" << m_subscriptionInfo.EnableTimeReasonabilityCheck << ";";
     connectionStream << "lagTime=" << m_subscriptionInfo.LagTime << ";";
     connectionStream << "leadTime=" << m_subscriptionInfo.LeadTime << ";";
     connectionStream << "useLocalClockAsRealTime=" << m_subscriptionInfo.UseLocalClockAsRealTime << ";";

src/lib/transport/PublisherInstance.cpp

@@ -492,7 +492,7 @@ SecurityMode PublisherInstance::GetSecurityMode() const
     return m_publisher->GetSecurityMode();
 }
 
-void PublisherInstance::SetSecurityMode(SecurityMode securityMode) const
+void PublisherInstance::SetSecurityMode(const SecurityMode securityMode) const
 {
     m_publisher->SetSecurityMode(securityMode);
 }
@@ -502,7 +502,7 @@ int32_t PublisherInstance::GetMaximumAllowedConnections() const
     return m_publisher->GetMaximumAllowedConnections();
 }
 
-void PublisherInstance::SetMaximumAllowedConnections(int32_t value) const
+void PublisherInstance::SetMaximumAllowedConnections(const int32_t value) const
 {
     m_publisher->SetMaximumAllowedConnections(value);
 }
@@ -512,7 +512,7 @@ bool PublisherInstance::IsMetadataRefreshAllowed() const
     return m_publisher->GetIsMetadataRefreshAllowed();
 }
 
-void PublisherInstance::SetMetadataRefreshAllowed(bool allowed) const
+void PublisherInstance::SetMetadataRefreshAllowed(const bool allowed) const
 {
     m_publisher->SetIsMetadataRefreshAllowed(allowed);
 }
@@ -522,7 +522,7 @@ bool PublisherInstance::IsNaNValueFilterAllowed() const
     return m_publisher->GetIsNaNValueFilterAllowed();
 }
 
-void PublisherInstance::SetNaNValueFilterAllowed(bool allowed) const
+void PublisherInstance::SetNaNValueFilterAllowed(const bool allowed) const
 {
     m_publisher->SetNaNValueFilterAllowed(allowed);
 }
@@ -532,7 +532,7 @@ bool PublisherInstance::IsNaNValueFilterForced() const
     return m_publisher->GetIsNaNValueFilterForced();
 }
 
-void PublisherInstance::SetNaNValueFilterForced(bool forced) const
+void PublisherInstance::SetNaNValueFilterForced(const bool forced) const
 {
     m_publisher->SetIsNaNValueFilterForced(forced);
 }
@@ -542,7 +542,7 @@ bool PublisherInstance::GetSupportsTemporalSubscriptions() const
     return m_publisher->GetSupportsTemporalSubscriptions();
 }
 
-void PublisherInstance::SetSupportsTemporalSubscriptions(bool value) const
+void PublisherInstance::SetSupportsTemporalSubscriptions(const bool value) const
 {
     m_publisher->SetSupportsTemporalSubscriptions(value);
 }
@@ -552,7 +552,7 @@ uint32_t PublisherInstance::GetCipherKeyRotationPeriod() const
     return m_publisher->GetCipherKeyRotationPeriod();
 }
 
-void PublisherInstance::SetCipherKeyRotationPeriod(uint32_t period) const
+void PublisherInstance::SetCipherKeyRotationPeriod(const uint32_t period) const
 {
     m_publisher->SetCipherKeyRotationPeriod(period);
 }

src/lib/transport/SubscriberConnection.cpp

@@ -39,7 +39,7 @@ using namespace sttp::filterexpressions;
 using namespace sttp::transport;
 
 static constexpr uint32_t MaxPacketSize = 32768U;
-static constexpr float64_t DefaultLagTime = 5.0;
+static constexpr float64_t DefaultLagTime = 10.0;
 static constexpr float64_t DefaultLeadTime = 5.0;
 static constexpr float64_t DefaultPublishInterval = 1.0;
 
@@ -59,6 +59,7 @@ SubscriberConnection::SubscriberConnection(DataPublisherPtr parent, IOContext& c
     m_usingPayloadCompression(false),
     m_includeTime(true),
     m_useLocalClockAsRealTime(false),
+    m_enableTimeReasonabilityCheck(false),
     m_lagTime(DefaultLagTime),
     m_leadTime(DefaultLeadTime),
     m_publishInterval(DefaultPublishInterval),
@@ -677,7 +678,7 @@ void SubscriberConnection::PublishMeasurements(const vector<MeasurementPtr>& mea
         {
             const Guid signalID = measurement->SignalID;
 
-            if (TimestampIsReasonable(measurement->Timestamp, m_lagTime, m_leadTime) || GetIsTemporalSubscription())
+            if (!m_enableTimeReasonabilityCheck || TimestampIsReasonable(measurement->Timestamp, m_lagTime, m_leadTime) || GetIsTemporalSubscription())
             {
                 m_latestMeasurements.insert_or_assign(signalID, measurement);
             }
@@ -782,6 +783,11 @@ void SubscriberConnection::HandleSubscribe(uint8_t* data, uint32_t length)
         else
             m_useLocalClockAsRealTime = false;
 
+        if (TryGetValue(settings, "enableTimeReasonabilityCheck", setting))
+            TryParseBoolean(setting, m_enableTimeReasonabilityCheck);
+        else
+            m_enableTimeReasonabilityCheck = true;
+
         if (TryGetValue(settings, "lagTime", setting) && !setting.empty())
             TryParseDouble(setting, m_lagTime, DefaultLagTime);
         else
@@ -1018,7 +1024,7 @@ void SubscriberConnection::HandleSubscribe(uint8_t* data, uint32_t length)
                 {
                     MeasurementPtr measurement = element.second;
 
-                    if (!TimestampIsReasonable(measurement->Timestamp, m_lagTime, m_leadTime) && !GetIsTemporalSubscription())
+                    if (m_enableTimeReasonabilityCheck && !TimestampIsReasonable(measurement->Timestamp, m_lagTime, m_leadTime) && !GetIsTemporalSubscription())
                     {
                         measurement->Value = NaN;
                         measurement->Flags |= MeasurementStateFlags::BadTime;
@@ -1489,7 +1495,7 @@ void SubscriberConnection::PublishCompactMeasurements(const std::vector<Measurem
         count++; //-V127
 
         // Track latest timestamp
-        if (!m_useLocalClockAsRealTime && timestamp > m_latestTimestamp && (TimestampIsReasonable(timestamp, m_lagTime, m_leadTime) || GetIsTemporalSubscription()))
+        if (!m_useLocalClockAsRealTime && timestamp > m_latestTimestamp && (!m_enableTimeReasonabilityCheck || TimestampIsReasonable(timestamp, m_lagTime, m_leadTime) || GetIsTemporalSubscription()))
             m_latestTimestamp = timestamp;
     }
 

src/lib/transport/SubscriberConnection.h

@@ -64,6 +64,7 @@ namespace sttp::transport
         bool m_usingPayloadCompression;
         bool m_includeTime;
         bool m_useLocalClockAsRealTime;
+        bool m_enableTimeReasonabilityCheck;
         float64_t m_lagTime;
         float64_t m_leadTime;
         float64_t m_publishInterval;

src/lib/transport/SubscriptionInfo.cpp

@@ -31,6 +31,7 @@ SubscriptionInfo::SubscriptionInfo() :
     UdpDataChannel(false),
     DataChannelLocalPort(9500),
     IncludeTime(true),
+    EnableTimeReasonabilityCheck(false),
     LagTime(10.0),
     LeadTime(5.0),
     UseLocalClockAsRealTime(false),

src/lib/transport/SubscriptionInfo.h

@@ -42,6 +42,7 @@ namespace sttp::transport
 
         // Compact measurement properties
         bool IncludeTime;
+        bool EnableTimeReasonabilityCheck;
         float64_t LagTime;
         float64_t LeadTime;
         bool UseLocalClockAsRealTime;

src/sttp.cpp.sln.DotSettings

@@ -7,5 +7,6 @@
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=Iter/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=localport/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=phasors/@EntryIndexedValue">True</s:Boolean>
+	<s:Boolean x:Key="/Default/UserDictionary/Words/=Reasonability/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=sttp/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=TSSC/@EntryIndexedValue">True</s:Boolean></wpf:ResourceDictionary>