connectionsCache.h

Go to the documentation of this file.

/*********************************************************************
** Copyright (c) 2008 MaK Technologies, Inc.
** All rights reserved.
*********************************************************************/
/*******************************************************************************
** $RCSfile: connectionsCache.h,v $ $Revision: 1.18 $ $State: Exp $
*******************************************************************************/


#ifndef DtConnectionCache_H_
#define DtConnectionCache_H_

#include <mtl/environment.h>
#include <mtl/envXmlWriter.h>
#include <vlutil/vlString.h>
#include <vlutil/vlFilename.h>
#include <iosfwd>

#include "assistantConnectionInfo.h"
#include "assistantConnectionConfigurationInfo.h"
#include "connectionAndConfiguration.h"

struct DtAssistantConnectionStruct;

class DT_DLL_ASSISTANTAPP DtConnectionCache
{
public:

   DtConnectionCache( const MAKRti::DtFilename& xmlFile );

   virtual ~DtConnectionCache();

   virtual bool writeToFile();

   virtual bool writeToFile( const MAKRti::DtFilename& xmlFile );

   virtual std::ostream& print( std::ostream& ostr ) const;

   virtual void getConnections( DtRtiConnectionAndConfiguration& connsAndConfigs );

   virtual bool setConnections( const DtRtiConnectionAndConfiguration& conns );

   virtual void clearConnections();

   virtual bool fileWasRead() const;

   virtual bool getFileVersion( MAKRti::DtString& version ) const;

   virtual bool isCacheVersionOld() const;

   virtual DtNetU128 rawUuid() const;

private:

   DtConnectionCache( const DtConnectionCache& );
   DtConnectionCache& operator=( const DtConnectionCache& );

protected:

   virtual void getRtiexecConnectionsFromEnv( DtRtiConnectionAndConfiguration& connsAndConfigs );

   virtual void getLightweightConnectionsFromEnv( DtRtiConnectionAndConfiguration& connsAndConfigs );

   virtual void getConfigurationsFromEnv( DtRtiConnectionAndConfiguration& connsAndConfigs );

   virtual void getForeignConnectionsFromEnv( DtRtiConnectionAndConfiguration& connsAndConfigs );

   virtual MAKRti::DtEnvValueSP addConnectionToEnv( const DtRtiConnectionInfoDataPair& conn );

   virtual MAKRti::DtEnvValueSP addConfigurationToEnv( const DtRtiConfigurationInfoDataPair& config );

   virtual MAKRti::DtEnvValueSP addForeignConnectionToEnv(const DtAssistantConnectionStruct& foreignConnection);

   virtual void removeConnectionFromEnv( const DtRtiConnectionInfoDataPair& conn  );

   virtual void removeConfigurationFromEnv( const DtRtiConfigurationInfoDataPair& config );

   virtual void removeForeignConnectionsFromEnv( const DtHostNameAddress& foreignConnection );

   void setConnFromEnv( DtRtiConnectionInfoDataPair& conn, 
      MAKRti::DtEnvValueSP val );

   void setConfigFromEnv( DtRtiConfigurationInfoDataPair& config,
      MAKRti::DtEnvValueSP val );

   bool parseFile( const MAKRti::DtFilename& filename );

protected:

   MAKRti::DtEnvironment myEnvironment;

   DtUniquePtr< MAKRti::DtEnvXMLWriter > myXmlWriter;

   MAKRti::DtFilename myXmlFile;

   MAKRti::DtString myReadFileVersion;

   MAKRti::DtString myUuid;
   
   bool myFileWasRead;



   static MAKRti::DtString thePredefinedLightweightConnName;

   static DtRtiConnectionInfo thePredefinedLightweightConn;

   static MAKRti::DtString thePredefinedLightweightConfigName;

   static DtRtiConnectionConfigurationInfo thePredefinedLightweightConfig;


   static MAKRti::DtString thePredefinedRtiexecConnName;

   static DtRtiConnectionInfo thePredefinedRtiexecConn;

   static MAKRti::DtString thePredefinedRtiexecConfigName;

   static DtRtiConnectionConfigurationInfo thePredefinedRtiexecConfig;


   static MAKRti::DtString thePredefinedLightweightLoopbackConnName;

   static DtRtiConnectionInfo thePredefinedLightweightLoopbackConn;

   static MAKRti::DtString thePredefinedLightweightLoopbackConfigName;

   static DtRtiConnectionConfigurationInfo thePredefinedLightweightLoopbackConfig;


   static MAKRti::DtString thePredefinedRtiexecLoopbackConnName;

   static DtRtiConnectionInfo thePredefinedRtiexecLoopbackConn;

   static MAKRti::DtString thePredefinedRtiexecLoopbackConfigName;

   static DtRtiConnectionConfigurationInfo thePredefinedRtiexecLoopbackConfig;

};

inline std::ostream& operator<<( std::ostream& ostr, const DtConnectionCache& cache )
{
   return cache.print( ostr );
}

#endif // DtConnectionCache_H_