Merge pull request #1947 from peternewman/e1.33-cherry-pick

E1.33 cherry pick third time lucky

Author: peternewman

common/network/HealthCheckedConnection.cpp

@@ -26,14 +26,25 @@ namespace network {
 
 HealthCheckedConnection::HealthCheckedConnection(
   ola::thread::SchedulerInterface *scheduler,
+  const ola::TimeInterval heartbeat_interval,
   const ola::TimeInterval timeout_interval)
     : m_scheduler(scheduler),
-      m_heartbeat_interval(timeout_interval),
+      m_heartbeat_interval(heartbeat_interval),
+      m_timeout_interval(timeout_interval),
       m_send_timeout_id(ola::thread::INVALID_TIMEOUT),
       m_receive_timeout_id(ola::thread::INVALID_TIMEOUT) {
 }
 
 
+HealthCheckedConnection::HealthCheckedConnection(
+  ola::thread::SchedulerInterface *scheduler,
+  const ola::TimeInterval heartbeat_interval)
+    : HealthCheckedConnection(scheduler,
+                              heartbeat_interval,
+                              ola::TimeInterval(static_cast<int>(
+                                  2.5 * heartbeat_interval.AsInt()))) {
+}
+
 HealthCheckedConnection::~HealthCheckedConnection() {
   if (m_send_timeout_id != ola::thread::INVALID_TIMEOUT)
     m_scheduler->RemoveTimeout(m_send_timeout_id);
@@ -101,10 +112,8 @@ bool HealthCheckedConnection::SendNextHeartbeat() {
 
 
 void HealthCheckedConnection::UpdateReceiveTimer() {
-  TimeInterval timeout_interval(static_cast<int>(
-        2.5 * m_heartbeat_interval.AsInt()));
   m_receive_timeout_id = m_scheduler->RegisterSingleTimeout(
-    timeout_interval,
+    m_timeout_interval,
     NewSingleCallback(
       this, &HealthCheckedConnection::InternalHeartbeatTimeout));
 }

common/network/HealthCheckedConnectionTest.cpp

@@ -56,10 +56,28 @@ class MockHealthCheckedConnection: public HealthCheckedConnection {
 
     MockHealthCheckedConnection(ola::io::ConnectedDescriptor *descriptor,
                                 SelectServer *scheduler,
+                                const ola::TimeInterval heartbeat_interval,
                                 const ola::TimeInterval timeout_interval,
                                 const Options &options,
                                 MockClock *clock)
-        : HealthCheckedConnection(scheduler, timeout_interval),
+        : HealthCheckedConnection(scheduler,
+                                  heartbeat_interval,
+                                  timeout_interval),
+          m_descriptor(descriptor),
+          m_ss(scheduler),
+          m_options(options),
+          m_next_heartbeat(0),
+          m_expected_heartbeat(0),
+          m_channel_ok(true),
+          m_clock(clock) {
+    }
+
+    MockHealthCheckedConnection(ola::io::ConnectedDescriptor *descriptor,
+                                SelectServer *scheduler,
+                                const ola::TimeInterval heartbeat_interval,
+                                const Options &options,
+                                MockClock *clock)
+        : HealthCheckedConnection(scheduler, heartbeat_interval),
           m_descriptor(descriptor),
           m_ss(scheduler),
           m_options(options),
@@ -70,8 +88,10 @@ class MockHealthCheckedConnection: public HealthCheckedConnection {
     }
 
     void SendHeartbeat() {
+      OLA_DEBUG << "Maybe send heartbeat";
       if (m_options.send_every == 0 ||
           m_next_heartbeat % m_options.send_every == 0) {
+        OLA_DEBUG << "Sending heartbeat";
         m_descriptor->Send(&m_next_heartbeat, sizeof(m_next_heartbeat));
       }
       m_clock->AdvanceTime(0, 180000);
@@ -115,13 +135,18 @@ class HealthCheckedConnectionTest: public CppUnit::TestFixture {
     HealthCheckedConnectionTest()
         : CppUnit::TestFixture(),
           m_ss(NULL, &m_clock),
-          heartbeat_interval(0, 200000) {
+          heartbeat_interval(0, 200000),
+          // Allow a little bit of wiggle room so we don't hit timing issues
+          // when running the tests
+          timeout_interval(0, 650000) {
     }
 
   CPPUNIT_TEST_SUITE(HealthCheckedConnectionTest);
   CPPUNIT_TEST(testSimpleChannel);
   CPPUNIT_TEST(testChannelWithPacketLoss);
   CPPUNIT_TEST(testChannelWithHeavyPacketLoss);
+  CPPUNIT_TEST(testChannelWithHeavyPacketLossLongerTimeout);
+  CPPUNIT_TEST(testChannelWithVeryHeavyPacketLossLongerTimeout);
   CPPUNIT_TEST(testPauseAndResume);
   CPPUNIT_TEST_SUITE_END();
 
@@ -131,6 +156,8 @@ class HealthCheckedConnectionTest: public CppUnit::TestFixture {
     void testSimpleChannel();
     void testChannelWithPacketLoss();
     void testChannelWithHeavyPacketLoss();
+    void testChannelWithHeavyPacketLossLongerTimeout();
+    void testChannelWithVeryHeavyPacketLossLongerTimeout();
     void testPauseAndResume();
 
     void PauseReading(MockHealthCheckedConnection *connection) {
@@ -148,6 +175,7 @@ class HealthCheckedConnectionTest: public CppUnit::TestFixture {
     SelectServer m_ss;
     LoopbackDescriptor socket;
     TimeInterval heartbeat_interval;
+    TimeInterval timeout_interval;
     MockHealthCheckedConnection::Options options;
 };
 
@@ -206,7 +234,7 @@ void HealthCheckedConnectionTest::testChannelWithPacketLoss() {
 
 
 /**
- * Check the channel works when every 2nd heartbeat is lost
+ * Check the channel fails when 2 of every 3 heartbeats are lost
  */
 void HealthCheckedConnectionTest::testChannelWithHeavyPacketLoss() {
   options.send_every = 3;
@@ -228,6 +256,57 @@ void HealthCheckedConnectionTest::testChannelWithHeavyPacketLoss() {
 }
 
 
+/**
+ * Check the channel works when 2 of every 3 heartbeats are lost but the
+ * timeout interval is 3 * heartbeat_interval rather than the default
+ */
+void HealthCheckedConnectionTest::
+    testChannelWithHeavyPacketLossLongerTimeout() {
+  options.send_every = 3;
+  MockHealthCheckedConnection connection(&socket,
+                                         &m_ss,
+                                         heartbeat_interval,
+                                         timeout_interval,
+                                         options,
+                                         &m_clock);
+
+  socket.SetOnData(
+      NewCallback(&connection, &MockHealthCheckedConnection::ReadData));
+  connection.Setup();
+  m_ss.AddReadDescriptor(&socket);
+  connection.Setup();
+
+  m_ss.Run();
+  OLA_ASSERT_TRUE(connection.ChannelOk());
+}
+
+
+/**
+ * Check the channel fails when 3 of every 4 heartbeats are lost even though
+ * the timeout interval is 3 * heartbeat_interval
+ */
+void HealthCheckedConnectionTest::
+    testChannelWithVeryHeavyPacketLossLongerTimeout() {
+  options.send_every = 4;
+  options.abort_on_failure = false;
+  MockHealthCheckedConnection connection(&socket,
+                                         &m_ss,
+                                         heartbeat_interval,
+                                         timeout_interval,
+                                         options,
+                                         &m_clock);
+
+  socket.SetOnData(
+      NewCallback(&connection, &MockHealthCheckedConnection::ReadData));
+  connection.Setup();
+  m_ss.AddReadDescriptor(&socket);
+  connection.Setup();
+
+  m_ss.Run();
+  OLA_ASSERT_FALSE(connection.ChannelOk());
+}
+
+
 /**
  * Check pausing doesn't mark the channel as bad.
  */

include/ola/e133/E133Enums.h

@@ -96,6 +96,11 @@ enum E133DisconnectStatusCode {
 enum {
   MAX_E133_STATUS_STRING_SIZE = 64
 };
+
+// The E1.33 version.
+enum {
+  E133_VERSION = 1
+};
 }  // namespace e133
 }  // namespace ola
 #endif  // INCLUDE_OLA_E133_E133ENUMS_H_

include/ola/network/HealthCheckedConnection.h

@@ -18,16 +18,17 @@
  *
  * This class adds health checking to a connection, which ensures that the
  * connection is able to transfer data in a timely manner. The implementation
- * is pretty simple: we define a heart beat interval I, which *must* be the
+ * is pretty simple: we define a heartbeat interval I, which *must* be the
  * same at both ends of the connection. Every I seconds, both ends send a
- * heart beat message and if either end doesn't receive a heart beat in
- * 2.5 * I, the connection is deemed dead, and the connection is closed.
+ * heartbeat message and if either end doesn't receive a heartbeat within the
+ * timeout interval (which defaults to 2.5 * I if not specified), the
+ * connection is deemed dead, and the connection is closed.
  *
  * This class provides the basic health check mechanism, the sub class is left
  * to define the format of the heartbeat message.
  *
  * To use this health checked channel, subclass HealthCheckedConnection, and
- * provide the SendHeartbeat() and HeartbeatTimeout methods.
+ * provide the SendHeartbeat() and HeartbeatTimeout() methods.
  *
  * There are some additional features:
  *  - Some receivers may want to stop reading from a connection under some
@@ -57,7 +58,10 @@ namespace network {
 class HealthCheckedConnection {
  public:
     HealthCheckedConnection(ola::thread::SchedulerInterface *scheduler,
+                            const ola::TimeInterval heartbeat_interval,
                             const ola::TimeInterval timeout_interval);
+    HealthCheckedConnection(ola::thread::SchedulerInterface *scheduler,
+                            const ola::TimeInterval heartbeat_interval);
     virtual ~HealthCheckedConnection();
 
     /**
@@ -106,6 +110,7 @@ class HealthCheckedConnection {
  private:
     ola::thread::SchedulerInterface *m_scheduler;
     ola::TimeInterval m_heartbeat_interval;
+    ola::TimeInterval m_timeout_interval;
     ola::thread::timeout_id m_send_timeout_id;
     ola::thread::timeout_id m_receive_timeout_id;
 

include/ola/rdm/RDMEnums.h

@@ -718,6 +718,9 @@ static const uint8_t MAX_RDM_HOSTNAME_LENGTH = 63;
 static const uint8_t MAX_RDM_DOMAIN_NAME_LENGTH = 231;
 
 static const uint8_t DNS_NAME_SERVER_MAX_INDEX = 2;
+
+// Excluding the mandatory NULL terminator
+static const uint8_t MAX_RDM_SCOPE_STRING_LENGTH = 62;
 }  // namespace rdm
 }  // namespace ola
 #endif  // INCLUDE_OLA_RDM_RDMENUMS_H_

libs/acn/BrokerClientAddInflator.h

@@ -0,0 +1,55 @@
+/*
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Library General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * BrokerClientAddInflator.h
+ * Interface for the BrokerClientAddInflator class.
+ * Copyright (C) 2023 Peter Newman
+ */
+
+#ifndef LIBS_ACN_BROKERCLIENTADDINFLATOR_H_
+#define LIBS_ACN_BROKERCLIENTADDINFLATOR_H_
+
+#include "ola/acn/ACNVectors.h"
+#include "libs/acn/BaseInflator.h"
+
+namespace ola {
+namespace acn {
+
+class BrokerClientAddInflator: public BaseInflator {
+  friend class BrokerClientAddInflatorTest;
+
+ public:
+  BrokerClientAddInflator()
+    : BaseInflator() {
+  }
+  ~BrokerClientAddInflator() {}
+
+  uint32_t Id() const { return ola::acn::VECTOR_BROKER_CLIENT_ADD; }
+
+ protected:
+  // The 'header' is 0 bytes in length.
+  bool DecodeHeader(HeaderSet*,
+                    const uint8_t*,
+                    unsigned int,
+                    unsigned int *bytes_used) {
+    *bytes_used = 0;
+    return true;
+  }
+
+  void ResetHeaderField() {}  // namespace noop
+};
+}  // namespace acn
+}  // namespace ola
+#endif  // LIBS_ACN_BROKERCLIENTADDINFLATOR_H_

libs/acn/BrokerClientEntryChangeInflator.h

@@ -0,0 +1,55 @@
+/*
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Library General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * BrokerClientEntryChangeInflator.h
+ * Interface for the BrokerClientEntryChangeInflator class.
+ * Copyright (C) 2023 Peter Newman
+ */
+
+#ifndef LIBS_ACN_BROKERCLIENTENTRYCHANGEINFLATOR_H_
+#define LIBS_ACN_BROKERCLIENTENTRYCHANGEINFLATOR_H_
+
+#include "ola/acn/ACNVectors.h"
+#include "libs/acn/BaseInflator.h"
+
+namespace ola {
+namespace acn {
+
+class BrokerClientEntryChangeInflator: public BaseInflator {
+  friend class BrokerClientEntryChangeInflatorTest;
+
+ public:
+  BrokerClientEntryChangeInflator()
+    : BaseInflator() {
+  }
+  ~BrokerClientEntryChangeInflator() {}
+
+  uint32_t Id() const { return ola::acn::VECTOR_BROKER_CLIENT_ENTRY_CHANGE; }
+
+ protected:
+  // The 'header' is 0 bytes in length.
+  bool DecodeHeader(HeaderSet*,
+                    const uint8_t*,
+                    unsigned int,
+                    unsigned int *bytes_used) {
+    *bytes_used = 0;
+    return true;
+  }
+
+  void ResetHeaderField() {}  // namespace noop
+};
+}  // namespace acn
+}  // namespace ola
+#endif  // LIBS_ACN_BROKERCLIENTENTRYCHANGEINFLATOR_H_