The DtAssistantShmCompInfoMsg defines a wrapper for the RTI Assistant component information message used to send information about an Shm component to its connected RTI Assistant. More...

Inheritance diagram for DtAssistantShmCompInfoMsg:

Collaboration diagram for DtAssistantShmCompInfoMsg:

Public Member Functions
	DtAssistantShmCompInfoMsg (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Constructors.
	DtAssistantShmCompInfoMsg (const DtNetAssistantShmCompInfoMsg *netRep, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
virtual	~DtAssistantShmCompInfoMsg ()
	Destructor.
virtual DtAssistantMsg *	clone (bool copy=true) const
	Return a copy/empty object of the same type as this.
virtual void	setIpAddress (const MAKRti::DtInetAddr &ipAddr)
	Set Shm's forwarder IP address.
virtual MAKRti::DtInetAddr	ipAddress () const
	Get Shm's forwarder IP address.
virtual void	setPort (int port)
	Set Shm's forwarder port number.
virtual int	port () const
	Get Shm's forwarder port number.
virtual void	setLogFilename (const MAKRti::DtFilename &filename)
	Set component log filename.
virtual MAKRti::DtFilename	logFilename () const
	Get component log filename.
virtual void	setNotifyLevel (DtNotifyLevelType level)
	Set notify level.
virtual DtNotifyLevelType	notifyLevel () const
	Get notify level.
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, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Creators.
static DtAssistantMsg *	create (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
static void	addCallback (DtRtiAssistantServer conn, DtAssistantShmCompInfoCb cb, void usr)
	Adds or removes a callback with the given Assistant server for this message type.
static void	removeCallback (DtRtiAssistantServer conn, DtAssistantShmCompInfoCb 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 DtNetAssistantShmCompInfoMsg *	netAssistantShmCompInfoMsg ()
	The network representation for the component information.
virtual const DtNetAssistantShmCompInfoMsg *	netAssistantShmCompInfoMsg () const
virtual DtAssistantMsgKind	internalMsgKind ()
	Returns the kind of a DtAssistantShmCompInfoMsg message.
virtual int	minSize () const
	Returns minimum size of a message, including header.
virtual void	setLogFilenameSize (unsigned long size)
	Set/Get log filename size.
virtual unsigned long	logFilenameSize () const
virtual const char *	logFilenamePtr () const
	Return pointer to component name location in message.
virtual char *	logFilenamePtr ()
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 DtAssistantShmCompInfoMsg defines a wrapper for the RTI Assistant component information message used to send information about an Shm component to its connected RTI Assistant.

Constructor & Destructor Documentation

DtAssistantShmCompInfoMsg::DtAssistantShmCompInfoMsg ( DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER )

Constructors.

DtAssistantShmCompInfoMsg::DtAssistantShmCompInfoMsg	(	const DtNetAssistantShmCompInfoMsg *	netRep,
		DtBufferPtr	buffer = `DtUSE_INTERNAL_BUFFER`
	)

virtual DtAssistantShmCompInfoMsg::~DtAssistantShmCompInfoMsg ( )

virtual

Destructor.

Member Function Documentation

static void DtAssistantShmCompInfoMsg::addCallback	(	DtRtiAssistantServer *	conn,
		DtAssistantShmCompInfoCb	cb,
		void *	usr
	)

static

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

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

protectedvirtual

Get the IP address family.

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

virtual

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

Implements DtAssistantMsg.

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

static

Creators.

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

static

virtual DtAssistantMsgKind DtAssistantShmCompInfoMsg::internalMsgKind ( )

protectedvirtual

Returns the kind of a DtAssistantShmCompInfoMsg message.

Implements DtAssistantMsg.

virtual MAKRti::DtInetAddr DtAssistantShmCompInfoMsg::ipAddress ( ) const

virtual

Get Shm's forwarder IP address.

virtual MAKRti::DtFilename DtAssistantShmCompInfoMsg::logFilename ( ) const

virtual

Get component log filename.

virtual const char* DtAssistantShmCompInfoMsg::logFilenamePtr ( ) const

protectedvirtual

Return pointer to component name location in message.

virtual char* DtAssistantShmCompInfoMsg::logFilenamePtr ( )

protectedvirtual

virtual unsigned long DtAssistantShmCompInfoMsg::logFilenameSize ( ) const

protectedvirtual

virtual int DtAssistantShmCompInfoMsg::minSize ( ) const

protectedvirtual

Returns minimum size of a message, including header.

virtual DtNetAssistantShmCompInfoMsg* DtAssistantShmCompInfoMsg::netAssistantShmCompInfoMsg ( )

protectedvirtual

The network representation for the component information.

virtual const DtNetAssistantShmCompInfoMsg* DtAssistantShmCompInfoMsg::netAssistantShmCompInfoMsg ( ) const

protectedvirtual

virtual DtNotifyLevelType DtAssistantShmCompInfoMsg::notifyLevel ( ) const

virtual

Get notify level.

virtual int DtAssistantShmCompInfoMsg::port ( ) const

virtual

Get Shm's forwarder port number.

virtual void DtAssistantShmCompInfoMsg::printData ( ) const

virtual

Print the data section.

Reimplemented from DtAssistantMsg.

static void DtAssistantShmCompInfoMsg::removeCallback	(	DtRtiAssistantServer *	conn,
		DtAssistantShmCompInfoCb	cb,
		void *	usr
	)

static

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

protectedvirtual

Set the IP address family.

virtual void DtAssistantShmCompInfoMsg::setIpAddress ( const MAKRti::DtInetAddr & ipAddr )

virtual

Set Shm's forwarder IP address.

virtual void DtAssistantShmCompInfoMsg::setLogFilename ( const MAKRti::DtFilename & filename )

virtual

Set component log filename.

virtual void DtAssistantShmCompInfoMsg::setLogFilenameSize ( unsigned long size )

protectedvirtual

Set/Get log filename size.

virtual void DtAssistantShmCompInfoMsg::setNotifyLevel ( DtNotifyLevelType level )

virtual

Set notify level.

virtual void DtAssistantShmCompInfoMsg::setPort ( int port )

virtual

Set Shm's forwarder port number.

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

assistantShmCompInfoMsg.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation