FederateProxy.h

Go to the documentation of this file.

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

#pragma once

#include <rtiutil/rtiMsConfig.h>

#include <fedPro/sessionTerminatedMessage.h>
#include <fedPro/heartbeatResponseMessage.h>

#include <rtiutil/internalTypes.h>

#include <vlutil/vlTime.h>

#include <RTI/RTI1516.h>

namespace rti1516_2025
{
   class RTIambassadorFactory;
   class RTIambassador;
   namespace fedpro
   {
      class CallRequest;
      class CallResponse;
      class FomModule;
      class FomModuleSet;
   };
};

namespace FedProSess
{
   class DtCallRequestMessage;
   class DtCallResponseMessage;
};

class DtTcpMsgSocket;
class FederateAmbassadorProxy;

class DT_DLL_FEDPRO_SERVER FederateProxy
{
public:

   enum Status
   {
      Normal = 0,
      Terminated = 1,
      Disconnected = 2,
      InternalError = 99
   };

   static FederateProxy* create(DtTcpMsgSocket* msgSocket, unsigned long long sessionId);

public:

   FederateProxy(DtTcpMsgSocket* msgSocket, unsigned long long sessionId);

   virtual ~FederateProxy();

   bool initialize();

   Status status() const;

   MAKRti::DtClock const& clock() const { return myClock; }

   unsigned long long sessionId() const { return mySessionId; }

   bool isConnected() const;
   void setDisconnected();
   void reconnect(DtTcpMsgSocket* msgSocket, unsigned long lastReceived);
   void reconnectFailed(DtTcpMsgSocket* msgSocket);

   bool isJoined() const;
   void resignReset();

   void terminate(FedProSess::DtSessionTerminatedMessage::SessionStatus status);

   int readAndProcess();

   int sendMessage(FedProSess::DtFedproMessage& message);
   int sendMessage(FedProSess::DtFedproMessage* message);
   int resendMessage(FedProSess::DtFedproMessage* message);

   unsigned long lastRecievedMessage() const { return myLastReceivedMessageNumber; }
   unsigned long oldestSentMessage() const { return myMessageBuffer.size() > 0 ? myMessageBuffer.begin()->first : 0; }

   char* enumAsString(Status status) const;

   void print();

   DtTcpMsgSocket* socket() { return mySocket; }

   rti1516_2025::RTIambassador* rtiAmb();

protected:

   typedef void (FederateProxy::*CallRequestFunction)(const rti1516_2025::fedpro::CallRequest& request,
      unsigned long sequenceNumber, rti1516_2025::fedpro::CallResponse& response);
   void processMessage(FedProSess::DtFedproMessage* message);
   void processCallRequest(FedProSess::DtCallRequestMessage* message);
   void processCallbackResponse(FedProSess::DtCallResponseMessage* message);


   void handleMalformedRequest(rti1516_2025::fedpro::CallResponse& response, rti1516_2025::fedpro::CallRequest const& request,
      char const* serviceCall);
   void handleUnrecognizedRequest(rti1516_2025::fedpro::CallResponse& response, rti1516_2025::fedpro::CallRequest const& request,
      char const* serviceCall);
   void handleUnknownException(rti1516_2025::fedpro::CallResponse& response, char const* serviceCall);
   void handleException(rti1516_2025::Exception const& ex, rti1516_2025::fedpro::CallResponse& response);
   void sendResponse(unsigned long sequenceNumber, const rti1516_2025::fedpro::CallResponse& response);


   void connect(const rti1516_2025::fedpro::CallRequest& request, unsigned long sequenceNumber,
      rti1516_2025::fedpro::CallResponse& response);
   void connectWithCredentialsRequest(const rti1516_2025::fedpro::CallRequest& request, unsigned long sequenceNumber,
      rti1516_2025::fedpro::CallResponse& response);
   void connectWithConfigurationRequest(const rti1516_2025::fedpro::CallRequest& request, unsigned long sequenceNumber,
      rti1516_2025::fedpro::CallResponse& response);
   void connectWithConfigurationAndCredentialsRequest(const rti1516_2025::fedpro::CallRequest& request,
      unsigned long sequenceNumber, rti1516_2025::fedpro::CallResponse& response);

   void disconnect(const rti1516_2025::fedpro::CallRequest& request, unsigned long sequenceNumber,
      rti1516_2025::fedpro::CallResponse& response);

   void listFederationExecutions(const rti1516_2025::fedpro::CallRequest& request, unsigned long sequenceNumber,
      rti1516_2025::fedpro::CallResponse& response);
   void listFederationExecutionMembers(const rti1516_2025::fedpro::CallRequest& request, unsigned long sequenceNumber,
      rti1516_2025::fedpro::CallResponse& response);


   void createFederationExecution(const rti1516_2025::fedpro::CallRequest& request, unsigned long sequenceNumber,
      rti1516_2025::fedpro::CallResponse& response);
   void createFederationExecutionWithTimeRequest(const rti1516_2025::fedpro::CallRequest& request, unsigned long sequenceNumber,
      rti1516_2025::fedpro::CallResponse& response);
   void createFederationExecutionWithModulesRequest(const rti1516_2025::fedpro::CallRequest& request,
      unsigned long sequenceNumber, rti1516_2025::fedpro::CallResponse& response);
   void createFederationExecutionWithModulesAndTimeRequest(const rti1516_2025::fedpro::CallRequest& request,
      unsigned long sequenceNumber, rti1516_2025::fedpro::CallResponse& response);
   void createFederationExecutionWithMIMRequest(const rti1516_2025::fedpro::CallRequest& request, unsigned long sequenceNumber,
      rti1516_2025::fedpro::CallResponse& response);
   void createFederationExecutionWithMIMAndTimeRequest(const rti1516_2025::fedpro::CallRequest& request,
      unsigned long sequenceNumber, rti1516_2025::fedpro::CallResponse& response);

   void destroyFederationExecution(const rti1516_2025::fedpro::CallRequest& request, unsigned long sequenceNumber,
      rti1516_2025::fedpro::CallResponse& response);

   void joinFederationExecution(const rti1516_2025::fedpro::CallRequest& request, unsigned long sequenceNumber,
      rti1516_2025::fedpro::CallResponse& response);

   void resignFederationExecution(const rti1516_2025::fedpro::CallRequest& request, unsigned long sequenceNumber,
      rti1516_2025::fedpro::CallResponse& response);

   void getObjectClassHandle(const rti1516_2025::fedpro::CallRequest& request, unsigned long sequenceNumber,
      rti1516_2025::fedpro::CallResponse& response);

   void getAttributeHandle(const rti1516_2025::fedpro::CallRequest& request, unsigned long sequenceNumber,
      rti1516_2025::fedpro::CallResponse& response);

   void publishObjectClassAttributes(const rti1516_2025::fedpro::CallRequest& request, unsigned long sequenceNumber,
      rti1516_2025::fedpro::CallResponse& response);

   void subscribeObjectClassAttributes(const rti1516_2025::fedpro::CallRequest& request, unsigned long sequenceNumber,
      rti1516_2025::fedpro::CallResponse& response);

   void reserveObjectName(const rti1516_2025::fedpro::CallRequest& request, unsigned long sequenceNumber,
      rti1516_2025::fedpro::CallResponse& response);

   void registerObjectInstanceWithName(const rti1516_2025::fedpro::CallRequest& request, unsigned long sequenceNumber,
      rti1516_2025::fedpro::CallResponse& response);

   void updateAttributeValues(const rti1516_2025::fedpro::CallRequest& request, unsigned long sequenceNumber,
      rti1516_2025::fedpro::CallResponse& response);

   void deleteObjectInstance(const rti1516_2025::fedpro::CallRequest& request, unsigned long sequenceNumber,
      rti1516_2025::fedpro::CallResponse& response);

   void getInteractionClassHandle(const rti1516_2025::fedpro::CallRequest& request, unsigned long sequenceNumber,
      rti1516_2025::fedpro::CallResponse& response);

   void getParameterHandle(const rti1516_2025::fedpro::CallRequest& request, unsigned long sequenceNumber,
      rti1516_2025::fedpro::CallResponse& response);

   void publishInteractionClass(const rti1516_2025::fedpro::CallRequest& request, unsigned long sequenceNumber,
      rti1516_2025::fedpro::CallResponse& response);

   void subscribeInteractionClass(const rti1516_2025::fedpro::CallRequest& request, unsigned long sequenceNumber,
      rti1516_2025::fedpro::CallResponse& response);

   void sendInteraction(const rti1516_2025::fedpro::CallRequest& request, unsigned long sequenceNumber,
      rti1516_2025::fedpro::CallResponse& response);

   void bufferMessage(FedProSess::DtFedproMessage* message);
   void clearBuffer(unsigned long lastReceived);

   bool convertFomModule(rti1516_2025::fedpro::FomModule const& inMod, std::wstring& outMod) const;
   void convertFomModules(rti1516_2025::fedpro::FomModuleSet const& inMods, std::vector<std::wstring>& outMods) const;

   virtual rti1516_2025::FederateHandle decodeFederateHandle(rti1516_2025::VariableLengthData const& encodedValue) const;
   virtual rti1516_2025::ObjectClassHandle decodeObjectClassHandle(rti1516_2025::VariableLengthData const& encodedValue) const;
   virtual rti1516_2025::InteractionClassHandle decodeInteractionClassHandle(
      rti1516_2025::VariableLengthData const& encodedValue) const;
   virtual rti1516_2025::ObjectInstanceHandle decodeObjectInstanceHandle(
      rti1516_2025::VariableLengthData const& encodedValue) const;
   virtual rti1516_2025::AttributeHandle decodeAttributeHandle(rti1516_2025::VariableLengthData const& encodedValue) const;
   virtual rti1516_2025::ParameterHandle decodeParameterHandle(rti1516_2025::VariableLengthData const& encodedValue) const;
   virtual rti1516_2025::DimensionHandle decodeDimensionHandle(rti1516_2025::VariableLengthData const& encodedValue) const;
   virtual rti1516_2025::MessageRetractionHandle decodeMessageRetractionHandle(
      rti1516_2025::VariableLengthData const& encodedValue) const;
   virtual rti1516_2025::RegionHandle decodeRegionHandle(rti1516_2025::VariableLengthData const& encodedValue) const;

protected:

   DtUniquePtr<rti1516_2025::RTIambassador> myRtiAmbassador;
   DtUniquePtr<FederateAmbassadorProxy> myFederateAmbassador;
   std::map<int, CallRequestFunction> myCallRequestFunctions;
   std::map<unsigned long, FedProSess::DtFedproMessage*> myMessageBuffer;
   DtTcpMsgSocket* mySocket;
   MAKRti::DtClock myClock;
   unsigned long long mySessionId;
   unsigned long mySequenceNumber;
   unsigned long myLastReceivedMessageNumber;
   Status myStatus;
   bool myIsRtiConnected;
   rti1516_2025::FederateHandle myFederateHandle;
   std::string myJoinedFederation;
   std::string myFederateType;
   std::string myFederateName;
   FedProSess::DtHeartbeatResponseMessage myHeartbeatResponseMessage;
   rti1516_2025::VariableLengthData myVarData;
   std::vector<char> myDataBuff;
   DtUniquePtr<rti1516_2025::LogicalTimeFactory> myTimeFactory;

public:
   rti1516_2025::RTIambassadorFactory theRtiAmbFactory;
};