The DtAssistantLogMsg defines a wrapper for the RTI Assistant log message used to send a full log from an rtiexec to an Assistant for display. More...

Inheritance diagram for DtAssistantLogMsg:

Collaboration diagram for DtAssistantLogMsg:

Public Member Functions
	DtAssistantLogMsg (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Constructors.
	DtAssistantLogMsg (const DtNetAssistantLogMsg *netRep, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
virtual	~DtAssistantLogMsg ()
	Destructor.
virtual DtAssistantMsg *	clone (bool copy=true) const
	Return a copy/empty object of the same type as this.
virtual void	setLog (const DtLogEntryList &log, unsigned maxSize)
	Set log.
virtual const char *	nextEntry (DtNotifyLevelType &notifyLevel) const
	Returns a pointer to the next entry and fills in its notify level.
virtual unsigned	textSize () const
	Get total size of text.
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, DtAssistantLogCb cb, void usr)
	Adds or removes a callback with the given Assistant server for this message type.
static void	removeCallback (DtRtiAssistantServer conn, DtAssistantLogCb cb, void usr)
static void	addCallback (DtRtiAssistantPeer conn, DtAssistantLogCb cb, void usr)
	Adds or removes a callback with the given Assistant peer for this message type.
static void	removeCallback (DtRtiAssistantPeer conn, DtAssistantLogCb 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 DtNetAssistantLogMsg *	netAssistantLogMsg ()
	The network representation for the notify message.
virtual const DtNetAssistantLogMsg *	netAssistantLogMsg () const
virtual DtAssistantMsgKind	internalMsgKind ()
	Returns the kind of a DtAssistantLogMsg message.
virtual int	minSize () const
	Returns minimum size of a message, including header.
virtual void	setTextSize (unsigned size)
	Set total size of text.
virtual void	setNumEntries (unsigned num)
	Set/Get number of log entries.
virtual unsigned	numEntries () const
virtual const DtNetU8 *	notifyLevelPtr () const
	Return pointer to notify levels location in message.
virtual DtNetU8 *	notifyLevelPtr ()
virtual const char *	textPtr () const
	Return pointer to text location in message.
virtual char *	textPtr ()
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 ()

Protected Attributes
const char *	myNextTextPtr
	The next text location to read from the message.
unsigned	myNextNum
	The next entry to read from the message.

Detailed Description

The DtAssistantLogMsg defines a wrapper for the RTI Assistant log message used to send a full log from an rtiexec to an Assistant for display.

RTI Assistant.

Constructor & Destructor Documentation

DtAssistantLogMsg::DtAssistantLogMsg ( DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER )

Constructors.

References DtAssistantMsg::initAssistantMsg(), internalMsgKind(), and minSize().

Referenced by clone(), and create().

DtAssistantLogMsg::DtAssistantLogMsg	(	const DtNetAssistantLogMsg *	netRep,
		DtBufferPtr	buffer = `DtUSE_INTERNAL_BUFFER`
	)

References DtNetAssistantLogMsg::header, and DtAssistantMsg::initAssistantMsg().

DtAssistantLogMsg::~DtAssistantLogMsg ( )

virtual

Destructor.

Member Function Documentation

void DtAssistantLogMsg::addCallback	(	DtRtiAssistantServer *	conn,
		DtAssistantLogCb	cb,
		void *	usr
	)

static

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

References DtRtiAssistantServer::addMsgCallback(), and DtAssistantLogMsgKind.

Referenced by DtAssistantFederationsInfoMgr::DtAssistantFederationsInfoMgr().

void DtAssistantLogMsg::addCallback	(	DtRtiAssistantPeer *	conn,
		DtAssistantLogCb	cb,
		void *	usr
	)

static

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

References DtRtiAssistantPeer::addMsgCallback(), and DtAssistantLogMsgKind.

DtAssistantMsg * DtAssistantLogMsg::clone ( bool copy = true ) const

virtual

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

Implements DtAssistantMsg.

References DtAssistantLogMsg(), and netAssistantLogMsg().

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

static

Creators.

References DtAssistantLogMsg().

DtAssistantMsg * DtAssistantLogMsg::create ( DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER )

static

References DtAssistantLogMsg().

DtAssistantMsgKind DtAssistantLogMsg::internalMsgKind ( )

protectedvirtual

Returns the kind of a DtAssistantLogMsg message.

Implements DtAssistantMsg.

References DtAssistantLogMsgKind.

Referenced by DtAssistantLogMsg().

int DtAssistantLogMsg::minSize ( ) const

protectedvirtual

Returns minimum size of a message, including header.

Referenced by DtAssistantLogMsg(), and setLog().

DtNetAssistantLogMsg * DtAssistantLogMsg::netAssistantLogMsg ( )

protectedvirtual

The network representation for the notify message.

Referenced by clone(), notifyLevelPtr(), numEntries(), setNumEntries(), setTextSize(), and textSize().

const DtNetAssistantLogMsg * DtAssistantLogMsg::netAssistantLogMsg ( ) const

protectedvirtual

const char * DtAssistantLogMsg::nextEntry ( DtNotifyLevelType & notifyLevel ) const

virtual

Returns a pointer to the next entry and fills in its notify level.

Returns 0 if there are no more entries.

References myNextNum, myNextTextPtr, notifyLevelPtr(), numEntries(), and textPtr().

const DtNetU8 * DtAssistantLogMsg::notifyLevelPtr ( ) const

protectedvirtual

Return pointer to notify levels location in message.

References netAssistantLogMsg().

Referenced by nextEntry(), setLog(), and textPtr().

DtNetU8 * DtAssistantLogMsg::notifyLevelPtr ( )

protectedvirtual

References netAssistantLogMsg().

unsigned DtAssistantLogMsg::numEntries ( ) const

protectedvirtual

References netAssistantLogMsg(), and DtNetAssistantLogMsg::numEntries.

Referenced by nextEntry(), printData(), setLog(), and textPtr().

void DtAssistantLogMsg::printData ( ) const

virtual

Print the data section.

Reimplemented from DtAssistantMsg.

References numEntries().

void DtAssistantLogMsg::removeCallback	(	DtRtiAssistantServer *	conn,
		DtAssistantLogCb	cb,
		void *	usr
	)

static

References DtAssistantLogMsgKind, and DtRtiAssistantServer::removeMsgCallback().

Referenced by DtAssistantFederationsInfoMgr::~DtAssistantFederationsInfoMgr().

void DtAssistantLogMsg::removeCallback	(	DtRtiAssistantPeer *	conn,
		DtAssistantLogCb	cb,
		void *	usr
	)

static

References DtAssistantLogMsgKind, and DtRtiAssistantPeer::removeMsgCallback().

void DtAssistantLogMsg::setLog	(	const DtLogEntryList &	log,
		unsigned	maxSize
	)

virtual

Set log.

References rti1516e::insertBytes(), minSize(), notifyLevelPtr(), numEntries(), setNumEntries(), setTextSize(), textPtr(), and textSize().

Referenced by DtRtiAssistantExecClient::sendLogMsg().

void DtAssistantLogMsg::setNumEntries ( unsigned num )

protectedvirtual

Set/Get number of log entries.

References netAssistantLogMsg(), and DtNetAssistantLogMsg::numEntries.

Referenced by setLog().

void DtAssistantLogMsg::setTextSize ( unsigned size )

protectedvirtual

Set total size of text.

References netAssistantLogMsg(), and DtNetAssistantLogMsg::textSize.

Referenced by setLog().

const char * DtAssistantLogMsg::textPtr ( ) const

protectedvirtual

Return pointer to text location in message.

References notifyLevelPtr(), and numEntries().

Referenced by nextEntry(), and setLog().

char * DtAssistantLogMsg::textPtr ( )

protectedvirtual

References notifyLevelPtr(), and numEntries().

unsigned DtAssistantLogMsg::textSize ( ) const

virtual

Get total size of text.

References netAssistantLogMsg(), and DtNetAssistantLogMsg::textSize.

Referenced by setLog().

Member Data Documentation

unsigned DtAssistantLogMsg::myNextNum

mutableprotected

The next entry to read from the message.

Referenced by nextEntry().

const char* DtAssistantLogMsg::myNextTextPtr

mutableprotected

The next text location to read from the message.

Referenced by nextEntry().

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation