![]() |
MAK RTIspy API Documentation for HLA Evolved
|
The DtAssistantForwarderConnectMsg defines a wrapper for the RTI Assistant forwarder connect message used to send request the target forwarder should connect to the specified forwarder. More...
Inheritance diagram for DtAssistantForwarderConnectMsg:
Collaboration diagram for DtAssistantForwarderConnectMsg:Public Member Functions | |
| DtAssistantForwarderConnectMsg (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER) | |
| Constructors. More... | |
| DtAssistantForwarderConnectMsg (const DtNetAssistantForwarderConnectMsg *netRep, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER) | |
| virtual | ~DtAssistantForwarderConnectMsg () |
| Destructor. More... | |
| virtual DtAssistantMsg * | clone (bool copy=true) const |
| Return a copy/empty object of the same type as this. More... | |
| virtual void | setHostName (const MAKRti::DtString &targetHost) |
| Set target forwarder's host name. More... | |
| virtual MAKRti::DtString | hostName () const |
| Get target RTI Forwarder's host name. More... | |
| virtual void | setIpAddress (const MAKRti::DtInetAddr &ipAddr) |
| Set target forwarder's address. More... | |
| virtual MAKRti::DtInetAddr | ipAddress () const |
| Get target RTI Forwarder's address. More... | |
| MAKRti::DtInetUtils::DtInetAddrFamily | addressFamily () const |
| Get the address family. More... | |
| void | setAddressFamily (MAKRti::DtInetUtils::DtInetAddrFamily addrFamily) |
| Set the address family. More... | |
| virtual void | setPort (int port) |
| Set target forwarder's forwarder port number. More... | |
| virtual int | port () const |
| Get target forwarder's forwarder port number. More... | |
| virtual void | printData () const |
| Print the data section. More... | |
Public Member Functions inherited from DtAssistantMsg | |
| virtual | ~DtAssistantMsg () |
| Destructor. More... | |
| virtual DtNetAssistantMsgHeader * | netHeader () const |
| Get header of network representation. More... | |
| virtual int | version () const |
| Return the message version. More... | |
| virtual bool | isValidVersion () const |
| Returns bool: message version is valid? More... | |
| virtual DtAssistantMsgKind | msgKind () const |
| Get the message kind. More... | |
| virtual void | print () const |
| Printing functions. More... | |
| virtual void | printHeader () const |
| virtual void | printSrcDest () const |
| virtual bool | isOk () const |
| Message is good? More... | |
| bool | isAssistantToAssistantMessage () const |
| Returns whether or not this message contains source/destination information included in messages sent between assistants. More... | |
| virtual MAKRti::DtInetAddr | sourceAddr () const |
| Get/Set the IP address of the source of this message. More... | |
| virtual void | setSourceAddr (const MAKRti::DtInetAddr &addr) |
| virtual int | sourceId () const |
| Get/Set the ID of the source of this message. More... | |
| virtual void | setSourceId (int id) |
| virtual MAKRti::DtString | sourceHost () const |
| Get/Set the host name of the source of this message. More... | |
| virtual void | setSourceHost (const MAKRti::DtString &addr) |
| virtual MAKRti::DtInetAddr | destAddr () const |
| Get/Set the IP address of the destination of this message. More... | |
| virtual void | setDestAddr (const MAKRti::DtInetAddr &addr) |
| virtual int | destId () const |
| Get/Set the ID of the destination of this message. More... | |
| virtual void | setDestId (int id) |
| virtual int | compId () const |
| Get/Set the related component's connection ID. More... | |
| virtual void | setCompId (int compId) |
| virtual const DtAssistantUuid & | sourceUuid () const |
| Get/Set the uuid of the source of this message. More... | |
| virtual void | setSourceUuid (const DtAssistantUuid &uuid) |
| virtual bool | isForeign () const |
| Get/Set the whether the source considers the destination foreign Assistant-to-Assistant messages only. More... | |
| virtual void | setIsForeign (bool isForeignDestination) |
| virtual DtU32 | sequence () const |
| Get/Set sequence number Assistant-to-Assistant messages only. More... | |
| virtual void | setSequence (DtU32 sequenceNumber) |
Static Public Member Functions | |
| static DtAssistantMsg * | create (const DtNetAssistantMsgHeader *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER) |
| Creators. More... | |
| static DtAssistantMsg * | create (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER) |
Callback management | |
| static void | addCallback (DtRtiAssistantClient *conn, DtAssistantForwarderConnectCb cb, void *usr) |
| static void | removeCallback (DtRtiAssistantClient *conn, DtAssistantForwarderConnectCb cb, void *usr) |
| static void | addCallback (DtRtiAssistantPeer *conn, DtAssistantForwarderConnectCb cb, void *usr) |
| static void | removeCallback (DtRtiAssistantPeer *conn, DtAssistantForwarderConnectCb cb, void *usr) |
Static Public Member Functions inherited from DtAssistantMsg | |
| static const char * | kindToString (DtAssistantMsgKind kind) |
| Returns the name of the message, by kind enumeration. More... | |
Protected Member Functions | |
| virtual DtNetAssistantForwarderConnectMsg * | netAssistantForwarderConnectMsg () |
| The network representation for the Forwarder connect message. More... | |
| virtual const DtNetAssistantForwarderConnectMsg * | netAssistantForwarderConnectMsg () const |
| virtual DtAssistantMsgKind | internalMsgKind () |
| Returns the kind of a DtAssistantForwarderConnectMsg message. More... | |
| virtual int | minSize () const |
| Returns minimum size of a message, including header. More... | |
| virtual void | setHostNameSize (unsigned int size) |
| Set/Get forwarder host name text size. More... | |
| virtual unsigned int | hostNameSize () const |
| virtual const char * | hostNamePtr () const |
| Return pointer to rtiexec/forwarder host names location in msg. More... | |
| virtual char * | hostNamePtr () |
Protected Member Functions inherited from DtAssistantMsg | |
| DtAssistantMsg () | |
| Constructor. More... | |
| virtual void | sizeChanged (int size) |
| Called whenever size is changed using changeSize, or insert/deleteBytes. More... | |
| void | initAssistantMsg (int size, DtAssistantMsgKind msgKindVal, DtBufferPtr buffer) |
| Called by ctor, so not virtual. More... | |
| void | initAssistantMsg (const void *initial, int size, DtBufferPtr buffer) |
| void | initAssistantMsg (const DtNetAssistantMsgHeader *header, DtBufferPtr buffer) |
| virtual void | adjustBytes (int offset, int numBytes) |
| Adjust numBytes bytes at the indicated offset in the net rep. More... | |
| virtual void | adjustBytes (void *address, int numBytes) |
| Adjust the numBytes starting at the indicated address. More... | |
| virtual void | resizeForSrcDestInfo () |
| Allocates memory at the end of the message for source/destination information needed when sending messages between assistants. More... | |
| virtual const DtNetAssistantSrcDestInfo * | srcDestInfoPtr () const |
| Return pointer to source/destination information in the message. More... | |
| virtual DtNetAssistantSrcDestInfo * | srcDestInfoPtr () |
| virtual void | setSourceHostSize (unsigned long size) |
| Set/Get source host name text size. More... | |
| virtual unsigned long | sourceHostSize () const |
| virtual const char * | sourceHostPtr () const |
| Return pointer to source host name in message. More... | |
| virtual char * | sourceHostPtr () |
The DtAssistantForwarderConnectMsg defines a wrapper for the RTI Assistant forwarder connect message used to send request the target forwarder should connect to the specified forwarder.
| DtAssistantForwarderConnectMsg::DtAssistantForwarderConnectMsg | ( | DtBufferPtr | buffer = DtUSE_INTERNAL_BUFFER | ) |
Constructors.
| DtAssistantForwarderConnectMsg::DtAssistantForwarderConnectMsg | ( | const DtNetAssistantForwarderConnectMsg * | netRep, |
| DtBufferPtr | buffer = DtUSE_INTERNAL_BUFFER |
||
| ) |
|
virtual |
Destructor.
|
static |
|
static |
| MAKRti::DtInetUtils::DtInetAddrFamily DtAssistantForwarderConnectMsg::addressFamily | ( | ) | const |
Get the address family.
|
virtual |
Return a copy/empty object of the same type as this.
Implements DtAssistantMsg.
|
static |
Creators.
|
static |
|
virtual |
Get target RTI Forwarder's host name.
|
protectedvirtual |
Return pointer to rtiexec/forwarder host names location in msg.
|
protectedvirtual |
|
protectedvirtual |
|
protectedvirtual |
Returns the kind of a DtAssistantForwarderConnectMsg message.
Implements DtAssistantMsg.
|
virtual |
Get target RTI Forwarder's address.
|
protectedvirtual |
Returns minimum size of a message, including header.
|
protectedvirtual |
The network representation for the Forwarder connect message.
|
protectedvirtual |
|
virtual |
Get target forwarder's forwarder port number.
|
virtual |
Print the data section.
Reimplemented from DtAssistantMsg.
|
static |
|
static |
| void DtAssistantForwarderConnectMsg::setAddressFamily | ( | MAKRti::DtInetUtils::DtInetAddrFamily | addrFamily | ) |
Set the address family.
|
virtual |
Set target forwarder's host name.
|
protectedvirtual |
Set/Get forwarder host name text size.
|
virtual |
Set target forwarder's address.
|
virtual |
Set target forwarder's forwarder port number.