MAK RTIspy API Documentation for HLA 1516
Public Member Functions | Static Public Member Functions | Protected Member Functions
DtAssistantConnQueryMsg Class Reference

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:

List of all members.

Public Member Functions

 DtAssistantConnQueryMsg (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 Constructor.
 DtAssistantConnQueryMsg (const DtNetAssistantConnQueryMsg *netRep, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 Constructor.
virtual ~DtAssistantConnQueryMsg ()
 Destructor.
virtual DtAssistantMsgclone (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 DtAssistantMsgcreate (const DtNetAssistantMsgHeader *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 Creator.
static DtAssistantMsgcreate (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.

Detailed Description

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.


Constructor & Destructor Documentation

DtAssistantConnQueryMsg::DtAssistantConnQueryMsg ( DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER)
DtAssistantConnQueryMsg::DtAssistantConnQueryMsg ( const DtNetAssistantConnQueryMsg netRep,
DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER 
)

Destructor.


Member Function Documentation

void DtAssistantConnQueryMsg::addCallback ( DtRtiAssistantServer conn,
DtAssistantConnQueryCb  cb,
void *  usr 
) [static]
void DtAssistantConnQueryMsg::addCallback ( DtAssistantMsgQueue queue,
DtAssistantConnQueryCb  cb,
void *  usr 
) [static]

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]
char * DtAssistantConnQueryMsg::additionalForwarderPtr ( ) [protected, virtual]
unsigned long DtAssistantConnQueryMsg::additionalForwarderSize ( ) const [protected, virtual]
MAKRti::DtInetUtils::DtInetAddrFamily DtAssistantConnQueryMsg::addressFamily ( ) const [virtual]

Get the address family.

References netAssistantConnQueryMsg().

Referenced by bestEffortIpAddress(), networkInterfaceAddress(), and reliableIpAddress().

DtInetAddr DtAssistantConnQueryMsg::bestEffortIpAddress ( ) const [virtual]
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().

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().

Returns the kind of a DtAssistantConnQueryMsg Msg.

Implements DtAssistantMsg.

References DtAssistantConnQueryMsgKind.

Referenced by DtAssistantConnQueryMsg().

Get whether this is from an assistant to assistant client.

References DtNetAssistantConnQueryMsg::assistant, and netAssistantConnQueryMsg().

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().

DtInetAddr DtAssistantConnQueryMsg::networkInterfaceAddress ( ) const [virtual]
void DtAssistantConnQueryMsg::printData ( ) const [virtual]
DtInetAddr DtAssistantConnQueryMsg::reliableIpAddress ( ) const [virtual]
void DtAssistantConnQueryMsg::removeCallback ( DtAssistantMsgQueue queue,
DtAssistantConnQueryCb  cb,
void *  usr 
) [static]
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]
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]
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]

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]
void DtAssistantConnQueryMsg::setTcpPort ( int  port) [protected, virtual]
void DtAssistantConnQueryMsg::setUdpPort ( int  port) [protected, virtual]
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]
int DtAssistantConnQueryMsg::udpPort ( ) const [virtual]

The documentation for this class was generated from the following files:

Document ID: Generated on Thu Jun 14 14:15:04 EDT 2012 from SVN revision 116116
Copyright © 2005-2012 VT MÄK Inc. All Rights Reserved (www.mak.com)