[simulator] RequestChannel message instead of sendInitialState()

Author: gfgit

server/src/simulator/simulatoriohandler.cpp

@@ -148,7 +148,8 @@ void SimulatorIOHandler::receive(const SimulatorProtocol::Message& message)
       break;
 
   case OpCode::HandshakeResponse:
-    // This is never sent by simulator, only by us in response
+  case OpCode::RequestChannel:
+    // This is never sent by simulator, only by simulator clients
     break;
   }
 }

shared/src/traintastic/simulator/protocol.hpp

@@ -36,7 +36,9 @@ enum class OpCode : uint8_t
   SensorChanged = 3,
   AccessorySetState = 4,
   Handshake = 5,
-  HandshakeResponse = 6
+  HandshakeResponse = 6,
+  // Other messages
+  RequestChannel = 9
 };
 
 struct Message
@@ -128,6 +130,19 @@ struct AccessorySetState : Message
 } ATTRIBUTE_PACKED;
 static_assert(sizeof(AccessorySetState) == 7);
 
+struct RequestChannel : Message
+{
+  //! NOTE: pass invalidAddress to get all channels state
+  uint16_t channel;
+
+  RequestChannel(uint16_t ch)
+    : Message(OpCode::RequestChannel, sizeof(RequestChannel))
+    , channel{ch}
+  {
+  }
+} ATTRIBUTE_PACKED;
+static_assert(sizeof(RequestChannel) == 4);
+
 PRAGMA_PACK_POP
 
 }

shared/src/traintastic/simulator/simulator.cpp

@@ -565,7 +565,7 @@ void Simulator::send(const SimulatorProtocol::Message& message)
   }
 }
 
-void Simulator::receive(const SimulatorProtocol::Message& message)
+void Simulator::receive(const SimulatorProtocol::Message& message, size_t fromConnId)
 {
   using namespace SimulatorProtocol;
 
@@ -669,6 +669,30 @@ void Simulator::receive(const SimulatorProtocol::Message& message)
     case OpCode::Handshake:
     case OpCode::HandshakeResponse:
       break; // handled by SimulatorConnection already
+    case OpCode::RequestChannel:
+    {
+      const auto& m = static_cast<const RequestChannel&>(message);
+      std::lock_guard<std::mutex> lock(m_stateMutex);
+
+      const size_t count = staticData.sensors.size();
+      for(size_t i = 0; i < count; ++i)
+      {
+        const auto& sensor = staticData.sensors[i];
+        if(m.channel != invalidAddress && m.channel != sensor.channel)
+          continue;
+
+        auto& sensorState = m_stateData.sensors[i];
+
+        for(const auto& connection : m_connections)
+        {
+          if(connection->connectionId() != fromConnId)
+            continue;
+          connection->send(SimulatorProtocol::SensorChanged(sensor.channel, sensor.address, sensorState.value));
+          break;
+        }
+      }
+      break;
+    }
   }
 }
 
@@ -693,8 +717,13 @@ void Simulator::accept()
     {
       if(!ec)
       {
-        m_connections.emplace_back(std::make_shared<SimulatorConnection>(shared_from_this(), std::move(socket)))->start();
-        sendInitialState(*m_connections.rbegin());
+        lastConnectionId++;
+        if(lastConnectionId == invalidIndex)
+          lastConnectionId = 0;
+
+        m_connections.emplace_back(std::make_shared<SimulatorConnection>(
+                                     shared_from_this(), std::move(socket),
+                                     lastConnectionId))->start();
         accept();
       }
     });
@@ -1643,15 +1672,3 @@ Simulator::StaticData Simulator::load(const nlohmann::json& world, StateData& st
 
   return data;
 }
-
-void Simulator::sendInitialState(const std::shared_ptr<SimulatorConnection> &connection)
-{
-  // Send current sensor state
-  const size_t count = staticData.sensors.size();
-  for(size_t i = 0; i < count; ++i)
-  {
-    const auto& sensor = staticData.sensors[i];
-    auto& sensorState = m_stateData.sensors[i];
-    connection->send(SimulatorProtocol::SensorChanged(sensor.channel, sensor.address, sensorState.value));
-  }
-}

shared/src/traintastic/simulator/simulator.hpp

@@ -263,7 +263,7 @@ class Simulator : public std::enable_shared_from_this<Simulator>
   void toggleTurnoutState(size_t segmentIndex);
 
   void send(const SimulatorProtocol::Message& message);
-  void receive(const SimulatorProtocol::Message& message);
+  void receive(const SimulatorProtocol::Message& message, size_t fromConnId);
   void removeConnection(const std::shared_ptr<SimulatorConnection>& connection);
 
 private:
@@ -292,8 +292,6 @@ class Simulator : public std::enable_shared_from_this<Simulator>
   void doReceive();
   void onConnectionRemoved(const std::shared_ptr<SimulatorConnection> &);
 
-  void sendInitialState(const std::shared_ptr<SimulatorConnection>& connection);
-
   void tick();
   void handShake();
 

shared/src/traintastic/simulator/simulatorconnection.cpp

@@ -23,9 +23,10 @@
 #include "simulator.hpp"
 #include "protocol.hpp"
 
-SimulatorConnection::SimulatorConnection(std::shared_ptr<Simulator> simulator, boost::asio::ip::tcp::socket&& socket)
+SimulatorConnection::SimulatorConnection(std::shared_ptr<Simulator> simulator, boost::asio::ip::tcp::socket&& socket, size_t connId)
   : m_simulator{std::move(simulator)}
   , m_socket{std::move(socket)}
+  , m_connectionId(connId)
 {
     m_socket.set_option(boost::asio::ip::tcp::no_delay(true));
     m_socket.set_option(boost::asio::socket_base::send_buffer_size(8192 * 2));
@@ -90,7 +91,7 @@ void SimulatorConnection::read()
           }
           else
           {
-            m_simulator->receive(*message);
+            m_simulator->receive(*message, m_connectionId);
           }
 
           pos += message->size;

shared/src/traintastic/simulator/simulatorconnection.hpp

@@ -41,14 +41,16 @@ class SimulatorConnection : public std::enable_shared_from_this<SimulatorConnect
   size_t m_readBufferOffset = 0;
   std::array<std::byte, 1024> m_writeBuffer;
   size_t m_writeBufferOffset = 0;
+  size_t m_connectionId = 0;
   bool m_handShakeResponseReceived = true;
 
   void read();
   void write();
   void close();
 
 public:
-  SimulatorConnection(std::shared_ptr<Simulator> simulator, boost::asio::ip::tcp::socket&& socket);
+  SimulatorConnection(std::shared_ptr<Simulator> simulator, boost::asio::ip::tcp::socket&& socket,
+                      size_t connId);
 
   void start();
   void stop();
@@ -61,6 +63,8 @@ class SimulatorConnection : public std::enable_shared_from_this<SimulatorConnect
   {
     m_handShakeResponseReceived = newHandShakeResponseReceived;
   }
+
+  inline size_t connectionId() const { return m_connectionId; }
 };
 
 #endif