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	tcpAddress () const
	Get TCP IP address (for reliable)
virtual int	tcpPort () const
	Get TCP port.
virtual MAKRti::DtInetAddr	tcpInterfaceAddress () const
	Get TCP interface address to be used.
virtual MAKRti::DtInetAddr	udpAddress () const
	Get UDP IP address (for best effort)
virtual int	udpPort () const
	Get UDP port.
virtual MAKRti::DtInetAddr	udpInterfaceAddress () const
	Get UDP interface address to be used.
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 const char *	connectionName () const
	The connection name.
virtual bool	ridIsPreconfigured () const
	Get whether the rid is preconfigured or not.
virtual const char *	ridConfiguration () const
	The RID as a set of lisp expressions.
virtual MAKRti::DtInetUtils::DtInetAddrFamily	addressFamily () const
	Get the address family.
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 void	printData () const
	Print the data section.
virtual void	setLRCParameters (const DtString &connectionName, bool isRidPreconfigured, const DtString &ridConfig, const DtInetAddr &tcpAddr, int tcpPort, const DtInetAddr &tcpIntfAddr, const DtInetAddr &udpAddr, int udpPort, const DtInetAddr &udpIntfAddr, int forwarderPort, bool useRtiExec, bool isForceFullCompliance, bool isAccepted)
virtual void	setForwardingParameters (const DtString &connectionName, bool isRidPreconfigured, const DtString &ridConfig, const DtInetAddr &tcpAddr, int tcpPort, const DtInetAddr &tcpIntfAddr, const DtInetAddr &udpAddr, int udpPort, const DtInetAddr &udpIntfAddr, const DtInetAddr &additionalForwarder, int forwarderPort, bool isFullyCompliant, bool isAccepted)
virtual void	setConnectionName (const MAKRti::DtString &name)
	The connection name.
virtual void	setRidIsPreconfigured (bool val)
	Set whether the rid is preconfigured or not.
virtual void	setRidConfiguration (const MAKRti::DtString &ridConfig)
	The RID as a set of lisp expressions.
virtual void	setError (bool val)
	Set whether this query is due to a connection error.
Public Member Functions inherited from DtAssistantMsg
virtual	~DtAssistantMsg ()
	Destructor.
virtual DtNetAssistantMsgHeader *	netHeader () const
	Get header of network representation.
virtual int	version () const
	Return the message version.
virtual bool	isValidVersion () const
	Returns bool: message version is valid?
virtual DtAssistantMsgKind	msgKind () const
	Get the message kind.
virtual void	print () const
	Printing functions.
virtual void	printHeader () const
virtual void	printSrcDest () const
virtual bool	isOk () const
	Message is good?
bool	isAssistantToAssistantMessage () const
	Returns whether or not this message contains source/destination information included in messages sent between assistants.
virtual MAKRti::DtInetAddr	sourceAddr () const
	Get/Set the IP address of the source of this message.
virtual void	setSourceAddr (const MAKRti::DtInetAddr &addr)
virtual int	sourceId () const
	Get/Set the ID of the source of this message.
virtual void	setSourceId (int id)
virtual MAKRti::DtString	sourceHost () const
	Get/Set the host name of the source of this message.
virtual void	setSourceHost (const MAKRti::DtString &addr)
virtual MAKRti::DtInetAddr	destAddr () const
	Get/Set the IP address of the destination of this message.
virtual void	setDestAddr (const MAKRti::DtInetAddr &addr)
virtual int	destId () const
	Get/Set the ID of the destination of this message.
virtual void	setDestId (int id)
virtual int	compId () const
	Get/Set the related component's connection ID.
virtual void	setCompId (int compId)
virtual const DtAssistantUuid &	sourceUuid () const
	Get/Set the uuid of the source of this message.
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.
virtual void	setIsForeign (bool isForeignDestination)
virtual DtU32	sequence () const
	Get/Set sequence number Assistant-to-Assistant messages only.
virtual void	setSequence (DtU32 sequenceNumber)

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)
Static Public Member Functions inherited from DtAssistantMsg
static const char *	kindToString (DtAssistantMsgKind kind)
	Returns the name of the message, by kind enumeration.

Protected Member Functions
virtual void	setTcpAddress (const MAKRti::DtInetAddr &ipAddress)
	Set TCP IP address.
virtual void	setTcpPort (int port)
	Set TCP port.
virtual void	setTcpInterfaceAddress (const MAKRti::DtInetAddr &address)
	Set local TCP interface address to be used.
virtual void	setUdpAddress (const MAKRti::DtInetAddr &ipAddress)
	Set UDP IP address.
virtual void	setUdpPort (int port)
	Set UDP port.
virtual void	setUdpInterfaceAddress (const MAKRti::DtInetAddr &address)
	Set local UDP interface address to be used.
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	setAddressFamily (MAKRti::DtInetUtils::DtInetAddrFamily addrFamily)
	Set address family (IPv6 or IPv4) which the is being used.
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 DtNetAssistantConnQueryMsg *	netAssistantConnQueryMsg ()
	The network representation.
virtual const DtNetAssistantConnQueryMsg *	netAssistantConnQueryMsg () const
	The network representation.
virtual DtAssistantMsgKind	internalMsgKind ()
	Returns the kind of a DtAssistantConnQueryMsg Msg.
virtual int	minSize () const
	Returns minimum size of a message, including header.
virtual void	setAdditionalForwarderSize (unsigned long size)
	Set the additional forwarder name size.
virtual unsigned long	additionalForwarderSize () const
	Get the additional forwarder name size.
virtual const char *	additionalForwarderPtr () const
	The const pointer to the additional forwarder name.
virtual char *	additionalForwarderPtr ()
	The pointer to the additional forwarder name.
virtual void	setConnectionNameSize (unsigned long size)
	Set the connection name size.
virtual unsigned long	connectionNameSize () const
	Get the connection name size.
virtual const char *	connectionNamePtr () const
	The const pointer to the connection name.
virtual char *	connectionNamePtr ()
	The pointer to the connection name.
virtual void	setRidConfigurationSize (unsigned long size)
	Set the RID Configuration size.
virtual unsigned long	ridConfigurationSize () const
	Get the RID Configuration size.
virtual const char *	ridConfigurationPtr () const
	The const pointer to the RID Configuration.
virtual char *	ridConfigurationPtr ()
	The pointer to the RID Configuration.
Protected Member Functions inherited from DtAssistantMsg
	DtAssistantMsg ()
	Constructor.
virtual void	sizeChanged (int size)
	Called whenever size is changed using changeSize, or insert/deleteBytes.
void	initAssistantMsg (int size, DtAssistantMsgKind msgKindVal, DtBufferPtr buffer)
	Called by ctor, so not virtual.
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.
virtual void	adjustBytes (void *address, int numBytes)
	Adjust the numBytes starting at the indicated address.
virtual void	resizeForSrcDestInfo ()
	Allocates memory at the end of the message for source/destination information needed when sending messages between assistants.
virtual const DtNetAssistantSrcDestInfo *	srcDestInfoPtr () const
	Return pointer to source/destination information in the message.
virtual DtNetAssistantSrcDestInfo *	srcDestInfoPtr ()
virtual void	setSourceHostSize (unsigned long size)
	Set/Get source host name text size.
virtual unsigned long	sourceHostSize () const
virtual const char *	sourceHostPtr () const
	Return pointer to source host name in message.
virtual char *	sourceHostPtr ()

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 )

Constructor.

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

Constructor.

virtual DtAssistantConnQueryMsg::~DtAssistantConnQueryMsg ( )

virtual

Destructor.

Member Function Documentation

static void DtAssistantConnQueryMsg::addCallback	(	DtRtiAssistantServer *	conn,
		DtAssistantConnQueryCb	cb,
		void *	usr
	)

static

Callback management.

static void DtAssistantConnQueryMsg::addCallback	(	DtAssistantMsgQueue *	queue,
		DtAssistantConnQueryCb	cb,
		void *	usr
	)

static

virtual MAKRti::DtInetAddr DtAssistantConnQueryMsg::additionalForwarderConnectionAddr ( ) const

virtual

The forwarding component should attempt to make an additional connection to the specified address.

virtual const char* DtAssistantConnQueryMsg::additionalForwarderPtr ( ) const

protectedvirtual

The const pointer to the additional forwarder name.

virtual char* DtAssistantConnQueryMsg::additionalForwarderPtr ( )

protectedvirtual

The pointer to the additional forwarder name.

virtual unsigned long DtAssistantConnQueryMsg::additionalForwarderSize ( ) const

protectedvirtual

Get the additional forwarder name size.

virtual MAKRti::DtInetUtils::DtInetAddrFamily DtAssistantConnQueryMsg::addressFamily ( ) const

virtual

Get the address family.

virtual DtAssistantMsg* DtAssistantConnQueryMsg::clone ( bool copy = true ) const

virtual

Return a copy/empty object of the same type as this.

Implements DtAssistantMsg.

virtual const char* DtAssistantConnQueryMsg::connectionName ( ) const

virtual

The connection name.

virtual const char* DtAssistantConnQueryMsg::connectionNamePtr ( ) const

protectedvirtual

The const pointer to the connection name.

virtual char* DtAssistantConnQueryMsg::connectionNamePtr ( )

protectedvirtual

The pointer to the connection name.

virtual unsigned long DtAssistantConnQueryMsg::connectionNameSize ( ) const

protectedvirtual

Get the connection name size.

static DtAssistantMsg* DtAssistantConnQueryMsg::create	(	const DtNetAssistantMsgHeader *	initial,
		DtBufferPtr	buffer = `DtUSE_INTERNAL_BUFFER`
	)

static

Creator.

static DtAssistantMsg* DtAssistantConnQueryMsg::create ( DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER )

static

Creator.

virtual bool DtAssistantConnQueryMsg::forceFullCompliance ( ) const

virtual

Get whether full compliance should be forced.

virtual int DtAssistantConnQueryMsg::forwarderPort ( ) const

virtual

The forwarding component should use the specified port for forwarder to forwarder connections.

virtual DtAssistantMsgKind DtAssistantConnQueryMsg::internalMsgKind ( )

protectedvirtual

Returns the kind of a DtAssistantConnQueryMsg Msg.

Implements DtAssistantMsg.

virtual bool DtAssistantConnQueryMsg::isAccepted ( ) const

virtual

Get whether query was accepted.

virtual bool DtAssistantConnQueryMsg::isAssistantToAssistant ( ) const

virtual

Get whether this is from an assistant to assistant client.

virtual bool DtAssistantConnQueryMsg::isError ( ) const

virtual

Get whether this query is due to a connection error.

virtual int DtAssistantConnQueryMsg::minSize ( ) const

protectedvirtual

Returns minimum size of a message, including header.

virtual DtNetAssistantConnQueryMsg* DtAssistantConnQueryMsg::netAssistantConnQueryMsg ( )

protectedvirtual

The network representation.

virtual const DtNetAssistantConnQueryMsg* DtAssistantConnQueryMsg::netAssistantConnQueryMsg ( ) const

protectedvirtual

The network representation.

virtual void DtAssistantConnQueryMsg::printData ( ) const

virtual

Print the data section.

Reimplemented from DtAssistantMsg.

static void DtAssistantConnQueryMsg::removeCallback	(	DtRtiAssistantServer *	conn,
		DtAssistantConnQueryCb	cb,
		void *	usr
	)

static

static void DtAssistantConnQueryMsg::removeCallback	(	DtAssistantMsgQueue *	queue,
		DtAssistantConnQueryCb	cb,
		void *	usr
	)

static

virtual const char* DtAssistantConnQueryMsg::ridConfiguration ( ) const

virtual

The RID as a set of lisp expressions.

virtual const char* DtAssistantConnQueryMsg::ridConfigurationPtr ( ) const

protectedvirtual

The const pointer to the RID Configuration.

virtual char* DtAssistantConnQueryMsg::ridConfigurationPtr ( )

protectedvirtual

The pointer to the RID Configuration.

virtual unsigned long DtAssistantConnQueryMsg::ridConfigurationSize ( ) const

protectedvirtual

Get the RID Configuration size.

virtual bool DtAssistantConnQueryMsg::ridIsPreconfigured ( ) const

virtual

Get whether the rid is preconfigured or not.

virtual void DtAssistantConnQueryMsg::setAccepted ( bool val )

protectedvirtual

Set whether query was accepted.

virtual void DtAssistantConnQueryMsg::setAdditionalForwarderConnectionAddr ( const MAKRti::DtInetAddr & addr )

protectedvirtual

The forwarding component should attempt to make an additional connection to the specified address.

virtual void DtAssistantConnQueryMsg::setAdditionalForwarderSize ( unsigned long size )

protectedvirtual

Set the additional forwarder name size.

Do not call directly (called from ::setAdditionalForwarderConnectionAddr(..)).

virtual void DtAssistantConnQueryMsg::setAddressFamily ( MAKRti::DtInetUtils::DtInetAddrFamily addrFamily )

protectedvirtual

Set address family (IPv6 or IPv4) which the is being used.

virtual void DtAssistantConnQueryMsg::setConnectionName ( const MAKRti::DtString & name )

virtual

The connection name.

virtual void DtAssistantConnQueryMsg::setConnectionNameSize ( unsigned long size )

protectedvirtual

Set the connection name size.

Do not call directly (called from ::setConnectionName(..)).

virtual void DtAssistantConnQueryMsg::setError ( bool val )

virtual

Set whether this query is due to a connection error.

virtual void DtAssistantConnQueryMsg::setForceFullCompliance ( bool val )

protectedvirtual

Set whether full compliance should be forced.

virtual void DtAssistantConnQueryMsg::setForwarderPort ( int port )

protectedvirtual

The forwarding component should use the specified port for forwarder to forwarder connections.

virtual void DtAssistantConnQueryMsg::setForwardingParameters	(	const DtString &	connectionName,
		bool	isRidPreconfigured,
		const DtString &	ridConfig,
		const DtInetAddr &	tcpAddr,
		int	tcpPort,
		const DtInetAddr &	tcpIntfAddr,
		const DtInetAddr &	udpAddr,
		int	udpPort,
		const DtInetAddr &	udpIntfAddr,
		const DtInetAddr &	additionalForwarder,
		int	forwarderPort,
		bool	isFullyCompliant,
		bool	isAccepted
	)

virtual

virtual void DtAssistantConnQueryMsg::setIsAssistantToAssistant ( bool yesNo )

virtual

Set whether this is from an assistant to assistant client.

virtual void DtAssistantConnQueryMsg::setLRCParameters	(	const DtString &	connectionName,
		bool	isRidPreconfigured,
		const DtString &	ridConfig,
		const DtInetAddr &	tcpAddr,
		int	tcpPort,
		const DtInetAddr &	tcpIntfAddr,
		const DtInetAddr &	udpAddr,
		int	udpPort,
		const DtInetAddr &	udpIntfAddr,
		int	forwarderPort,
		bool	useRtiExec,
		bool	isForceFullCompliance,
		bool	isAccepted
	)

virtual

virtual void DtAssistantConnQueryMsg::setRidConfiguration ( const MAKRti::DtString & ridConfig )

virtual

The RID as a set of lisp expressions.

virtual void DtAssistantConnQueryMsg::setRidConfigurationSize ( unsigned long size )

protectedvirtual

Set the RID Configuration size.

Do not call directly (called from ::setRidLisp(..)).

virtual void DtAssistantConnQueryMsg::setRidIsPreconfigured ( bool val )

virtual

Set whether the rid is preconfigured or not.

virtual void DtAssistantConnQueryMsg::setTcpAddress ( const MAKRti::DtInetAddr & ipAddress )

protectedvirtual

Set TCP IP address.

virtual void DtAssistantConnQueryMsg::setTcpInterfaceAddress ( const MAKRti::DtInetAddr & address )

protectedvirtual

Set local TCP interface address to be used.

virtual void DtAssistantConnQueryMsg::setTcpPort ( int port )

protectedvirtual

Set TCP port.

virtual void DtAssistantConnQueryMsg::setUdpAddress ( const MAKRti::DtInetAddr & ipAddress )

protectedvirtual

Set UDP IP address.

virtual void DtAssistantConnQueryMsg::setUdpInterfaceAddress ( const MAKRti::DtInetAddr & address )

protectedvirtual

Set local UDP interface address to be used.

virtual void DtAssistantConnQueryMsg::setUdpPort ( int port )

protectedvirtual

Set UDP port.

virtual void DtAssistantConnQueryMsg::setUseRtiexec ( bool val )

protectedvirtual

Set whether rtiexec should be used.

virtual MAKRti::DtInetAddr DtAssistantConnQueryMsg::tcpAddress ( ) const

virtual

Get TCP IP address (for reliable)

virtual MAKRti::DtInetAddr DtAssistantConnQueryMsg::tcpInterfaceAddress ( ) const

virtual

Get TCP interface address to be used.

virtual int DtAssistantConnQueryMsg::tcpPort ( ) const

virtual

Get TCP port.

virtual MAKRti::DtInetAddr DtAssistantConnQueryMsg::udpAddress ( ) const

virtual

Get UDP IP address (for best effort)

virtual MAKRti::DtInetAddr DtAssistantConnQueryMsg::udpInterfaceAddress ( ) const

virtual

Get UDP interface address to be used.

virtual int DtAssistantConnQueryMsg::udpPort ( ) const

virtual

Get UDP port.

virtual bool DtAssistantConnQueryMsg::useRtiexec ( ) const

virtual

Get whether rtiexec should be used.

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

assistantConnQueryMsg.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation