assistantConnectionInfo.h

Go to the documentation of this file.

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

#ifndef assistantConnectionInfo_H_
#define assistantConnectionInfo_H_


#include <rtiUtil.h>
#include <vlutil/vlString.h>
#include <vlutil/vlMutex.h>
#include "assistantUtil.h"
#include "assistantInfo.h"
#include "assistantConnectionAssocData.h"
#include <hostNameAddress.h>

class DtRtiConnectionInfo;

typedef std::map<DtRtiConnectionInfo,DtRtiAssociatedConnectionData> DtRtiConnectionInfoDataMap;

typedef std::pair<DtRtiConnectionInfo,DtRtiAssociatedConnectionData> DtRtiConnectionInfoDataPair;

DT_DLL_ASSISTANT MAKRti::DtString DtAssistantConnNameForDisplay( const DtRtiConnectionInfoDataPair& conn,
                                                                 bool withOwner, bool withInterface );

class DT_DLL_ASSISTANT DtRtiConnectionInfo
{
public:

   DtRtiConnectionInfo();

   DtRtiConnectionInfo( const MAKRti::DtString& hostname, int udpPort,
      int tcpPort, const MAKRti::DtInetAddr& bestEffortAddress,
      const MAKRti::DtInetAddr& interfaceAddr, int forwarderPort );
   DtRtiConnectionInfo( const MAKRti::DtInetAddr& reliableAddress,
      int udpPort, int tcpPort, const MAKRti::DtInetAddr& bestEffortAddress,
      const MAKRti::DtInetAddr& interfaceAddr, int forwarderPort );

   DtRtiConnectionInfo( const MAKRti::DtInetAddr& bestEffortAddress, int port, 
      const MAKRti::DtInetAddr& interfaceAddr );

   DtRtiConnectionInfo( const DtHostNameAddress& host, int udpPort,
      int tcpPort, const MAKRti::DtInetAddr& bestEffortAddress,
      bool useRtiexec, const MAKRti::DtInetAddr& interfaceAddr,
      int forwarderPort );

   virtual ~DtRtiConnectionInfo();

   virtual bool operator<(const DtRtiConnectionInfo& other) const;

   virtual bool operator==(const DtRtiConnectionInfo& other) const;

   virtual bool operator!=(const DtRtiConnectionInfo& other) const;

   virtual DtRtiConnectionInfo& operator=(const DtRtiConnectionInfo& other);

   virtual bool isEquivalentHost( const DtRtiConnectionInfo& other ) const;

   virtual bool isEquivalentHostAllInterfaces(const DtRtiConnectionInfo& other) const;

   virtual bool isLocalHost() const;

   virtual bool conflictsWith( const DtRtiConnectionInfo& other,
      MAKRti::DtString& reason ) const;

   virtual MAKRti::DtString defaultName() const;

   virtual MAKRti::DtString description() const;

   virtual const MAKRti::DtInetAddr& reliableIp() const;

   virtual void setReliableIp( const MAKRti::DtInetAddr& ip );

   virtual const MAKRti::DtInetAddr& bestEffortIp() const;

   virtual void setBestEffortIp( const MAKRti::DtInetAddr& ip );

   virtual int udpPort() const;

   virtual void setUdpPort( int port );

   virtual int tcpPort() const;

   virtual void setTcpPort( int port );

   virtual MAKRti::DtString hostName() const;

   virtual void setHostName( const MAKRti::DtString& host );

   virtual const MAKRti::DtInetAddr& networkInterfaceAddr() const;

   virtual void setNetworkInterfaceAddr( const MAKRti::DtInetAddr& addr );

   virtual bool useRtiexec() const;

   virtual void setUseRtiexec( bool useExec );

   virtual int forwarderPort() const;

   virtual void setForwarderPort( int port );

   virtual bool isValid() const;

public:

   static const DtRtiConnectionInfo& invalidConn();

   static void setLocalIpAddresses( bool reset = false );

   static const std::set< MAKRti::DtInetAddr >& localIpAddresses();

   static bool localSupportsIPv4(bool reset = false);

   static bool localSupportsIPv6(bool reset = false);

   static MAKRti::DtString constructConnName( const DtHostNameAddress& hostname,
      int udpPort, int tcpPort, const MAKRti::DtInetAddr& bestEffortAddress,
      bool useRtiexec, const MAKRti::DtInetAddr& interfaceAddr,
      int forwarderPort );

   static MAKRti::DtString constructConnDescription( const DtHostNameAddress& hostname,
      int udpPort, int tcpPort, const MAKRti::DtInetAddr& bestEffortAddress,
      bool useRtiexec, const MAKRti::DtInetAddr& interfaceAddr,
      int forwarderPort );


   static const MAKRti::DtInetAddr& defaultReliableIp();
   static const MAKRti::DtInetAddr& defaultBestEffortIp();
   static int defaultLightweightPort();
   static int defaultRtiexecPort();
   static const MAKRti::DtString& defaultHostName();
   static const MAKRti::DtInetAddr& defaultNetworkInterfaceAddr();
   static int defaultForwarderPort();

protected:

   MAKRti::DtInetAddr myBestEffortIp;

   int myUdpPort;

   int myTcpPort;

   DtHostNameAddress myHostNameAddress;

   MAKRti::DtInetAddr myNetworkInterfaceAddr;

   bool myUseRtiexec;

   int myForwarderPort;

   static std::set< MAKRti::DtInetAddr > &theLocalIpAddresses();

   
};

inline const std::set< MAKRti::DtInetAddr >& DtRtiConnectionInfo::localIpAddresses()
{
   return theLocalIpAddresses();
}




#endif