callbackResponseMessage.h

Go to the documentation of this file.

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

#include "fedproMessage.h"

#include <map>

namespace rti1516_2025
{
   namespace fedpro
   {
      class CallbackResponse;
   };
};

namespace FedProSess
{
   class DT_DLL_FEDPRO DtCallbackResponseMessage : public DtFedproMessage
   {
   public:

      // Create a message from the response data
      // Allocates memory for in place construction of the message to hold its fixed and variable length data.
      // User is responsible for calling destroy to free memory 
      static DtCallbackResponseMessage* create(const rti1516_2025::fedpro::CallbackResponse& responseData = theDefaultResponse);

      // Create a message from the response data using the supplied buffer (resized if needed).
      static DtCallbackResponseMessage* create(std::vector<char>& messageBuffer,
         const rti1516_2025::fedpro::CallbackResponse& responseData = theDefaultResponse);

      // Clone the given message
      // Allocates memory for in place construction of the message to hold its fixed and variable length data.
      // User is responsible for calling destroy to free memory 
      static DtCallbackResponseMessage* clone(const DtCallbackResponseMessage* originalMessage);

      // Clone the given message using the supplied buffer (resized if needed).
      static DtCallbackResponseMessage* clone(std::vector<char>& messageBuffer, const DtCallbackResponseMessage* originalMessage);


   public:

      ~DtCallbackResponseMessage();

      DtCallbackResponseMessage* setRequestNumber(DtFedProU32 statusValue);
      DtFedProU32 requestNumber() const;

      bool getResponse(rti1516_2025::fedpro::CallbackResponse& response) const;

      void printData() const;
      const char* responseString() const;
      static const char* responseString(const rti1516_2025::fedpro::CallbackResponse& response);
      static const char* responseString(unsigned int responseType);

   protected:

      // Must use create
      DtCallbackResponseMessage(unsigned long messageSize);

      // Set the message payload data
      void setResponse(const rti1516_2025::fedpro::CallbackResponse& responseData);

      // Size of this message minus the data placeholder for variable length serialized data
      static inline unsigned fixedMessageSize() {return sizeof(DtCallbackResponseMessage) - 1;}

   protected:

      DtFedProU32 myRequestNumber;

      // Place holder for serialized data
      char myData;

      static std::map <int, const char*> theResponseStrings;
      static rti1516_2025::fedpro::CallbackResponse const& theDefaultResponse;
   };
};