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,
      const MAKRti::DtInetAddr& publicAddr,
      const MAKRti::DtInetAddr& tcpAddress, int tcpPort,
      const MAKRti::DtInetAddr& udpAddress, int udpPort, const MAKRti::DtInetAddr& udpInterfaceAddr,
      int forwarderPort );
   DtRtiConnectionInfo(
      const MAKRti::DtInetAddr& publicAddr,
      const MAKRti::DtInetAddr& tcpAddress, int tcpPort,
      const MAKRti::DtInetAddr& udpAddress, int udpPort, const MAKRti::DtInetAddr& udpInterfaceAddr,
      int forwarderPort );

   DtRtiConnectionInfo(
      const MAKRti::DtInetAddr& publicAddr, const MAKRti::DtInetAddr& udpAddress, int port,
      const MAKRti::DtInetAddr& udpInterfaceAddr );

   DtRtiConnectionInfo(const DtHostNameAddress& host,
      const MAKRti::DtInetAddr& publicAddr, int tcpPort,
      const MAKRti::DtInetAddr& udpAddress, int udpPort, const MAKRti::DtInetAddr& udpInterfaceAddr,
      bool useRtiexec, 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 MAKRti::DtString hostName() const;

   virtual void setHostName( const MAKRti::DtString& host, bool skipLookup = false );

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

   virtual const DtHostNameAddress& hostNameAddress() const;

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

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

   virtual int tcpPort() const;

   virtual void setTcpPort( int port );

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

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

   virtual int udpPort() const;

   virtual void setUdpPort( int port );

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

   virtual void setUdpInterfaceAddr( 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;

   virtual MAKRti::DtString hostPort() const;

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

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

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

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

   virtual void setIsRoutesFileBased(bool val) { myIsRoutesFileBased = val; };
   virtual bool isRoutesFileBased() const { return myIsRoutesFileBased; };

   virtual void print(DtOutputStream& os = DtInfo) const;

   virtual void setPublicAddress(const MAKRti::DtInetAddr& publicAddr);

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

public:

   static const DtRtiConnectionInfo& invalidConn();

   static void setLocalIpAddresses( bool reset = false );

   static const DtInetAddrSet& localIpAddresses();

   static bool localSupportsIPv4(bool reset = false);

   static bool localSupportsIPv6(bool reset = false);

   static MAKRti::DtString constructConnName( const DtHostNameAddress& hostAddr, int tcpPort,
      const MAKRti::DtInetAddr& udpAddress, int udpPort, const MAKRti::DtInetAddr& udpInterfaceAddr,
      bool useRtiexec, int forwarderPort );

   static MAKRti::DtString constructConnDescription( const DtHostNameAddress& hostAddr, int tcpPort,
      const MAKRti::DtInetAddr& udpAddress, int udpPort, const MAKRti::DtInetAddr& udpInterfaceAddr,
      bool useRtiexec, int forwarderPort,
      const MAKRti::DtInetAddr& localTcpInterfaceAddr, const MAKRti::DtInetAddr& localUdpInterfaceAddr );


   static MAKRti::DtString hostPort(const MAKRti::DtString& host, int port);


   static const MAKRti::DtInetAddr& defaultTcpAddress();
   static const MAKRti::DtInetAddr& defaultUdpAddress();
   static int defaultLightweightPort();
   static int defaultRtiexecPort();
   static const MAKRti::DtString& defaultHostName();
   static const MAKRti::DtInetAddr& defaultTcpInterfaceAddr();
   static const MAKRti::DtInetAddr& defaultUdpInterfaceAddr();
   static int defaultForwarderPort();

protected:

   static DtInetAddrSet& theLocalIpAddresses();

protected:

   DtHostNameAddress myHostNameAddress;

   int myTcpPort;

   MAKRti::DtInetAddr myUdpAddress;

   int myUdpPort;

   MAKRti::DtInetAddr myUdpInterfaceAddr;

   MAKRti::DtInetAddr myLocalTcpInterfaceAddr;
   bool myLocalTcpInterfaceAddrIsSet;

   MAKRti::DtInetAddr myLocalUdpInterfaceAddr;
   bool myLocalUdpInterfaceAddrIsSet;

   bool myUseRtiexec;

   int myForwarderPort;

   bool myIsRoutesFileBased;

   MAKRti::DtInetAddr myPublicAddress;
};

inline const DtInetAddrSet& DtRtiConnectionInfo::localIpAddresses()
{
   return theLocalIpAddresses();
}




#endif