webSpyUtils.h

Go to the documentation of this file.

/*********************************************************************
 ** Copyright (c) 2005 MaK Technologies, Inc.
 ** All rights reserved.
 *********************************************************************/
/*******************************************************************************
 ** $RCSfile: webSpyUtils.h,v $ $Revision: 1.20 $ $State: Exp $
 *******************************************************************************/

#ifndef DtWebSpyUtils_H_
#define DtWebSpyUtils_H_

#include <rtiMsConfig.h>
#include <RIDparams.h>
#include <vlutil/vlTime.h>
#include <vlutil/vlString.h>
#include <vlutil/vlFilename.h>
#include <vector>
#include <map>
class DT_DLL_WWW DtWebSpyUtils
{
public: 
   enum WwwControlMsgCommandId
   {
      DtTypeInfoCntlMsg,
      DtRequestStateUpdateMsg,
      DtLrcLogEventsMsg,
      DtDeleteFederateCmdMsg,
      DtDestroyFederationCmdMsg,
      DtChangeRidParamMsg,
      DtUndiscoverObjectMsg,
      DtNetworkMapMsg,
      DtUnknownCntlMsg
   };
   enum ConnectionType
   {
      DtRtiExecConnection = 0,
      DtLrcConnection,
      DtForwarderConnection,
      DtRtiExecConnectionLightweight,
      DtLrcConnectionLightweight,
      DtUnknownConnectionType
   };
   enum StateComponentType
   {
      DtBaseStateType = 0,
      DtFomStateType,
      DtRidStateType,
      DtPubSubStateType,
      DtOwnershipStateType,
      DtInteractionStateType,
      DtObjectInterStatsStateType,
      DtApiStatsStateType,
      DtMessageStatsStateType,
      DtNetworkMapStateType
   };
   class DT_DLL_WWW ConnectionIdentifier
   {
   public:
      ConnectionIdentifier();
      ConnectionIdentifier( unsigned long connId, ConnectionType connType,
         const MAKRti::DtString& description, bool forwardingEnabled = false );

      ConnectionIdentifier( const ConnectionIdentifier& orig );
      
      ~ConnectionIdentifier();

      ConnectionIdentifier& operator=( const ConnectionIdentifier& orig );

      bool operator==( const ConnectionIdentifier& other ) const;
      bool operator<( const ConnectionIdentifier& other ) const;

      inline unsigned long id() const;
      inline ConnectionType type() const;
      inline bool forwarding() const;
      inline const MAKRti::DtString& description() const;

   protected:

      unsigned long  myConnId;
      ConnectionType myConnType;
      bool           myForwardingEnabled;
      MAKRti::DtString       myConnectionDescription;
   };

   class DT_DLL_WWW ConnectionState
   {
   public:
      typedef std::pair< MAKRti::DtTime, MAKRti::DtString > ComponentStateUpdateTimePair;

      ConnectionState();

      ConnectionState( std::auto_ptr<MAKRti::DtString> currentState,
         StateComponentType stateType, unsigned long componentId = 0 );

      ConnectionState( const ConnectionState& orig );

      ConnectionState& operator=( const ConnectionState& orig );

      virtual ~ConnectionState();

      void setComponentState( unsigned long componentId, StateComponentType stateType,
         std::auto_ptr<MAKRti::DtString> currentState, bool overwriteNotAppend = true );

      std::vector< unsigned long > componentIds() const;

      std::vector< StateComponentType > stateTypes( unsigned long componentId ) const;

      MAKRti::DtTime timeOfLastComponentUpdate( unsigned long componentId, StateComponentType stateType ) const;

      ComponentStateUpdateTimePair componentState( unsigned long componentId, StateComponentType stateType ) const;

      bool removeComponent( unsigned long componentId );

      std::auto_ptr< MAKRti::DtString > removeComponentStateType( unsigned long componentId, StateComponentType stateType );

      void merge( std::auto_ptr< ConnectionState > connState, bool overwriteNotAppend = true );


   
   protected:
      
      typedef std::pair< MAKRti::DtTime, MAKRti::DtString* > StateUpdateTimePair;
      typedef std::map< StateComponentType, StateUpdateTimePair > StateTypeToStateMap;
      typedef std::map< unsigned long, StateTypeToStateMap > ComponentStateMap;

      MAKRti::DtClock myClock;
      ComponentStateMap myComponents;
   };
  
   static DtRIDParameters& params(); 
   static const MAKRti::DtString& uninitializedPageHTML();
   
   static MAKRti::DtFilename getPathToHtmlRoot( const MAKRti::DtFilename& subDir = "" );   
   
   static MAKRti::DtFilename pathSeparator();
   static bool readTextFileIntoString( const MAKRti::DtFilename& pathToFile, MAKRti::DtString& target );
   static bool readBinaryFileIntoBuffer( const MAKRti::DtFilename& pathToFile, std::vector<char>& target );
   static void setPathToXmlPage( MAKRti::DtString& page, const MAKRti::DtString& pathToXmlPage );

   static bool isValidBinaryFileType( const MAKRti::DtFilename& filename );
   static bool isValidTextFileType( const MAKRti::DtFilename& filename );
   static const MAKRti::DtString& htmlContentTypeForFile( const MAKRti::DtFilename& filename );

   static const MAKRti::DtString& connectionTypeString( ConnectionType connType );

protected:

   static void initialize();
   static MAKRti::DtFilename* thePathToHtmlRoot;
   static bool theInitializationComplete;
   static std::map< MAKRti::DtString, MAKRti::DtString >* theBinaryFileTypesToContentTypeMap;
   static std::map< MAKRti::DtString, MAKRti::DtString >* theTextFileTypesToContentTypeMap;
};


unsigned long DtWebSpyUtils::ConnectionIdentifier::id() const
{
   return myConnId;
}

DtWebSpyUtils::ConnectionType DtWebSpyUtils::ConnectionIdentifier::type() const
{
   return myConnType;
}

bool DtWebSpyUtils::ConnectionIdentifier::forwarding() const
{
   return myForwardingEnabled;
}

const MAKRti::DtString& DtWebSpyUtils::ConnectionIdentifier::description() const
{
   return myConnectionDescription;
}

#endif //! DtWebSpyUtils_H_