connInfoMgr.h

Go to the documentation of this file.

/*********************************************************************
** Copyright (c) 2009 MaK Technologies, Inc.
** All rights reserved.
*********************************************************************/
/*********************************************************************
** $RCSfile: connInfoMgr.h,v $ $Revision: 1.19 $ $State: Exp $
*********************************************************************/

#ifndef connInfoMgr_H_
#define connInfoMgr_H_


#include "rtiMsConfig.h"
#include "assistantMgr.h"
#include "assistantLicServerInfo.h"
#include "assistantMsgQueue.h"
#include "connectionsCache.h"
#include "rtiAssistantClient.h"
#include "connectionAndConfiguration.h"

class DtRtiAssistantServer;
class DtRtiAssistantPeer;
class DtAssistantComponentMgr;
class DtAssistantPreferencesInfoMgr;
class DtAssistantQueryMsg;
class DtAssistantLightweightInfoMsg;
class DtAssistantInfoMsg;
class DtAssistantRemovalMsg;
class DtAssistantStartRtiexecMsg;

class DT_DLL_ASSISTANTAPP DtAssistantConnectionInfoMgr : public DtAssistantMgr
{
   Q_OBJECT

public:

   DtAssistantConnectionInfoMgr( DtBoost::shared_ptr<DtRtiAssistantServer> server,
      DtBoost::shared_ptr<DtRtiAssistantPeer> peer,
      DtBoost::shared_ptr<DtAssistantPreferencesInfoMgr> prefMgr,
      DtBoost::shared_ptr<DtAssistantComponentMgr> compMgr,
      const MAKRti::DtFilename& configDir,
      const MAKRti::DtString& logFileName);

   virtual ~DtAssistantConnectionInfoMgr();

private:

   DtAssistantConnectionInfoMgr(DtAssistantConnectionInfoMgr const& );

   DtAssistantConnectionInfoMgr& operator= (DtAssistantConnectionInfoMgr const& );

public:

   virtual void tick();

   virtual void startShutdown();

   virtual bool isCacheFileVersionOld() const;

   virtual unsigned int lightweightMemoryPeriod() const;

   virtual unsigned int lightweightHeartbeatInterval() const;

   virtual unsigned int assistantMemoryPeriod() const;

   virtual unsigned int assistantHeartbeatInterval() const;

   virtual unsigned int requestedAssistantHeartbeatInterval() const;

   virtual bool acceptRemoteCommands() const;

   virtual bool remoteAssistantAcceptsCommands( const DtAssistantInfo& assistant ) const;

   virtual bool hostHasARemoteAssistantThatAcceptsCommands(
      const DtHostNameAddress& host, const MAKRti::DtInetAddr& interfaceAddr ) const;

   virtual int localRtiexecCompId( const DtRtiConnectionInfo& conn ) const;

   //1 or returns -1 if not found.
   virtual int localRtiForwarderCompId( const DtRtiConnectionInfo& conn ) const;

   virtual bool getRemoteRtiexecLocation( const DtRtiConnectionInfo& conn, 
      DtAssistantInfo& assistant, int& id ) const;

   virtual bool getRemoteRtiForwarderLocation( const DtRtiConnectionInfo& conn, 
      DtAssistantInfo& assistant, int& id ) const;

   virtual bool getRemoteRtiexecConnInfo( const DtAssistantInfo& assistant,
      int id, DtRtiConnectionInfoDataPair& conn ) const;

   virtual bool getRemoteForwarderConnInfo( const DtAssistantInfo& assistant,
      int id, DtRtiConnectionInfoDataPair& conn ) const;

   virtual bool getChosenConnectionAndConfiguration( DtRtiConnectionInfoDataPair& conn,
      DtRtiConfigurationInfoDataPair& config );

   virtual bool getConnectionInfo( DtRtiConnectionInfoDataPair& conn );

   virtual bool getConfigurationForConn( const DtRtiConnectionInfo& conn,
      DtRtiConfigurationInfoDataPair& config );

   virtual MAKRti::DtString connectionName( const DtRtiConnectionInfo& conn );
   
   virtual bool isStillDefaultChosen() const;

   virtual const DtRtiConnectionAndConfiguration& connectionsAndConfigurations();

   virtual void addUserDefinedConnections( const DtRtiConnectionAndConfiguration& conns );

   virtual void removeUserDeletedConnections( const DtRtiConnectionAndConfiguration& conns );

   virtual void removeAllLocalRtiexecsForwarders();

   virtual void removeAllLocalLightweightConns();

   virtual bool isConnConflicting( const DtRtiConnectionInfo& conn,
      MAKRti::DtString& reason ) const;

   void saveConnections();

protected:



   static void processQueryMsg(const DtAssistantQueryMsg& queryMsg, void* usr);
   virtual void processQueryMsg(const DtAssistantQueryMsg& queryMsg);

   static void processInfoMsg(const DtAssistantInfoMsg& infoMsg, void* usr);
   virtual void processInfoMsg(const DtAssistantInfoMsg& infoMsg);

   static void processLightweightInfoMsg(const DtAssistantLightweightInfoMsg& infoMsg, void* usr);
   virtual void processLightweightInfoMsg(const DtAssistantLightweightInfoMsg& infoMsg);

   static void processRemovalMsg(const DtAssistantRemovalMsg& remMsg, void* usr);
   virtual void processRemovalMsg(const DtAssistantRemovalMsg& remMsg);

   static void processStartRtiexecMsg( const DtAssistantStartRtiexecMsg& msg, void* usr);
   virtual void processStartRtiexecMsg( const DtAssistantStartRtiexecMsg& msg );


   static void processInterfaceFound( void* usr );

   virtual void processInterfaceFound();

   struct DtAssistantState
   {
      DtAssistantState() : heartbeated( true ), lightweightInactivePeriod(120),
         assistantInactivePeriod(10), acceptsRemoteCommands(true) {}
      bool heartbeated;
      unsigned int lightweightInactivePeriod;
      unsigned int assistantInactivePeriod;
      bool acceptsRemoteCommands;
      std::map<int, DtRtiConnectionInfo> rtiexecs;
      std::map<int, DtRtiConnectionInfo> forwarders;
   };
   typedef std::map< DtAssistantInfo, DtAssistantState > DtAssistantStateMap;
   typedef std::pair< DtAssistantInfo, DtAssistantState > DtAssistantStatePair;


signals:

   void heartbeat();

   void prune();

   void connectionsAddedOrUpdated( const DtRtiConnectionAndConfiguration& conns );

   void connectionsAboutToBeRemoved( const DtRtiConnectionAndConfiguration& conns );

   void connectionsRemoved( const DtRtiConnectionAndConfiguration& conns );

   void assistantFound( const DtAssistantInfo& info );

   void assistantLost( const DtAssistantInfo& info );

   void rtiexecStartupRequested( const DtRtiConnectionInfoDataPair&,
      const DtRtiConnectionConfigurationInfo&, bool );

public slots:

   void processLocalRtiComponentConnected( int compId );

   void processLocalRtiComponentNotConnected( int compId );

   void processLocalForwarderHasRtiexec( int compId );

   void processLocalForwarderHasNoRtiexec( int compId );

   void processNewChosenConnection( const DtRtiConnectionInfo& conn,
      const DtRtiConnectionConfigurationInfo& config );

   void processClearChosenConnection();

   void setLightweightMemory( unsigned int newVal );

   void setAssistantUpdateInterval( unsigned int newVal );

   void setAcceptRemoteCommands( bool newVal );

protected:

   virtual void heartbeatAssistant();

   virtual void heartbeatLightweightConnections();

   virtual void pruneStaleLightweightConns();

   virtual void pruneStaleAssistantsExecsFwrdrs();

   virtual void determineHeartbeatIntervals();

   virtual DtAssistantStateMap::iterator findOrAddRemoteAssistant( const DtAssistantInfo& assistant );

   virtual void unverifyRtiexecsForwardersForAssistant( DtAssistantStateMap::iterator astntIter, 
      DtRtiConnectionAndConfiguration& connsToRemove,
      DtRtiConnectionAndConfiguration& updatedConns );

   virtual void unverifyListedRtiexecsForwardersForAssistant(
      const DtRtiConnectionAndConfiguration& removeList, 
      DtAssistantStateMap::iterator astntIter,
      DtRtiConnectionAndConfiguration& connsToRemove, 
      DtRtiConnectionAndConfiguration& updatedConns );

   virtual void addListedRtiexecsForwardersForAssistant(
      const DtRtiConnectionAndConfiguration& addList, 
      DtAssistantStateMap::iterator astntIter,
      DtRtiConnectionAndConfiguration& connsToRemove,
      DtRtiConnectionAndConfiguration& updatedConns );

   virtual void checkForConflictingConns(
      DtRtiConnectionAndConfiguration& updatedConns );

   virtual void removeConnections(
      const DtRtiConnectionAndConfiguration& connsToRemove );

   virtual void setInterfaceForPredefinedConns( const MAKRti::DtInetAddr& interfaceAddr );

protected:

   DtBoost::shared_ptr<DtConnectionCache> myConnectionCache;

   DtBoost::shared_ptr<DtAssistantComponentMgr> myCompMgr;

   DtBoost::shared_ptr<DtAssistantPreferencesInfoMgr> myPrefMgr;

   bool myAcceptRemoteCmds;

   DtClock myClock;

   DtTime myNextAssistantHeartbeatTime;

   DtTime myNextLightweightHeartbeatTime;

   DtTime myNextAssistantInfoRemovalTime;

   DtTime myNextLightweightRemovalTime;

   unsigned int myAssistantHeartbeatInterval;

   unsigned int myLightweightHeartbeatInterval;

   unsigned int myAssistantInfoRemovalPeriod;

   unsigned int myLightweightRemovalPeriod;

   MAKRti::DtString myHostName;

   DtRtiConnectionAndConfiguration myRemovedLocalExecsAndFwrdrs;

   DtAssistantStateMap myRemoteAssistantStates;

   DtRtiConnectionAndConfiguration myConnsAndConfigs;

   bool myStillDefaultChosen;

   bool myPredefinedConnsNeedInterface;

   MAKRti::DtInetAddr myPotentialPredefinedConnsInterface;

   DtTime mySetPredefinedConnsInterfaceTime;

   MAKRti::DtString myLogFileName;
};

#endif