assistantMsg.h

Go to the documentation of this file.

/*********************************************************************
** Copyright (c) 1998 MaK Technologies, Inc.
** All rights reserved.
*********************************************************************/
/*********************************************************************
** $RCSfile: assistantMsg.h,v $ $Revision: 1.41 $ $State: Exp $
*********************************************************************/


#ifndef DtAssistantMsg_H_
#define DtAssistantMsg_H_

#include <memory>

#include <vlutil/vlBaseMsg.h>
#include <vlutil/vlString.h>
#include <vlutil/vlInetAddr.h>

#include <internalTypes.h>

#include "assistantUtil.h"
#include "netAssistantMsgHdr.h"

class DtNetAssistantSrcDestInfo;

// Default port for all assistant communication
// When this is changed you must also update DtRIDParameters::verifyPortsAreUnique
#define DtASSISTANT_DEFAULT_PORT 6003

// Default destination id (everyone)
#define DtASSISTANT_DEFAULT_DEST_ID 0

// Default multicast address for communication between assistants
#define DtASSISTANT_DEFAULT_IPV4_ADDR "229.7.7.10"
#define DtASSISTANT_DEFAULT_IPV6_ADDR "ff12::7:10"

// Default TTL for all assistant communication
#define DtASSISTANT_DEFAULT_TTL 1

// RTI 4.1.1  DtAssistantMessageVersion = 14
// RTI 4.2pr  DtAssistantMessageVersion = 15 (pre-release)
// RTI 4.2    DtAssistantMessageVersion = 16
// RTI 4.3    DtAssistantMessageVersion = 17
// RTI 4.4    DtAssistantMessageVersion = 18
// RTI 4.4.x  DtAssistantMessageVersion = 19
// RTI 4.5    DtAssistantMessageVersion = 20
// RTI 4.6    DtAssistantMessageVersion = 21
// RTI 5.0    DtAssistantMessageVersion = 22
// RTI 5.0.1  DtAssistantMessageVersion = 23
#define DtAssistantMessageVersion 23

enum DtAssistantMsgKind
{
   DtAssistantConnMsgKind                  = 0,
   DtAssistantLrcCompInfoMsgKind           = 1,
   DtAssistantRtiexecCompInfoMsgKind       = 2,
   DtAssistantNotifyMsgKind                = 3,
   DtAssistantConnQueryMsgKind             = 4,
   DtAssistantNtfyLvlUpdateMsgKind         = 5,
   DtAssistantExitMsgKind                  = 6,
   DtAssistantLicQueryMsgKind              = 7,
   DtAssistantPopupMsgKind                 = 8,
   DtAssistantShmCompInfoMsgKind           = 9,
   DtAssistantWwwCompInfoMsgKind           = 10,
   DtAssistantRtiForwarderCompInfoMsgKind  = 11,
   DtAssistantLogEnableMsgKind             = 12,
   DtAssistantChangeLatencyTestModeMsgKind = 13,
   DtAssistantLatencyReportMsgKind         = 14,
   DtAssistantTestMgrStatusMsgKind         = 15,
   DtAssistantShutdownMsgKind              = 16,
   DtAssistantStateObserveMsgKind          = 17,
   DtAssistantDeleteFederateMsgKind        = 18,
   DtAssistantDeleteFederationMsgKind      = 19,
   DtAssistantNetworkTestEnableMsgKind     = 20,
   DtAssistantFederationStateMsgKind       = 21,
   DtAssistantFederateStateMsgKind         = 22,
   DtAssistantTimeStateMsgKind             = 23,
   DtAssistantSyncPtUpdateMsgKind          = 24,
   DtAssistantCommandMsgKind               = 25,
   DtAssistantExecStateMsgKind             = 26,
   DtAssistantForwarderStateMsgKind        = 27,
   DtAssistantRidParamsMsgKind             = 28,
   DtAssistantLogRequestMsgKind            = 29,
   DtAssistantLogMsgKind                   = 30,
   DtAssistantShowDialogMsgKind            = 31,
   DtAssistantFederateSignalTickIntervalMsgKind    = 32,
   DtAssistantSignalTickedMsgKind          = 33,
   DtAssistantAwaitingForwardersMsgKind    = 34,
   DtAssistantNotifyObserveMsgKind         = 35,
   DtAssistantNetStatsObserveReqMsgKind            = 36,
   DtAssistantNetStatsObserveRspMsgKind            = 37,
   DtAssistantNetStatsMsgUpdateMsgKind        =38,
   DtAssistantNetStatsRtiAmbUpdateMsgKind        =39,
   DtAssistantNetStatsFedAmbUpdateMsgKind        =40,
   DtAssistantNetStatsObjectsUpdateMsgKind       =41,
   DtAssistantNetStatsInteractionsUpdateMsgKind  =42,
   DtAssistantNetStatsStringUpdateMsgKind        = 43,
   DtAssistantNetStatsStringReqMsgKind           = 44,
   DtAssistantNetStatsFomTreeUpdateMsgKind       = 45,
   DtAssistantNetStatsFomUpdateMsgKind           = 46,
   DtAssistantNetStatsAttrParamStringUpdateMsgKind = 47,
   DtAssistantNetStatsFomAttrParamUpdateMsgKind  = 48,
   DtAssistantNetStatsInitStateRequestMsgKind    = 49,
   DtAssistantForwarderConnectMsgKind            = 50,

   // Assistant to Assistant messages
   DtAssistantQueryMsgKind                 = 254,
   DtAssistantInfoMsgKind                  = 253,
   DtAssistantRemovalMsgKind               = 252,
   DtAssistantStartRtiexecMsgKind          = 251,
   DtAssistantExecObserveRspMsgKind        = 250,
   DtAssistantLightweightInfoMsgKind       = 249,
   DtAssistantLicServerInfoMsgKind         = 248,
   DtAssistantFederateReqMsgKind           = 247,
   DtAssistantFederateRespMsgKind          = 246,
   DtAssistantStartRtiForwarderMsgKind     = 245,
   DtAssistantToAssistantConnectionMsgKind = 244,

   DtInvalidAssistantMsgKind               = 255
};

enum DtAssistantMsgReadStatus
{
   DtASSISTANT_READ_SUCCESS = 0,
   DtASSISTANT_READ_NO_PACKETS,
   DtASSISTANT_READ_BAD_PACKET,
   DtASSISTANT_READ_SERVER_MSG,
   DtASSISTANT_READ_SIZE_MISMATCH,
   DtASSISTANT_READ_FILTERED_PACKET,
   DtASSISTANT_QUEUED_PACKET,
   DtASSISTANT_INVALID_VERSION,
   DtASSISTANT_UNKNOWN_ERROR,
   DtASSISTANT_BUFFER_TOO_SMALL,
   DtASSISTANT_MSG_IGNORED
};

// These status are sent by the Forwarder to Assistants.
// When a forwarder sends its state msg, it has a vector of clientStatus.
enum DtAssistantMsgFederateStatus
{
   DtASSISTANT_UNKNOWN = 0,
   DtASSISTANT_NORMAL,
   DtASSISTANT_NOT_JOINED,
   DtASSISTANT_DROPPED
};

class DT_DLL_ASSISTANT DtAssistantMsg : public MAKRti::DtBaseMsg
{
public:

   virtual ~DtAssistantMsg();

   virtual DtAssistantMsg* clone(bool copy = true) const=0;

   virtual DtNetAssistantMsgHeader* netHeader() const;

   virtual int version() const;

   virtual bool isValidVersion() const;

   virtual DtAssistantMsgKind msgKind() const;

   virtual void print() const;
   virtual void printHeader() const;
   virtual void printSrcDest() const;
   virtual void printData() const;

   virtual bool isOk() const;

   bool isAssistantToAssistantMessage() const;

   virtual MAKRti::DtInetAddr sourceAddr() const;
   virtual void setSourceAddr(const MAKRti::DtInetAddr& addr);

   virtual int sourceId() const;
   virtual void setSourceId(int id);

   virtual MAKRti::DtString sourceHost() const;
   virtual void setSourceHost(const MAKRti::DtString& addr);

   virtual MAKRti::DtInetAddr destAddr() const;
   virtual void setDestAddr(const MAKRti::DtInetAddr& addr);

   virtual int destId() const;
   virtual void setDestId(int id);

   virtual int compId() const;
   virtual void setCompId( int compId );

   virtual const DtAssistantUuid& sourceUuid() const;
   virtual void setSourceUuid(const DtAssistantUuid& uuid);

   virtual bool isForeign() const;
   virtual void setIsForeign( bool isForeignDestination);

   virtual DtU32 sequence() const;
   virtual void setSequence(DtU32 sequenceNumber);


public:

   static const char* kindToString(DtAssistantMsgKind kind);

protected:

   DtAssistantMsg();

   virtual DtAssistantMsgKind internalMsgKind() = 0;

   virtual void sizeChanged(int size);

   void initAssistantMsg(int size, DtAssistantMsgKind msgKindVal, DtBufferPtr buffer);
   void initAssistantMsg(const void *initial, int size, DtBufferPtr buffer);
   void initAssistantMsg(const DtNetAssistantMsgHeader *header, DtBufferPtr buffer);

   virtual void adjustBytes(int offset, int numBytes);

   virtual void adjustBytes(void *address, int numBytes);

   virtual void resizeForSrcDestInfo();

   virtual const DtNetAssistantSrcDestInfo* srcDestInfoPtr() const;
   virtual DtNetAssistantSrcDestInfo* srcDestInfoPtr();

   virtual void setSourceHostSize( unsigned long size );
   virtual unsigned long sourceHostSize() const;

   virtual const char* sourceHostPtr() const;
   virtual char* sourceHostPtr();

};

inline DtNetAssistantMsgHeader* DtAssistantMsg::netHeader() const
{
   return (DtNetAssistantMsgHeader*) netRep();
}

inline DtAssistantMsgKind DtAssistantMsg::msgKind() const
{
   return DtAssistantMsgKind((DtU32) (DtU8) netHeader()->msgKind);
}

inline bool DtAssistantMsg::isOk() const
{
   return true;
}

inline void DtAssistantMsg::adjustBytes(int offset, int numBytes)
{
   if (numBytes > 0)
   {
      insertBytes(offset, numBytes);
   }
   else if (numBytes < 0)
   {
      deleteBytes(offset, -numBytes);
   }
}

inline void DtAssistantMsg::adjustBytes(void *address, int numBytes)
{
   if (numBytes > 0)
   {
      insertBytes(address, numBytes);
   }
   else if (numBytes < 0)
   {
      deleteBytes(address, -numBytes);
   }
}

#endif