assistantInfo.h

Go to the documentation of this file.

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

#ifndef assistantInfo_H_
#define assistantInfo_H_


#include <rtiUtil.h>
#include "hostNameAddress.h"
#include "assistantMsg.h"

class DtRtiConnectionInfo;
class DtAssistantInfo;
struct DtAssistantConnectionStruct;

#define DtAssistantUuidNIL DtU128(0)

typedef std::set< DtAssistantInfo > DtAssistantInfoSet;

// If this type ever changes, DtAssistantToAssistantConnectionMsg must be changed as well
typedef DtUuid DtAssistantConnectionId;

const int DtAssistantAnyId = DtASSISTANT_DEFAULT_DEST_ID;
typedef std::pair<MAKRti::DtInetAddr, MAKRti::DtInetAddr> DtPublicPrivateAddrPair;

enum DtAssistantConnectionType
{
   DtUDP       = 0,
   DtTCP       = 1
};
struct DtAssistantConnectionStruct
{
   // Hostname will be unknown until we get a message back
   MAKRti::DtString hostName;
   // Local address
   MAKRti::DtInetAddr localDeviceAddress;
   // Remote address is what the user inputs (IP address) TODO should this be DtString and inetAddr later?
   MAKRti::DtInetAddr remoteAddress;
   // 2nd Part of the remote endpoint.  This port by default is the assistant port default (6003) and the user can change this
   MAKRti::DtU32 port;
   // TCP or UDP, default UDP.
   DtAssistantConnectionType connectionType;
   // UUID is not displayed or initially known, but is used as a key when we get a message back
   DtAssistantUuid  uuid;

   // =D
   DtAssistantConnectionId connectionId;
   // If you have to ask what these are, then you are better off not knowing
   MAKRti::DtInetAddr advancedPublicAddressToUse;
   MAKRti::DtU32 advancedPublicPortToUse;
};
struct cmpByConnectionIdThenPublicAddress {
   bool operator()(const DtAssistantConnectionStruct& a, const DtAssistantConnectionStruct& b) const {
      if (a.connectionId != DtAssistantUuidNIL && b.connectionId != DtAssistantUuidNIL)
      {
         return (DtU128)a.connectionId < (DtU128)b.connectionId;
      }
      else if (a.connectionId == DtAssistantUuidNIL && b.connectionId == DtAssistantUuidNIL)
      {
         return a.remoteAddress < b.remoteAddress;
      }
      else
      {
         return (DtU128)a.connectionId < (DtU128)b.connectionId;
      }
   }
};
struct cmpByPublicAddress {
   bool operator()(const DtAssistantConnectionStruct& a, const DtAssistantConnectionStruct& b) const {
      return a.remoteAddress < b.remoteAddress;
   }
};
struct cmpByUuid {
   bool operator()(const DtAssistantConnectionStruct& a, const DtAssistantConnectionStruct& b) const {
      return a.uuid < b.uuid;
   }
};
struct cmpByConnectionId {
   bool operator()(const DtAssistantConnectionStruct& a, const DtAssistantConnectionStruct& b) const {
      return a.connectionId < b.connectionId;
   }
};
typedef std::set< DtAssistantConnectionStruct, cmpByPublicAddress > DtAssistantSetByAddresses;
typedef std::set< DtAssistantConnectionStruct, cmpByUuid > DtAssistantSetByUuid;
typedef std::set< DtAssistantConnectionStruct, cmpByConnectionIdThenPublicAddress > DtRemoteAssistantSet;

class DT_DLL_ASSISTANT DtAssistantInfo
{
public:

   DtAssistantInfo();

   // Dummy Constructor
   DtAssistantInfo(const DtAssistantUuid& uuid);

   DtAssistantInfo(const DtAssistantInfo& other);
   DtAssistantInfo(DtAssistantUuid uuid, int id, const MAKRti::DtString& host, const MAKRti::DtInetAddr& addr,
      const DtInetAddr& publicAddr,
      const DtInetAddrSet& networkInterfaces, const MAKRti::DtInetAddr& localInterface,
      bool isForeign = false);
   DtAssistantInfo(DtAssistantUuid uuid, int id, const DtHostNameAddress& host,
      const DtInetAddr& publicAddr,
      const DtInetAddrSet& networkInterfaces, const MAKRti::DtInetAddr& interfaceAddr,
      bool isForeign = false );

   ~DtAssistantInfo();

   DtAssistantInfo& operator=(const DtAssistantInfo& other);

   bool operator<(const DtAssistantInfo& other) const;

   bool operator==(const DtAssistantInfo& other) const;

   bool operator!=(const DtAssistantInfo& other) const;

   DtHostNameAddress host() const;

   void setHost( const DtHostNameAddress& host );

   const MAKRti::DtString& hostName() const;

   void setHostName( const MAKRti::DtString& name );

   const MAKRti::DtInetAddr& address() const;

   void setAddress( const MAKRti::DtInetAddr& addr );

   const MAKRti::DtInetAddr& publicAddress() const;

   void setPublicAddress(const MAKRti::DtInetAddr& addr);

   const DtInetAddrSet& networkInterfaces() const;

   void setNetworkInterfaces(const DtInetAddrSet& addresses);

   const MAKRti::DtInetAddr& localInterface() const;

   void setLocalInterface( const MAKRti::DtInetAddr& interfaceAddr );

   void setIsForeign(bool isForeignValue);

   bool isForeign() const;

   void setUuid(const DtAssistantUuid& uuid);
   const DtAssistantUuid& uuid() const;

   void setIsConnected(bool isConnectedValue);

   bool isConnected() const;

   int id() const;

   void setId( int id );

   DtAssistantInfoSet::const_iterator findMatchingHostInfo( const DtAssistantInfoSet& set );

   void removeMatchingHostName( DtAssistantInfoSet& sourceSet );

   bool isThisAssistant() const;

   bool isValid() const;

   static void setThisAssistantId( int id );

   static int collectMatching( const DtRtiConnectionInfo& connection,
      const DtAssistantInfoSet& sourceSet, DtAssistantInfoSet& matchSet );

   static int collectMatching( const DtString& hostName, const DtInetAddr& address,
      const DtAssistantInfoSet& sourceSet, DtAssistantInfoSet& matchSet );

protected:

   DtHostNameAddress myHost;

   MAKRti::DtInetAddr myPublicAddr;

   DtInetAddrSet myNetworkInterfaces;

   MAKRti::DtInetAddr myLocalInterface;

   int myId;

   bool myIsForeign;

   bool myIsConnected;

   // The following are used by the rtiAssistant for GUI purposes
   DtAssistantUuid myUuid;

   DtAssistantConnectionType myConnectionType;

   int myRemoteAssistantPort;

   static int theIdOfThisAssistant;

public:

   static const DtAssistantInfo DtDefaultAssistantInfo;

   static const DtAssistantUuid DtInvalidAssistantInfo;
};

#endif // assistantInfo_H_