fedproMessage.h

Go to the documentation of this file.

/*********************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
*********************************************************************/
#pragma once


#include <rtiutil/rtiMsConfig.h>

#include "fedproNetDatatypes.h"

#define FEDPRO_VERSION 1

namespace FedProSess
{
   class DT_DLL_FEDPRO DtFedproMessage
   {
   public:

      enum MessageType
      {
         UNKNOWN = 0,

         // Session Management
         CTRL_NEW_SESSION = 1,
         CTRL_NEW_SESSION_STATUS = 2,
         CTRL_HEARTBEAT = 3,
         CTRL_HEARTBEAT_RESPONSE = 4,
         CTRL_TERMINATE_SESSION = 5,
         CTRL_SESSION_TERMINATED = 6,

         // Reconnection
         CTRL_RESUME_REQUEST = 10,
         CTRL_RESUME_STATUS = 11,

         // HLA Calls and Callbacks
         HLA_CALL_REQUEST = 20,
         HLA_CALL_RESPONSE = 21,
         HLA_CALLBACK_REQUEST = 22,
         HLA_CALLBACK_RESPONSE = 23,

         INVALID = 99
      };

   public:

      DtFedproMessage(MessageType messageType, unsigned long messageSize);
      ~DtFedproMessage();

      DtFedProU32 size() const;
      DtFedproMessage* setSize(DtFedProU32 val);
      DtFedProU32 sequenceNumber() const;
      DtFedproMessage* setSequenceNumber(DtFedProU32 val);
      DtFedProU64 sessionId() const;
      DtFedproMessage* setSessionId(DtFedProU64 val);
      DtFedProU32 lastReceivedMessage() const;
      DtFedproMessage* setLastReceivedMessage(DtFedProU32 val);
      // No setter - type must be known when constructed
      MessageType type() const;
      const char* messageTypeString() const;

      void printHeader() const;
      void print() const;

   public:

      static DtFedProU32 size(char* buffer);
      static MessageType type(char* buffer);
      static const char* messageTypeString(char* buffer);
      static const char* messageTypeString(MessageType typeValue);
      static void printData(const DtFedproMessage* message);

      // Release memory allocated for in place message
      static void destroy(DtFedproMessage* message);

      // The federate protocol "string" data is UTF8 in some cases converted from UTF16
      // These functions convert between the two formats
      static std::string wstringToString(const std::wstring& wstr);
      static std::wstring stringToWstring(const std::string& str);

   protected:

      DtFedproMessage* setType(MessageType val) { myType = val; return this; }

   protected:

      DtFedProU32 mySize;
      DtFedProU32 mySequenceNumber;
      DtFedProU64 mySessionId;
      DtFedProU32 myLastReceivedMessage;
      DtFedProU32 myType;
   };
}