MAK RTIspy API Documentation for HLA 1.3: assistantRtiForwarderCompInfoMsg.h Source File

Go to the documentation of this file.
00001 /*********************************************************************
00002 ** Copyright (c) 2008 MaK Technologies, Inc.
00003 ** All rights reserved.
00004 *********************************************************************/
00005 /*********************************************************************
00006 ** $RCSfile: assistantRtiForwarderCompInfoMsg.h,v $ $Revision: 1.9 $ $State: Exp $
00007 *********************************************************************/
00008 
00009 #ifndef assistantRtiForwarderCompInfoMsg_H_
00010 #define assistantRtiForwarderCompInfoMsg_H_
00011 
00015 
00016 #include <vlutil/vlFilename.h>
00017 #include <vlutil/vlPrint.h>
00018 
00019 #include "assistantMsg.h"
00020 #include "assistantConnMsg.h"
00021 #include "assistantConnectionInfo.h"
00022 #include "netAssistantRtiForwarderCompInfoMsg.h"
00023 
00024 class DtAssistantRtiForwarderCompInfoMsg;
00025 class DtRtiAssistantServer;
00026 class MAKRti::DtInetAddr;
00027 
00028 typedef void (*DtAssistantRtiForwarderCompInfoCb)(const DtAssistantRtiForwarderCompInfoMsg& inter, void* usr);
00029 
00030 
00035 class DT_DLL_ASSISTANT DtAssistantRtiForwarderCompInfoMsg : public DtAssistantMsg
00036 {
00037 
00038 public:
00039    
00041    DtAssistantRtiForwarderCompInfoMsg(DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER);
00042 
00043    DtAssistantRtiForwarderCompInfoMsg(const DtNetAssistantRtiForwarderCompInfoMsg* netRep,
00044       DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER);
00045 
00047    virtual ~DtAssistantRtiForwarderCompInfoMsg();
00048 
00050    virtual DtAssistantMsg* clone(bool copy = true) const;
00051 
00053    virtual void setReliableIpAddress(const MAKRti::DtInetAddr& ipAddr);
00054 
00056    virtual MAKRti::DtInetAddr reliableIpAddress() const;
00057 
00059    virtual void setBestEffortIpAddress(const MAKRti::DtInetAddr& ipAddr);
00060 
00062    virtual MAKRti::DtInetAddr bestEffortIpAddress() const;
00063 
00065    virtual void setUdpPort(int port);
00066 
00068    virtual int udpPort() const;
00069 
00071    virtual void setTcpPort(int port);
00072 
00074    virtual int tcpPort() const;
00075 
00077    virtual void setHostName(const MAKRti::DtString& name);
00078 
00080    virtual MAKRti::DtString hostName() const;
00081 
00083    virtual void setFullCompliance(bool val);
00084 
00086    virtual bool fullCompliance() const;
00087 
00089    virtual int forwarderPort() const;
00090 
00092    virtual void setForwarderPort(int forwarderPortToUse);
00093 
00095    virtual MAKRti::DtInetAddr additionalForwarderConnection() const;
00096 
00098    virtual void setAdditionalForwarderConnection(const MAKRti::DtInetAddr& addr);
00099 
00101    virtual bool execConfirmed() const;
00102 
00104    virtual void setExecConfirmed(bool isConnected);
00105 
00107    virtual void printData() const;
00108 
00109 public:
00110 
00112    static DtAssistantMsg* create(const DtNetAssistantMsgHeader* initial,
00113       DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER);
00114 
00115    static DtAssistantMsg* create(DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER);
00116 
00119    static void addCallback(DtRtiAssistantServer* conn, DtAssistantRtiForwarderCompInfoCb cb, void* usr);
00120    static void removeCallback(DtRtiAssistantServer* conn, DtAssistantRtiForwarderCompInfoCb cb, void* usr);
00121 
00122 protected:
00123 
00125    virtual DtNetAssistantRtiForwarderCompInfoMsg* netAssistantRtiForwarderCompInfoMsg();
00126    virtual const DtNetAssistantRtiForwarderCompInfoMsg* netAssistantRtiForwarderCompInfoMsg() const;
00127 
00129    virtual DtAssistantMsgKind internalMsgKind();
00130 
00132    virtual int minSize() const;
00133 
00135    virtual void setHostNameSize( unsigned long size );
00136    virtual unsigned long hostNameSize() const;
00137 
00139    virtual const char* hostNamePtr() const;
00140    virtual char* hostNamePtr();
00141 
00142 };
00143 
00144 #endif