rfxSystemMessage.h

Go to the documentation of this file.

// ******************************************************************************
// ** Copyright (c) 2025 MAK Technologies
// ** All rights reserved.
// ******************************************************************************
 
//! \file rfxSystemMessage.h
//! \brief Defines system-level messages for the RadarFX client-server communication
//! \ingroup vreRadarFxShared
//!
//! This file contains system-level message classes used for connection management
//! and server status monitoring, such as heartbeat messages to verify connectivity.
 
#pragma once
 
#include "export.h"
#include "rfxMessage.h"
 
#include <matrix/vlVector.h>
 
#include <string>
 
namespace makRadarFx
{
//! \brief Heartbeat message for connection monitoring
//!
//! This message is sent periodically between the client and server to ensure that
//! the connection is still active. It contains no payload data and serves only
//! as a keepalive mechanism. Both the client and server can send heartbeat messages,
//! and both should respond to received heartbeat messages to confirm connectivity.
class RFX_DLL_SHARED DtHeartbeatMessage : public DtBaseMessage
{
public:
   //! \brief Default constructor
   //!
   //! Initializes a new heartbeat message with the appropriate message type
   DtHeartbeatMessage();
 
   //! \brief Virtual destructor
   //!
   //! Cleans up any resources associated with the heartbeat message
   virtual ~DtHeartbeatMessage();
 
   //! \brief Gets the size of the encoded message in bytes
   //! \return Size of the message in bytes when encoded
   //!
   //! Heartbeat messages have minimal size since they contain no payload data
   virtual int messageSize();
 
   //! \brief Decodes a byte array into a message object
   //! \param buffer Pointer to the encoded byte array
   //! \param length Length of the encoded byte array
   //! \return Pointer to the newly created message object
   //!
   //! Static decoder function used by the message factory to create message
   //! objects from encoded data.
   static DtBaseMessage* decode(unsigned char* buffer, int length);
 
   //! \brief Creates a deep copy of this message
   //! \return Pointer to a new instance that is a copy of this message
   //!
   //! Creates a new message instance that is an exact copy of this message.
   //! The caller is responsible for managing the memory of the returned object.
   virtual DtBaseMessage* clone();
 
protected:
   //! \brief Serializes the message data to a stream writer
   //! \param writer Reference to the stream writer to write the data to
   //!
   //! Writes the message data to the provided stream writer. For heartbeat
   //! messages, this only writes the base message fields as there is no
   //! additional payload data.
   virtual void serialize(DtStreamWriter& writer);
 
   //! \brief Deserializes message data from a stream reader
   //! \param reader Reference to the stream reader to read the data from
   //!
   //! Reads the message data from the provided stream reader. For heartbeat
   //! messages, this only reads the base message fields as there is no
   //! additional payload data.
   virtual void deserialize(DtStreamReader& reader);
};
} // namespace makRadarFx