First attempt at BrokerClientEntryPDU

peternewman · peternewman · commit a81c83d1829a · 2024-03-22T00:01:46.000Z
(cherry picked from commit 2a43710)
diff --git a/libs/acn/BrokerClientEntryHeader.h b/libs/acn/BrokerClientEntryHeader.h
@@ -0,0 +1,63 @@
+/*
+ * 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.
+ *
+ * BrokerClientEntryHeader.h
+ * The E1.33 Broker Client Entry Header
+ * Copyright (C) 2023 Peter Newman
+ */
+
+#ifndef LIBS_ACN_BROKERCLIENTENTRYHEADER_H_
+#define LIBS_ACN_BROKERCLIENTENTRYHEADER_H_
+
+#include <ola/acn/CID.h>
+#include <ola/base/Macro.h>
+
+#include <stdint.h>
+
+namespace ola {
+namespace acn {
+
+// TODO(Peter): I think technically this probably shouldn't be a header and
+// instead is just data at this level!
+/*
+ * Header for the Broker Client Entry level
+ */
+class BrokerClientEntryHeader {
+ public:
+    BrokerClientEntryHeader() {}
+
+    BrokerClientEntryHeader(const ola::acn::CID &client_cid)
+        : m_client_cid(client_cid) {
+    }
+    ~BrokerClientEntryHeader() {}
+
+    const ola::acn::CID ClientCid() const { return m_client_cid; }
+
+    bool operator==(const BrokerClientEntryHeader &other) const {
+      return m_client_cid == other.m_client_cid;
+    }
+
+    PACK(
+    struct broker_client_entry_pdu_header_s {
+      uint8_t client_cid[CID::CID_LENGTH];
+    });
+    typedef struct broker_client_entry_pdu_header_s broker_client_entry_pdu_header;
+
+ private:
+    ola::acn::CID m_client_cid;
+};
+}  // namespace acn
+}  // namespace ola
+#endif  // LIBS_ACN_BROKERCLIENTENTRYHEADER_H_
diff --git a/libs/acn/BrokerClientEntryPDU.cpp b/libs/acn/BrokerClientEntryPDU.cpp
@@ -0,0 +1,114 @@
+/*
+ * 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.
+ *
+ * BrokerClientEntryPDU.cpp
+ * The BrokerClientEntryPDU
+ * Copyright (C) 2023 Peter Newman
+ */
+
+
+#include "ola/Logging.h"
+#include "ola/base/Array.h"
+#include "ola/network/NetworkUtils.h"
+#include "libs/acn/BrokerClientEntryPDU.h"
+
+namespace ola {
+namespace acn {
+
+using ola::io::OutputStream;
+using ola::network::HostToNetwork;
+
+/*
+ * Size of the header portion.
+ */
+unsigned int BrokerClientEntryPDU::HeaderSize() const {
+  return sizeof(BrokerClientEntryHeader::broker_client_entry_pdu_header);
+}
+
+
+/*
+ * Size of the data portion
+ */
+unsigned int BrokerClientEntryPDU::DataSize() const {
+  return m_pdu ? m_pdu->Size() : 0;
+}
+
+
+/*
+ * Pack the header portion.
+ */
+bool BrokerClientEntryPDU::PackHeader(uint8_t *data, unsigned int *length) const {
+  unsigned int header_size = HeaderSize();
+
+  if (*length < header_size) {
+    OLA_WARN << "BrokerClientEntryPDU::PackHeader: buffer too small, got " << *length
+             << " required " << header_size;
+    *length = 0;
+    return false;
+  }
+
+  BrokerClientEntryHeader::broker_client_entry_pdu_header header;
+  m_header.ClientCid().Pack(header.client_cid);
+  *length = sizeof(BrokerClientEntryHeader::broker_client_entry_pdu_header);
+  memcpy(data, &header, *length);
+  return true;
+}
+
+
+/*
+ * Pack the data portion.
+ */
+bool BrokerClientEntryPDU::PackData(uint8_t *data, unsigned int *length) const {
+  if (m_pdu)
+    return m_pdu->Pack(data, length);
+  *length = 0;
+  return true;
+}
+
+
+/*
+ * Pack the header into a buffer.
+ */
+void BrokerClientEntryPDU::PackHeader(OutputStream *stream) const {
+  BrokerClientEntryHeader::broker_client_entry_pdu_header header;
+  m_header.ClientCid().Pack(header.client_cid);
+  stream->Write(reinterpret_cast<uint8_t*>(&header),
+                sizeof(BrokerClientEntryHeader::broker_client_entry_pdu_header));
+}
+
+
+/*
+ * Pack the data into a buffer
+ */
+void BrokerClientEntryPDU::PackData(OutputStream *stream) const {
+  if (m_pdu)
+    m_pdu->Write(stream);
+}
+
+
+void BrokerClientEntryPDU::PrependPDU(ola::io::IOStack *stack,
+                                      uint32_t vector,
+                                      const ola::acn::CID &client_cid) {
+  BrokerClientEntryHeader::broker_client_entry_pdu_header header;
+  client_cid.Pack(header.client_cid);
+  stack->Write(reinterpret_cast<uint8_t*>(&header),
+               sizeof(BrokerClientEntryHeader::broker_client_entry_pdu_header));
+
+  vector = HostToNetwork(vector);
+  stack->Write(reinterpret_cast<uint8_t*>(&vector), sizeof(vector));
+  PrependFlagsAndLength(stack, VFLAG_MASK | HFLAG_MASK | DFLAG_MASK, true);
+}
+}  // namespace acn
+}  // namespace ola
diff --git a/libs/acn/BrokerClientEntryPDU.h b/libs/acn/BrokerClientEntryPDU.h
@@ -0,0 +1,61 @@
+/*
+ * 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.
+ *
+ * BrokerClientEntryPDU.h
+ * Interface for the BrokerClientEntryPDU class
+ * Copyright (C) 2023 Peter Newman
+ */
+
+#ifndef LIBS_ACN_BROKERCLIENTENTRYPDU_H_
+#define LIBS_ACN_BROKERCLIENTENTRYPDU_H_
+
+#include <ola/acn/CID.h>
+#include <ola/io/IOStack.h>
+
+#include "libs/acn/PDU.h"
+#include "libs/acn/BrokerClientEntryHeader.h"
+
+namespace ola {
+namespace acn {
+
+class BrokerClientEntryPDU: public PDU {
+ public:
+    BrokerClientEntryPDU(unsigned int vector,
+            const BrokerClientEntryHeader &header,
+            const PDU *pdu):
+      PDU(vector, FOUR_BYTES, true),
+      m_header(header),
+      m_pdu(pdu) {}
+    ~BrokerClientEntryPDU() {}
+
+    unsigned int HeaderSize() const;
+    unsigned int DataSize() const;
+    bool PackHeader(uint8_t *data, unsigned int *length) const;
+    bool PackData(uint8_t *data, unsigned int *length) const;
+
+    void PackHeader(ola::io::OutputStream *stream) const;
+    void PackData(ola::io::OutputStream *stream) const;
+
+    static void PrependPDU(ola::io::IOStack *stack,
+                           uint32_t vector,
+                           const ola::acn::CID &client_cid);
+
+ private:
+    BrokerClientEntryHeader m_header;
+    const PDU *m_pdu;
+};
+}  // namespace acn
+}  // namespace ola
+#endif  // LIBS_ACN_BROKERCLIENTENTRYPDU_H_
diff --git a/libs/acn/BrokerClientEntryPDUTest.cpp b/libs/acn/BrokerClientEntryPDUTest.cpp
@@ -0,0 +1,141 @@
+/*
+ * 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.
+ *
+ * BrokerClientEntryPDUTest.cpp
+ * Test fixture for the BrokerClientEntryPDU class
+ * Copyright (C) 2023 Peter Newman
+ */
+
+#include <cppunit/extensions/HelperMacros.h>
+
+#include "ola/Logging.h"
+#include "ola/io/IOQueue.h"
+#include "ola/io/OutputStream.h"
+#include "ola/network/NetworkUtils.h"
+#include "ola/testing/TestUtils.h"
+#include "libs/acn/BrokerClientEntryPDU.h"
+#include "libs/acn/PDUTestCommon.h"
+
+
+namespace ola {
+namespace acn {
+
+using ola::io::IOQueue;
+using ola::io::OutputStream;
+using ola::network::HostToNetwork;
+
+class BrokerClientEntryPDUTest: public CppUnit::TestFixture {
+  CPPUNIT_TEST_SUITE(BrokerClientEntryPDUTest);
+  CPPUNIT_TEST(testSimpleBrokerClientEntryPDU);
+  CPPUNIT_TEST(testSimpleBrokerClientEntryPDUToOutputStream);
+  CPPUNIT_TEST_SUITE_END();
+
+ public:
+  void testSimpleBrokerClientEntryPDU();
+  void testSimpleBrokerClientEntryPDUToOutputStream();
+
+  void setUp() {
+    ola::InitLogging(ola::OLA_LOG_DEBUG, ola::OLA_LOG_STDERR);
+  }
+
+ private:
+  static const unsigned int TEST_VECTOR;
+  static const uint8_t TEST_DATA[];
+};
+
+const uint8_t BrokerClientEntryPDUTest::TEST_DATA[] = {0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11,
+                                                       12, 13, 14, 15};
+
+CPPUNIT_TEST_SUITE_REGISTRATION(BrokerClientEntryPDUTest);
+
+const unsigned int BrokerClientEntryPDUTest::TEST_VECTOR = 39;
+
+
+/*
+ * Test that packing a BrokerClientEntryPDU without data works.
+ */
+void BrokerClientEntryPDUTest::testSimpleBrokerClientEntryPDU() {
+  const CID client_cid = CID::FromData(TEST_DATA);
+  BrokerClientEntryHeader header(client_cid);
+  BrokerClientEntryPDU pdu(TEST_VECTOR, header, NULL);
+
+  OLA_ASSERT_EQ(16u, pdu.HeaderSize());
+  OLA_ASSERT_EQ(0u, pdu.DataSize());
+  OLA_ASSERT_EQ(23u, pdu.Size());
+
+  unsigned int size = pdu.Size();
+  uint8_t *data = new uint8_t[size];
+  unsigned int bytes_used = size;
+  OLA_ASSERT(pdu.Pack(data, &bytes_used));
+  OLA_ASSERT_EQ(size, bytes_used);
+
+  // spot check the data
+  OLA_ASSERT_EQ((uint8_t) 0xf0, data[0]);
+  // bytes_used is technically data[1] and data[2] if > 255
+  OLA_ASSERT_EQ((uint8_t) bytes_used, data[2]);
+  unsigned int actual_value;
+  memcpy(&actual_value, data + 3, sizeof(actual_value));
+  OLA_ASSERT_EQ(HostToNetwork(TEST_VECTOR), actual_value);
+
+  uint8_t buffer[CID::CID_LENGTH];
+  client_cid.Pack(buffer);
+  OLA_ASSERT_DATA_EQUALS(&data[7], CID::CID_LENGTH, buffer, sizeof(buffer));
+
+  // test undersized buffer
+  bytes_used = size - 1;
+  OLA_ASSERT_FALSE(pdu.Pack(data, &bytes_used));
+  OLA_ASSERT_EQ(0u, bytes_used);
+
+  // test oversized buffer
+  bytes_used = size + 1;
+  OLA_ASSERT(pdu.Pack(data, &bytes_used));
+  OLA_ASSERT_EQ(size, bytes_used);
+  delete[] data;
+}
+
+
+/*
+ * Test that writing to an output stream works.
+ */
+void BrokerClientEntryPDUTest::testSimpleBrokerClientEntryPDUToOutputStream() {
+  const ola::acn::CID client_cid = CID::FromData(TEST_DATA);
+  BrokerClientEntryHeader header(client_cid);
+  BrokerClientEntryPDU pdu(TEST_VECTOR, header, NULL);
+
+  OLA_ASSERT_EQ(16u, pdu.HeaderSize());
+  OLA_ASSERT_EQ(0u, pdu.DataSize());
+  OLA_ASSERT_EQ(23u, pdu.Size());
+
+  IOQueue output;
+  OutputStream stream(&output);
+  pdu.Write(&stream);
+  OLA_ASSERT_EQ(23u, output.Size());
+
+  uint8_t *pdu_data = new uint8_t[output.Size()];
+  unsigned int pdu_size = output.Peek(pdu_data, output.Size());
+  OLA_ASSERT_EQ(output.Size(), pdu_size);
+
+  uint8_t EXPECTED[] = {
+    0xf0, 0x00, 0x17,
+    0, 0, 0, 39,
+    0, 1, 2, 3, 4, 5, 6, 7,
+    8, 9, 10, 11, 12, 13, 14, 15
+  };
+  OLA_ASSERT_DATA_EQUALS(EXPECTED, sizeof(EXPECTED), pdu_data, pdu_size);
+  output.Pop(output.Size());
+  delete[] pdu_data;
+}
+}  // namespace acn
+}  // namespace ola
diff --git a/libs/acn/BrokerPDU.h b/libs/acn/BrokerPDU.h
@@ -25,7 +25,6 @@
 #include <ola/io/IOStack.h>
 
 #include "libs/acn/PDU.h"
-#include "libs/acn/BrokerHeader.h"
 
 namespace ola {
 namespace acn {
diff --git a/libs/acn/Makefile.mk b/libs/acn/Makefile.mk
