![]() |
MAK RTIspy API Documentation for HLA 1.3
|
The DtAssistantConnQueryMsg defines a wrapper for the messages sent to and from the Assistant to query for connection information and respond with the connection information. More...
Inheritance diagram for DtAssistantConnQueryMsg:
Collaboration diagram for DtAssistantConnQueryMsg:Public Member Functions | |
| DtAssistantConnQueryMsg (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER) | |
| Constructor. | |
| DtAssistantConnQueryMsg (const DtNetAssistantConnQueryMsg *netRep, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER) | |
| Constructor. | |
| virtual | ~DtAssistantConnQueryMsg () |
| Destructor. | |
| virtual DtAssistantMsg * | clone (bool copy=true) const |
| Return a copy/empty object of the same type as this. | |
| virtual MAKRti::DtInetAddr | reliableIpAddress () const |
| Get reliable IP address. | |
| virtual MAKRti::DtInetAddr | bestEffortIpAddress () const |
| Get best effort IP address. | |
| virtual MAKRti::DtInetAddr | networkInterfaceAddress () const |
| Get local network interface address to be used. | |
| virtual MAKRti::DtInetUtils::DtInetAddrFamily | addressFamily () const |
| Get the address family. | |
| virtual int | udpPort () const |
| Get UDP port. | |
| virtual int | tcpPort () const |
| Get TCP port. | |
| virtual bool | useRtiexec () const |
| Get whether rtiexec should be used. | |
| virtual void | setIsAssistantToAssistant (bool yesNo) |
| Set whether this is from an assistant to assistant client. | |
| virtual bool | isAssistantToAssistant () const |
| Get whether this is from an assistant to assistant client. | |
| virtual bool | forceFullCompliance () const |
| Get whether full compliance should be forced. | |
| virtual bool | isAccepted () const |
| Get whether query was accepted. | |
| virtual bool | isError () const |
| Get whether this query is due to a connection error. | |
| virtual MAKRti::DtInetAddr | additionalForwarderConnectionAddr () const |
| The forwarding component should attempt to make an additional connection to the specified address. | |
| virtual int | forwarderPort () const |
| The forwarding component should use the specified port for forwarder to forwarder connections. | |
| virtual void | printData () const |
| Print the data section. | |
| virtual void | setLRCParameters (const MAKRti::DtInetAddr &address, const MAKRti::DtInetAddr &bestEffortIpAddr, const MAKRti::DtInetAddr &networkInterfaceToUse, int udpPort, int tcpPort, bool useRtiExec, bool isForceFullCompliance, int forwarderPort, bool isAccepted) |
| virtual void | setForwardingParameters (const MAKRti::DtInetAddr &addr, const MAKRti::DtInetAddr &bestEffortAddr, const MAKRti::DtInetAddr &networkInterface, int udpPort, int tcpPort, bool isFullyCompliant, int forwarderPort, const MAKRti::DtInetAddr &additionalForwarder, bool isAccepted) |
| virtual void | setError (bool val) |
| Set whether this query is due to a connection error. | |
Static Public Member Functions | |
| static DtAssistantMsg * | create (const DtNetAssistantMsgHeader *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER) |
| Creator. | |
| static DtAssistantMsg * | create (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER) |
| Creator. | |
| static void | addCallback (DtRtiAssistantServer *conn, DtAssistantConnQueryCb cb, void *usr) |
| Callback management. | |
| static void | removeCallback (DtRtiAssistantServer *conn, DtAssistantConnQueryCb cb, void *usr) |
| static void | addCallback (DtAssistantMsgQueue *queue, DtAssistantConnQueryCb cb, void *usr) |
| static void | removeCallback (DtAssistantMsgQueue *queue, DtAssistantConnQueryCb cb, void *usr) |
Protected Member Functions | |
| virtual void | setReliableIpAddress (const MAKRti::DtInetAddr &ipAddress) |
| Set reliable IP address. | |
| virtual void | setBestEffortIpAddress (const MAKRti::DtInetAddr &ipAddress) |
| Set best effort IP address. | |
| virtual void | setNetworkInterfaceAddress (const MAKRti::DtInetAddr &address) |
| Set local network interface address to be used. | |
| virtual void | setAddressFamily (MAKRti::DtInetUtils::DtInetAddrFamily addrFamily) |
| Set address family (IPv6 or IPv4) which the is being used. | |
| virtual void | setUdpPort (int port) |
| Set UDP port. | |
| virtual void | setTcpPort (int port) |
| Set TCP port. | |
| virtual void | setUseRtiexec (bool val) |
| Set whether rtiexec should be used. | |
| virtual void | setForceFullCompliance (bool val) |
| Set whether full compliance should be forced. | |
| virtual void | setAccepted (bool val) |
| Set whether query was accepted. | |
| virtual void | setAdditionalForwarderConnectionAddr (const MAKRti::DtInetAddr &addr) |
| The forwarding component should attempt to make an additional connection to the specified address. | |
| virtual void | setForwarderPort (int port) |
| The forwarding component should use the specified port for forwarder to forwarder connections. | |
| virtual void | setAdditionalForwarderSize (unsigned long size) |
| virtual unsigned long | additionalForwarderSize () const |
| virtual const char * | additionalForwarderPtr () const |
| virtual char * | additionalForwarderPtr () |
| virtual DtNetAssistantConnQueryMsg * | netAssistantConnQueryMsg () |
| The network representation. | |
| virtual const DtNetAssistantConnQueryMsg * | netAssistantConnQueryMsg () const |
| virtual DtAssistantMsgKind | internalMsgKind () |
| Returns the kind of a DtAssistantConnQueryMsg Msg. | |
| virtual int | minSize () const |
| Returns minimum size of a message, including header. | |
The DtAssistantConnQueryMsg defines a wrapper for the messages sent to and from the Assistant to query for connection information and respond with the connection information.
| DtAssistantConnQueryMsg::DtAssistantConnQueryMsg | ( | DtBufferPtr | buffer = DtUSE_INTERNAL_BUFFER | ) |
Constructor.
References DtNetAssistantConnQueryMsg::error, DtAssistantMsg::initAssistantMsg(), internalMsgKind(), minSize(), and netAssistantConnQueryMsg().
| DtAssistantConnQueryMsg::DtAssistantConnQueryMsg | ( | const DtNetAssistantConnQueryMsg * | netRep, |
| DtBufferPtr | buffer = DtUSE_INTERNAL_BUFFER |
||
| ) |
Constructor.
References DtNetAssistantConnQueryMsg::header, and DtAssistantMsg::initAssistantMsg().
| DtAssistantConnQueryMsg::~DtAssistantConnQueryMsg | ( | ) | [virtual] |
Destructor.
| void DtAssistantConnQueryMsg::addCallback | ( | DtRtiAssistantServer * | conn, |
| DtAssistantConnQueryCb | cb, | ||
| void * | usr | ||
| ) | [static] |
Callback management.
References DtRtiAssistantServer::addMsgCallback(), and DtAssistantConnQueryMsgKind.
Referenced by DtAssistantConnQueryMgr::DtAssistantConnQueryMgr().
| void DtAssistantConnQueryMsg::addCallback | ( | DtAssistantMsgQueue * | queue, |
| DtAssistantConnQueryCb | cb, | ||
| void * | usr | ||
| ) | [static] |
References DtAssistantMsgQueue::addMsgCallback(), and DtAssistantConnQueryMsgKind.
| DtInetAddr DtAssistantConnQueryMsg::additionalForwarderConnectionAddr | ( | ) | const [virtual] |
The forwarding component should attempt to make an additional connection to the specified address.
References additionalForwarderPtr(), and additionalForwarderSize().
Referenced by DtRtiAssistantClient::sendForwardingComponentConnQueryMsg().
| const char * DtAssistantConnQueryMsg::additionalForwarderPtr | ( | ) | const [protected, virtual] |
References netAssistantConnQueryMsg().
Referenced by additionalForwarderConnectionAddr(), and setAdditionalForwarderConnectionAddr().
| char * DtAssistantConnQueryMsg::additionalForwarderPtr | ( | ) | [protected, virtual] |
References netAssistantConnQueryMsg().
| unsigned long DtAssistantConnQueryMsg::additionalForwarderSize | ( | ) | const [protected, virtual] |
References DtNetAssistantConnQueryMsg::additionalForwarderNameSize, and netAssistantConnQueryMsg().
Referenced by additionalForwarderConnectionAddr(), and setAdditionalForwarderConnectionAddr().
| MAKRti::DtInetUtils::DtInetAddrFamily DtAssistantConnQueryMsg::addressFamily | ( | ) | const [virtual] |
Get the address family.
References netAssistantConnQueryMsg().
Referenced by bestEffortIpAddress(), networkInterfaceAddress(), and reliableIpAddress().
| DtInetAddr DtAssistantConnQueryMsg::bestEffortIpAddress | ( | ) | const [virtual] |
Get best effort IP address.
References addressFamily(), and netAssistantConnQueryMsg().
Referenced by printData(), DtRtiAssistantClient::sendForwardingComponentConnQueryMsg(), and DtRtiAssistantClient::sendLRCConnQueryMsg().
| DtAssistantMsg * DtAssistantConnQueryMsg::clone | ( | bool | copy = true | ) | const [virtual] |
Return a copy/empty object of the same type as this.
Implements DtAssistantMsg.
References DtAssistantConnQueryMsg(), and netAssistantConnQueryMsg().
| DtAssistantMsg * DtAssistantConnQueryMsg::create | ( | const DtNetAssistantMsgHeader * | initial, |
| DtBufferPtr | buffer = DtUSE_INTERNAL_BUFFER |
||
| ) | [static] |
Creator.
References DtAssistantConnQueryMsg().
| DtAssistantMsg * DtAssistantConnQueryMsg::create | ( | DtBufferPtr | buffer = DtUSE_INTERNAL_BUFFER | ) | [static] |
Creator.
References DtAssistantConnQueryMsg().
| bool DtAssistantConnQueryMsg::forceFullCompliance | ( | ) | const [virtual] |
Get whether full compliance should be forced.
References DtNetAssistantConnQueryMsg::forceFullCompliance, and netAssistantConnQueryMsg().
Referenced by printData(), DtRtiAssistantClient::sendForwardingComponentConnQueryMsg(), and DtRtiAssistantClient::sendLRCConnQueryMsg().
| int DtAssistantConnQueryMsg::forwarderPort | ( | ) | const [virtual] |
The forwarding component should use the specified port for forwarder to forwarder connections.
References DtNetAssistantConnQueryMsg::forwarderPort, and netAssistantConnQueryMsg().
Referenced by DtRtiAssistantClient::sendForwardingComponentConnQueryMsg(), and DtRtiAssistantClient::sendLRCConnQueryMsg().
| DtAssistantMsgKind DtAssistantConnQueryMsg::internalMsgKind | ( | ) | [protected, virtual] |
Returns the kind of a DtAssistantConnQueryMsg Msg.
Implements DtAssistantMsg.
References DtAssistantConnQueryMsgKind.
Referenced by DtAssistantConnQueryMsg().
| bool DtAssistantConnQueryMsg::isAccepted | ( | ) | const [virtual] |
Get whether query was accepted.
References DtNetAssistantConnQueryMsg::accepted, and netAssistantConnQueryMsg().
Referenced by printData(), DtRtiAssistantClient::sendForwardingComponentConnQueryMsg(), and DtRtiAssistantClient::sendLRCConnQueryMsg().
| bool DtAssistantConnQueryMsg::isAssistantToAssistant | ( | ) | const [virtual] |
Get whether this is from an assistant to assistant client.
References DtNetAssistantConnQueryMsg::assistant, and netAssistantConnQueryMsg().
| bool DtAssistantConnQueryMsg::isError | ( | ) | const [virtual] |
Get whether this query is due to a connection error.
References DtNetAssistantConnQueryMsg::error, and netAssistantConnQueryMsg().
Referenced by printData(), and DtAssistantConnQueryMgr::processConnQueryMsg().
| int DtAssistantConnQueryMsg::minSize | ( | ) | const [protected, virtual] |
Returns minimum size of a message, including header.
Referenced by DtAssistantConnQueryMsg().
| DtNetAssistantConnQueryMsg * DtAssistantConnQueryMsg::netAssistantConnQueryMsg | ( | ) | [protected, virtual] |
The network representation.
Referenced by additionalForwarderPtr(), additionalForwarderSize(), addressFamily(), bestEffortIpAddress(), clone(), DtAssistantConnQueryMsg(), forceFullCompliance(), forwarderPort(), isAccepted(), isAssistantToAssistant(), isError(), networkInterfaceAddress(), reliableIpAddress(), setAccepted(), setAdditionalForwarderSize(), setAddressFamily(), setBestEffortIpAddress(), setError(), setForceFullCompliance(), setForwarderPort(), setIsAssistantToAssistant(), setNetworkInterfaceAddress(), setReliableIpAddress(), setTcpPort(), setUdpPort(), setUseRtiexec(), tcpPort(), udpPort(), and useRtiexec().
| const DtNetAssistantConnQueryMsg * DtAssistantConnQueryMsg::netAssistantConnQueryMsg | ( | ) | const [protected, virtual] |
| DtInetAddr DtAssistantConnQueryMsg::networkInterfaceAddress | ( | ) | const [virtual] |
Get local network interface address to be used.
References addressFamily(), and netAssistantConnQueryMsg().
Referenced by DtRtiAssistantClient::sendForwardingComponentConnQueryMsg(), and DtRtiAssistantClient::sendLRCConnQueryMsg().
| void DtAssistantConnQueryMsg::printData | ( | ) | const [virtual] |
Print the data section.
Reimplemented from DtAssistantMsg.
References bestEffortIpAddress(), forceFullCompliance(), isAccepted(), isError(), reliableIpAddress(), tcpPort(), udpPort(), and useRtiexec().
| DtInetAddr DtAssistantConnQueryMsg::reliableIpAddress | ( | ) | const [virtual] |
Get reliable IP address.
References addressFamily(), and netAssistantConnQueryMsg().
Referenced by printData(), DtRtiAssistantClient::sendForwardingComponentConnQueryMsg(), and DtRtiAssistantClient::sendLRCConnQueryMsg().
| void DtAssistantConnQueryMsg::removeCallback | ( | DtRtiAssistantServer * | conn, |
| DtAssistantConnQueryCb | cb, | ||
| void * | usr | ||
| ) | [static] |
References DtAssistantConnQueryMsgKind, and DtRtiAssistantServer::removeMsgCallback().
Referenced by DtAssistantConnQueryMgr::~DtAssistantConnQueryMgr().
| void DtAssistantConnQueryMsg::removeCallback | ( | DtAssistantMsgQueue * | queue, |
| DtAssistantConnQueryCb | cb, | ||
| void * | usr | ||
| ) | [static] |
References DtAssistantConnQueryMsgKind, and DtAssistantMsgQueue::removeMsgCallback().
| void DtAssistantConnQueryMsg::setAccepted | ( | bool | val | ) | [protected, virtual] |
Set whether query was accepted.
References DtNetAssistantConnQueryMsg::accepted, and netAssistantConnQueryMsg().
Referenced by setForwardingParameters(), and setLRCParameters().
| void DtAssistantConnQueryMsg::setAdditionalForwarderConnectionAddr | ( | const MAKRti::DtInetAddr & | addr | ) | [protected, virtual] |
The forwarding component should attempt to make an additional connection to the specified address.
References additionalForwarderPtr(), additionalForwarderSize(), rti1516e::insertBytes(), and setAdditionalForwarderSize().
Referenced by setForwardingParameters().
| void DtAssistantConnQueryMsg::setAdditionalForwarderSize | ( | unsigned long | size | ) | [protected, virtual] |
References DtNetAssistantConnQueryMsg::additionalForwarderNameSize, and netAssistantConnQueryMsg().
Referenced by setAdditionalForwarderConnectionAddr().
| void DtAssistantConnQueryMsg::setAddressFamily | ( | MAKRti::DtInetUtils::DtInetAddrFamily | addrFamily | ) | [protected, virtual] |
Set address family (IPv6 or IPv4) which the is being used.
References DtNetAssistantConnQueryMsg::inetAddrFamily, and netAssistantConnQueryMsg().
Referenced by setForwardingParameters(), and setLRCParameters().
| void DtAssistantConnQueryMsg::setBestEffortIpAddress | ( | const MAKRti::DtInetAddr & | ipAddress | ) | [protected, virtual] |
Set best effort IP address.
References DtNetAssistantConnQueryMsg::bestEffortIpAddress, and netAssistantConnQueryMsg().
Referenced by setForwardingParameters(), and setLRCParameters().
| void DtAssistantConnQueryMsg::setError | ( | bool | val | ) | [virtual] |
Set whether this query is due to a connection error.
References DtNetAssistantConnQueryMsg::error, and netAssistantConnQueryMsg().
Referenced by DtRtiAssistantClient::sendLRCConnQueryMsg().
| void DtAssistantConnQueryMsg::setForceFullCompliance | ( | bool | val | ) | [protected, virtual] |
Set whether full compliance should be forced.
References DtNetAssistantConnQueryMsg::forceFullCompliance, and netAssistantConnQueryMsg().
Referenced by setForwardingParameters(), and setLRCParameters().
| void DtAssistantConnQueryMsg::setForwarderPort | ( | int | port | ) | [protected, virtual] |
The forwarding component should use the specified port for forwarder to forwarder connections.
References DtNetAssistantConnQueryMsg::forwarderPort, and netAssistantConnQueryMsg().
Referenced by setForwardingParameters(), and setLRCParameters().
| void DtAssistantConnQueryMsg::setForwardingParameters | ( | const MAKRti::DtInetAddr & | addr, |
| const MAKRti::DtInetAddr & | bestEffortAddr, | ||
| const MAKRti::DtInetAddr & | networkInterface, | ||
| int | udpPort, | ||
| int | tcpPort, | ||
| bool | isFullyCompliant, | ||
| int | forwarderPort, | ||
| const MAKRti::DtInetAddr & | additionalForwarder, | ||
| bool | isAccepted | ||
| ) | [virtual] |
References setAccepted(), setAdditionalForwarderConnectionAddr(), setAddressFamily(), setBestEffortIpAddress(), setForceFullCompliance(), setForwarderPort(), setNetworkInterfaceAddress(), setReliableIpAddress(), setTcpPort(), setUdpPort(), and setUseRtiexec().
Referenced by DtRtiAssistantServer::sendConnRespMsg().
| void DtAssistantConnQueryMsg::setIsAssistantToAssistant | ( | bool | yesNo | ) | [virtual] |
Set whether this is from an assistant to assistant client.
References DtNetAssistantConnQueryMsg::assistant, and netAssistantConnQueryMsg().
| void DtAssistantConnQueryMsg::setLRCParameters | ( | const MAKRti::DtInetAddr & | address, |
| const MAKRti::DtInetAddr & | bestEffortIpAddr, | ||
| const MAKRti::DtInetAddr & | networkInterfaceToUse, | ||
| int | udpPort, | ||
| int | tcpPort, | ||
| bool | useRtiExec, | ||
| bool | isForceFullCompliance, | ||
| int | forwarderPort, | ||
| bool | isAccepted | ||
| ) | [virtual] |
| void DtAssistantConnQueryMsg::setNetworkInterfaceAddress | ( | const MAKRti::DtInetAddr & | address | ) | [protected, virtual] |
Set local network interface address to be used.
References netAssistantConnQueryMsg(), and DtNetAssistantConnQueryMsg::networkInterfaceAddress.
Referenced by setForwardingParameters(), and setLRCParameters().
| void DtAssistantConnQueryMsg::setReliableIpAddress | ( | const MAKRti::DtInetAddr & | ipAddress | ) | [protected, virtual] |
Set reliable IP address.
References netAssistantConnQueryMsg(), and DtNetAssistantConnQueryMsg::reliableIpAddress.
Referenced by setForwardingParameters(), and setLRCParameters().
| void DtAssistantConnQueryMsg::setTcpPort | ( | int | port | ) | [protected, virtual] |
Set TCP port.
References netAssistantConnQueryMsg(), and DtNetAssistantConnQueryMsg::tcpPort.
Referenced by setForwardingParameters(), and setLRCParameters().
| void DtAssistantConnQueryMsg::setUdpPort | ( | int | port | ) | [protected, virtual] |
Set UDP port.
References netAssistantConnQueryMsg(), and DtNetAssistantConnQueryMsg::udpPort.
Referenced by setForwardingParameters(), and setLRCParameters().
| void DtAssistantConnQueryMsg::setUseRtiexec | ( | bool | val | ) | [protected, virtual] |
Set whether rtiexec should be used.
References netAssistantConnQueryMsg(), and DtNetAssistantConnQueryMsg::useRtiexec.
Referenced by setForwardingParameters(), and setLRCParameters().
| int DtAssistantConnQueryMsg::tcpPort | ( | ) | const [virtual] |
Get TCP port.
References netAssistantConnQueryMsg(), and DtNetAssistantConnQueryMsg::tcpPort.
Referenced by printData(), DtRtiAssistantClient::sendForwardingComponentConnQueryMsg(), and DtRtiAssistantClient::sendLRCConnQueryMsg().
| int DtAssistantConnQueryMsg::udpPort | ( | ) | const [virtual] |
Get UDP port.
References netAssistantConnQueryMsg(), and DtNetAssistantConnQueryMsg::udpPort.
Referenced by printData(), DtRtiAssistantClient::sendForwardingComponentConnQueryMsg(), and DtRtiAssistantClient::sendLRCConnQueryMsg().
| bool DtAssistantConnQueryMsg::useRtiexec | ( | ) | const [virtual] |
Get whether rtiexec should be used.
References netAssistantConnQueryMsg(), and DtNetAssistantConnQueryMsg::useRtiexec.
Referenced by printData(), and DtRtiAssistantClient::sendLRCConnQueryMsg().