forwarderObserverForAssistant.h

Go to the documentation of this file.

/****************************************************************************
 * Copyright (c) 2016 VT MAK
 * All rights reserved.
 ****************************************************************************/


#pragma once

#include "forwarderObserver.h"
#include <rtiMsConfig.h>
#include <vlutil/vlUtil.h>
#include <vlutil/vlTime.h>
#include <vlutil/vlInetAddr.h>
#include <assistantConnectionInfo.h>
#include <rtiAssistantForwarderClient.h>
#include <RIDparams.h>
#include <map>
#include <vector>
#include <list>

class DtRtiMsg;
class DtAssistantPrinter;
class DtAssistantNtfyLvlUpdateMsg;
class DtAssistantExitMsg;
class DtAssistantStateObserveMsg;
class DtAssistantRidParamsMsg;
class DtAssistantLogEnableMsg;

class DT_DLL_FORWARDER DtForwarderObserverForAssistant : public DtRtiForwarderObserver
{
public:

   struct DtForwarderObserverConnInfo
   {
      DtForwarderObserverConnInfo( const MAKRti::DtString& connName,
            const MAKRti::DtString& connType,
            const MAKRti::DtString& federationName, unsigned int connID,
            const std::pair<DtInetAddrAndPort, DtInetAddrAndPort>& connAddr, const MAKRti::DtString& connHost,
            unsigned int fedHandle = 0,
            DtHlaVersionId hlaVersion = DtHlaVersionUnknown,
            int connQueueStatus = 0 )
         : myConnName( connName )
         , myConnType( connType )
         , myConnPID( 0 )
         , myConnProcessName()
         , myConnCommandArgs()
         , myConnHost( connHost )
         , myConnID( connID )
         , myConnAddr( connAddr.first )
         , myConnAddrPrivate(connAddr.second)
         , myFedHandle( fedHandle )
         , myFederationName( federationName )
         , myConnQueueStatus( connQueueStatus )
         , myHlaVersion( hlaVersion )
      {
      }

      bool operator < ( const DtForwarderObserverConnInfo& other ) const
      {
         return ( myConnID < other.myConnID
            || ( myConnID == other.myConnID && myConnAddr < other.myConnAddr ) );
      }
      bool operator == ( const DtForwarderObserverConnInfo& other ) const
      {
         return ( myConnID == other.myConnID && myConnAddr == other.myConnAddr );
      }

      MAKRti::DtString myConnName;
      MAKRti::DtString myConnHost;
      MAKRti::DtString myConnType;
      MAKRti::DtString myConnProcessName;
      MAKRti::DtString myConnCommandArgs;
      MAKRti::DtString myFederationName;
      unsigned int myConnID;
      unsigned int myFedHandle;
      unsigned int myConnPID;
      DtInetAddrAndPort myConnAddr;
      DtInetAddrAndPort myConnAddrPrivate;
      int myConnQueueStatus;
      DtHlaVersionId myHlaVersion;

   };


   struct DtForwarderObserverDroppedConnInfo
   {
      DtForwarderObserverDroppedConnInfo( const DtString& connName, const DtString& connType,
         const DtString& federationName, unsigned int connID, const std::pair<DtInetAddrAndPort, DtInetAddrAndPort>& connAddr,
            const DtString& connHost, unsigned int federateHandle, DtHlaVersionId hlaVersion,
            DtTime startTime )
         : myInfo( connName, connType, federationName, connID, connAddr,
            connHost, federateHandle, hlaVersion, 0 )
         , myStartTime( startTime )
      {
      }

      bool operator < ( const DtForwarderObserverDroppedConnInfo& other ) const
      {
         return ( myInfo.myConnID < other.myInfo.myConnID );
      }

      DtForwarderObserverConnInfo myInfo;
      MAKRti::DtTime myStartTime;

   };

public:

   DtForwarderObserverForAssistant();

   virtual ~DtForwarderObserverForAssistant();

   virtual void initialize( DtRIDParameters* params );


   static void tick( void* usr );

   virtual void tick();


   virtual void queryForConnectionInfo( int& forwarderPort,
      MAKRti::DtInetAddr& forwarderToConnectTo );

   virtual void performParameterOverrides( DtRIDParameters& ridParams ) const;

   virtual void setForwarderInfo( int forwarderPort,
      const MAKRti::DtInetAddr& forwarderToConnectTo );

   virtual void enableNotifications();

   virtual void disableNotifications();


   static void processForwarderObserveMsg( const DtAssistantStateObserveMsg& msg, void* usr );
   virtual void processForwarderObserveMsg( const DtAssistantStateObserveMsg& msg );

   static void processExitCmndMsg( const DtAssistantExitMsg& msg, void* usr );
   virtual void processExitCmndMsg( const DtAssistantExitMsg& msg );

   static void processRidParamRequest( const DtAssistantRidParamsMsg& msg, void* usr );
   virtual void processRidParamRequest( const DtAssistantRidParamsMsg& msg );

   static void processEnableLoggingMsg( const DtAssistantLogEnableMsg& msg, void* usr );
   virtual void processEnableLoggingMsg( const DtAssistantLogEnableMsg& msg );

   static void processNotifyLevelChangeMsg( const DtAssistantNtfyLvlUpdateMsg& msg, void* usr );
   virtual void processNotifyLevelChangeMsg( const DtAssistantNtfyLvlUpdateMsg& msg );

   static void processAssistantDisconnect( void* usr );
   virtual void processAssistantDisconnect();


   virtual void processLogFileUpdatedEvent( const MAKRti::DtFilename& logFile );

   virtual int clientToForwarderConnectionEstablished(
      const MAKRti::DtString& connName, const MAKRti::DtString& hostName,
      const MAKRti::DtString& connType, unsigned int connID, const DtInetAddrAndPort& connAddr);

   virtual int clientToForwarderConnectionLost(
      const MAKRti::DtString& connName, const MAKRti::DtString& hostName,
      unsigned int connID, const DtInetAddrAndPort& connAddr);

   virtual void clientToForwarderFederateJoined(
      const DtString& connName, const DtString& connType,
      const DtString& federationName, unsigned int connID,
      unsigned int fedHandle, const DtInetAddrAndPort& connAddr,
      const MAKRti::DtString& connHost, unsigned int processId,
      const MAKRti::DtString& processName, const MAKRti::DtString& commandArgs,
      DtHlaVersionId hlaVersion );

   virtual void clientToForwarderFederateLost(
      const MAKRti::DtString& connName, const MAKRti::DtString& connType,
      unsigned int connID, unsigned int fedHandle,
      const DtInetAddrAndPort& connAddr );

   virtual int forwarderToForwarderExecConnected(
      const MAKRti::DtString& connName, unsigned int connID,
      const DtInetAddrAndPort& connAddr, const MAKRti::DtString& hostName,
      bool fullyCompliant );

   virtual int forwarderToForwarderExecLost(
      const MAKRti::DtString& connName, unsigned int connID,
      const DtInetAddrAndPort& connAddr );

   virtual int clientToForwarderExecConnected(
      const MAKRti::DtString& connName, unsigned int connID,
      const DtInetAddrAndPort& connAddr, const MAKRti::DtString& connHost,
      bool fullyCompliant );

   virtual int clientToForwarderExecLost(
      const MAKRti::DtString& connName, unsigned int connID,
      const DtInetAddrAndPort& connAddr );

   virtual void forwarderToForwarderConnectionEstablished(
      const MAKRti::DtString& connName, const MAKRti::DtString& hostName,
      unsigned int connID, const std::pair<DtInetAddrAndPort, DtInetAddrAndPort>& connAddr);

   virtual void forwarderToForwarderConnectionLost(
      const MAKRti::DtString& connName, const MAKRti::DtString& hostName,
      unsigned int connID, const std::pair<DtInetAddrAndPort, DtInetAddrAndPort>& connAddr);

   virtual void forwarderToForwarderConnectionChanged(
      const MAKRti::DtString& connName, const MAKRti::DtString& hostName,
      unsigned int oldConnID, unsigned int newConnID, const DtInetAddrAndPort& connAddr );

   virtual int clientToForwarderSocketQueueUpdate(
      unsigned int connId, int connQueueStatus );

   virtual void waitingForFowrarderConnections(
      const DtForwarderPort::DtConnAndNameMap& allNeededFws,
      const DtForwarderPort::DtConnAndNameMap& stillNeededFws );

   virtual void notWaitingForFowrarderConnections();

   bool gotConnInfoFromAssistant();

   std::shared_ptr<DtRtiAssistantForwarderClient> assistantClient() { return myAssistantClient; }

   virtual void sendTrayNotification( const MAKRti::DtString& text, DtNotifyLevelType notifyLevel );

   inline const DtRIDParameters* ridParams() const { return myParams; }
   inline DtRIDParameters* ridParams() { return myParams; }

protected:

   virtual void addCallbacks();

   virtual void removeCallbacks();

   virtual void sendForwarderInfoToAssistant() const;

   virtual void sendWaitingForForwardersToAssistant() const;

protected:

   std::shared_ptr<DtRtiAssistantForwarderClient> myAssistantClient;

   DtAssistantPrinter* myAssistantPrinter;

   bool myForwarderIsObserved;

   DtRIDParameters* myParams;

   MAKRti::DtInetAddr myHostAddr;

   bool myGotConnInfoFromAssistant;

   std::set<DtForwarderObserverConnInfo> myConnectedNotJoinedClientConns;
   std::set<DtForwarderObserverConnInfo> myClientForwarderConns;
   std::set<DtForwarderObserverConnInfo> myForwarderForwarderConns;
   std::set<DtForwarderObserverDroppedConnInfo> myUnexpectedlyDroppedClientConns;

   DtNeededFwConnMap myNeededFws;

   bool myIsWaitingForFws;

   MAKRti::DtClock myClock;
   float myDefunctRemovalTime;

   DtForwarderObserverConnInfo* myExecConnection;
   bool myExecIsLocal;


   int myForwarderPort;
   MAKRti::DtInetAddr myForwarderToConnectTo;

   std::shared_ptr<DtFilePrinter> myLogPrinter;

};


inline bool DtForwarderObserverForAssistant::gotConnInfoFromAssistant()
{
   return myGotConnInfoFromAssistant;
}

void DtForwarderObserverForAssistant::sendTrayNotification( const MAKRti::DtString& text, DtNotifyLevelType notifyLevel )
{
   myAssistantClient->sendNotifyMsg( text, notifyLevel );
}