DtAssistantStartRtiexecMsg Class Reference

The DtAssistantStartRtiexecMsg defines a wrapper for the RTI Assistant message used to instruct another Assistant to start a new rtiexec. More...

Inheritance diagram for DtAssistantStartRtiexecMsg:

Collaboration diagram for DtAssistantStartRtiexecMsg:

Public Member Functions
	DtAssistantStartRtiexecMsg (MAKRti::DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Constructors.
	DtAssistantStartRtiexecMsg (const DtNetAssistantStartRtiexecMsg *netRep, MAKRti::DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
virtual	~DtAssistantStartRtiexecMsg ()
	Destructor.
virtual DtAssistantMsg *	clone (bool copy=true) const
	Return a copy/empty object of the same type as this.
virtual void	setReliableIpAddress (const MAKRti::DtInetAddr &ipAddr)
	Set rtiexec's reliable IP address.
virtual MAKRti::DtInetAddr	reliableIpAddress () const
	Get rtiexec's reliable IP address.
virtual void	setBestEffortIpAddress (const MAKRti::DtInetAddr &ipAddr)
	Set rtiexec's best effort IP address.
virtual MAKRti::DtInetAddr	bestEffortIpAddress () const
	Get rtiexec's best effort IP address.
virtual void	setUdpPort (int port)
	Set rtiexec's UDP port number.
virtual int	udpPort () const
	Get rtiexec's UDP port number.
virtual void	setTcpPort (int port)
	Set rtiexec's TCP port number.
virtual int	tcpPort () const
	Get rtiexec's TCP port number.
virtual void	setForwarderPort (int port)
	Set the forwarder port.
virtual int	forwarderPort () const
	Get the forwarder port.
virtual void	setForwarderToConnectTo (const MAKRti::DtInetAddr &ipAddr)
	Set another forwarder for the forwarder to connect to.
virtual MAKRti::DtInetAddr	forwarderToConnectTo () const
	Get the other forwarder for the forwarder to connect to.
virtual void	setFullCompliance (bool val)
	Set the flag indicating if rtiexec is running with full compliance.
virtual bool	fullCompliance () const
	Get the flag indicating if rtiexec is running with full compliance.
virtual void	setConnectionName (const MAKRti::DtString &name)
	Set the connection name.
virtual MAKRti::DtString	connectionName () const
	Get the connection name.
virtual void	printData () const
	Print the data section.
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 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)

Static Public Member Functions
static DtAssistantMsg *	create (const DtNetAssistantMsgHeader *initial, MAKRti::DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Creators.
static DtAssistantMsg *	create (MAKRti::DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
static void	addCallback (DtRtiAssistantPeer *conn, DtAssistantStartRtiexecCb cb, void *usr)
	Adds or removes a callback with the given Assistant server for this message type.
static void	removeCallback (DtRtiAssistantPeer *conn, DtAssistantStartRtiexecCb 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	setAddressFamily (MAKRti::DtInetUtils::DtInetAddrFamily fam)
	Set the IP address family.
virtual MAKRti::DtInetUtils::DtInetAddrFamily	addressFamily () const
	Get the IP address family.
virtual DtNetAssistantStartRtiexecMsg *	netAssistantStartRtiexecMsg ()
	The network representation for the start rtiexec message.
virtual const DtNetAssistantStartRtiexecMsg *	netAssistantStartRtiexecMsg () const
virtual DtAssistantMsgKind	internalMsgKind ()
	Returns the kind of a DtAssistantStartRtiexecMsg message.
virtual int	minSize () const
	Returns minimum size of a message, including header.
virtual void	setConnectionNameSize (unsigned size)
	Set connection name size.
virtual unsigned	connectionNameSize () const
	Get connection name size.
virtual const char *	connectionNamePtr () const
	Return pointer to connection name location in message.
virtual char *	connectionNamePtr ()
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 DtAssistantStartRtiexecMsg defines a wrapper for the RTI Assistant message used to instruct another Assistant to start a new rtiexec.

Constructor & Destructor Documentation

DtAssistantStartRtiexecMsg::DtAssistantStartRtiexecMsg

(

MAKRti::DtBufferPtr

buffer = DtUSE_INTERNAL_BUFFER

)

Constructors.

DtAssistantStartRtiexecMsg::DtAssistantStartRtiexecMsg	(	const DtNetAssistantStartRtiexecMsg *	netRep,
		MAKRti::DtBufferPtr	buffer = DtUSE_INTERNAL_BUFFER
	)

virtual DtAssistantStartRtiexecMsg::~DtAssistantStartRtiexecMsg ( )

virtual

Destructor.

Member Function Documentation

static void DtAssistantStartRtiexecMsg::addCallback ( DtRtiAssistantPeer *  conn, DtAssistantStartRtiexecCb  cb, void *  usr  )

static

Adds or removes a callback with the given Assistant server for this message type.

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

protectedvirtual

Get the IP address family.

virtual MAKRti::DtInetAddr DtAssistantStartRtiexecMsg::bestEffortIpAddress ( ) const

virtual

Get rtiexec's best effort IP address.

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

virtual

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

Implements DtAssistantMsg.

virtual MAKRti::DtString DtAssistantStartRtiexecMsg::connectionName ( ) const

virtual

Get the connection name.

virtual const char* DtAssistantStartRtiexecMsg::connectionNamePtr ( ) const

protectedvirtual

Return pointer to connection name location in message.

virtual char* DtAssistantStartRtiexecMsg::connectionNamePtr ( )

protectedvirtual

virtual unsigned DtAssistantStartRtiexecMsg::connectionNameSize ( ) const

protectedvirtual

Get connection name size.

static DtAssistantMsg* DtAssistantStartRtiexecMsg::create ( const DtNetAssistantMsgHeader *  initial, MAKRti::DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER  )

static

Creators.

static DtAssistantMsg* DtAssistantStartRtiexecMsg::create ( MAKRti::DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER )

static

virtual int DtAssistantStartRtiexecMsg::forwarderPort ( ) const

virtual

Get the forwarder port.

virtual MAKRti::DtInetAddr DtAssistantStartRtiexecMsg::forwarderToConnectTo ( ) const

virtual

Get the other forwarder for the forwarder to connect to.

virtual bool DtAssistantStartRtiexecMsg::fullCompliance ( ) const

virtual

Get the flag indicating if rtiexec is running with full compliance.

virtual DtAssistantMsgKind DtAssistantStartRtiexecMsg::internalMsgKind ( )

protectedvirtual

Returns the kind of a DtAssistantStartRtiexecMsg message.

Implements DtAssistantMsg.

virtual int DtAssistantStartRtiexecMsg::minSize ( ) const

protectedvirtual

Returns minimum size of a message, including header.

virtual DtNetAssistantStartRtiexecMsg* DtAssistantStartRtiexecMsg::netAssistantStartRtiexecMsg ( )

protectedvirtual

The network representation for the start rtiexec message.

virtual const DtNetAssistantStartRtiexecMsg* DtAssistantStartRtiexecMsg::netAssistantStartRtiexecMsg ( ) const

protectedvirtual

virtual void DtAssistantStartRtiexecMsg::printData ( ) const

virtual

Print the data section.

Reimplemented from DtAssistantMsg.

virtual MAKRti::DtInetAddr DtAssistantStartRtiexecMsg::reliableIpAddress ( ) const

virtual

Get rtiexec's reliable IP address.

static void DtAssistantStartRtiexecMsg::removeCallback ( DtRtiAssistantPeer *  conn, DtAssistantStartRtiexecCb  cb, void *  usr  )

static

virtual void DtAssistantStartRtiexecMsg::setAddressFamily ( MAKRti::DtInetUtils::DtInetAddrFamily  fam )

protectedvirtual

Set the IP address family.

virtual void DtAssistantStartRtiexecMsg::setBestEffortIpAddress ( const MAKRti::DtInetAddr &  ipAddr )

virtual

Set rtiexec's best effort IP address.

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

virtual

Set the connection name.

virtual void DtAssistantStartRtiexecMsg::setConnectionNameSize ( unsigned  size )

protectedvirtual

Set connection name size.

virtual void DtAssistantStartRtiexecMsg::setForwarderPort ( int  port )

virtual

Set the forwarder port.

virtual void DtAssistantStartRtiexecMsg::setForwarderToConnectTo ( const MAKRti::DtInetAddr &  ipAddr )

virtual

Set another forwarder for the forwarder to connect to.

virtual void DtAssistantStartRtiexecMsg::setFullCompliance ( bool  val )

virtual

Set the flag indicating if rtiexec is running with full compliance.

virtual void DtAssistantStartRtiexecMsg::setReliableIpAddress ( const MAKRti::DtInetAddr &  ipAddr )

virtual

Set rtiexec's reliable IP address.

virtual void DtAssistantStartRtiexecMsg::setTcpPort ( int  port )

virtual

Set rtiexec's TCP port number.

virtual void DtAssistantStartRtiexecMsg::setUdpPort ( int  port )

virtual

Set rtiexec's UDP port number.

virtual int DtAssistantStartRtiexecMsg::tcpPort ( ) const

virtual

Get rtiexec's TCP port number.

virtual int DtAssistantStartRtiexecMsg::udpPort ( ) const

virtual

Get rtiexec's UDP port number.

---

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

• assistantStartRtiexecMsg.h