DtAssistantLatencyReportMsg Class Reference

The DtAssistantLatencyReportMsg defines a msg for a client to report the results of a latency test. More...

Inheritance diagram for DtAssistantLatencyReportMsg:

Collaboration diagram for DtAssistantLatencyReportMsg:

Public Member Functions
	DtAssistantLatencyReportMsg (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Constructors.
	DtAssistantLatencyReportMsg (const DtAveragedLatencyTestReport &rep, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	DtAssistantLatencyReportMsg (const DtNetAssistantLatencyReportMsg *netRepMsg, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
virtual	~DtAssistantLatencyReportMsg ()
	Destructor.
virtual DtAssistantMsg *	clone (bool copy=true) const
	Return a copy/empty object of the same type as this.
virtual void	printData () const
	Print the data section.
virtual void	resize (unsigned int payLoadSize)
	Resize the payload size.
virtual unsigned char *	payload ()
	dataPointer to the payload.
virtual const unsigned char *	payload () const
	dataPointer to the payload.
virtual unsigned int	totalSize () const
	What is the total size of the payload?
virtual void	setTotalSize (unsigned int times)
	setTotal Size of the payload.
virtual void	get (DtAveragedLatencyTestReport &report) const
	Decode msg data into input latency test report.
virtual void	set (const DtAveragedLatencyTestReport &report)
	Encode report into message data.
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)
	Creators.
static DtAssistantMsg *	create (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
static void	addCallback (DtRtiAssistantServer *conn, DtAssistantLatencyReportCb cb, void *usr)
	Adds or removes a callback with the given Assistant client for this message type.
static void	removeCallback (DtRtiAssistantServer *conn, DtAssistantLatencyReportCb cb, void *usr)
static void	addCallback (DtRtiAssistantPeer *conn, DtAssistantLatencyReportCb cb, void *usr)
	Adds or removes a callback with the given Assistant peer for this message type.
static void	removeCallback (DtRtiAssistantPeer *conn, DtAssistantLatencyReportCb 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 DtNetAssistantLatencyReportMsg *	netAssistantLatencyReportMsg ()
	The network representation for the AssistantLatencyReportMsg message.
virtual const DtNetAssistantLatencyReportMsg *	netAssistantLatencyReportMsg () const
virtual DtAssistantMsgKind	internalMsgKind ()
	Returns the kind of a DtAssistantLatencyReportMsg message.
virtual int	minSize () const
	Returns minimum size of a message, including header.
virtual unsigned char *	timesPtr () const
	Returns pointer to the times in the netMsg.
virtual void	setTime (DtAssistantReportTimeStampType type, unsigned int time)
	Add a time to the message.
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 DtAssistantLatencyReportMsg defines a msg for a client to report the results of a latency test.

Constructor & Destructor Documentation

DtAssistantLatencyReportMsg::DtAssistantLatencyReportMsg

(

DtBufferPtr

buffer = DtUSE_INTERNAL_BUFFER

)

Constructors.

DtAssistantLatencyReportMsg::DtAssistantLatencyReportMsg	(	const DtAveragedLatencyTestReport &	rep,
		DtBufferPtr	buffer = DtUSE_INTERNAL_BUFFER
	)

DtAssistantLatencyReportMsg::DtAssistantLatencyReportMsg	(	const DtNetAssistantLatencyReportMsg *	netRepMsg,
		DtBufferPtr	buffer = DtUSE_INTERNAL_BUFFER
	)

virtual DtAssistantLatencyReportMsg::~DtAssistantLatencyReportMsg ( )

virtual

Destructor.

Member Function Documentation

static void DtAssistantLatencyReportMsg::addCallback ( DtRtiAssistantServer *  conn, DtAssistantLatencyReportCb  cb, void *  usr  )

static

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

static void DtAssistantLatencyReportMsg::addCallback ( DtRtiAssistantPeer *  conn, DtAssistantLatencyReportCb  cb, void *  usr  )

static

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

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

virtual

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

Implements DtAssistantMsg.

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

static

Creators.

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

static

virtual void DtAssistantLatencyReportMsg::get ( DtAveragedLatencyTestReport &  report ) const

virtual

Decode msg data into input latency test report.

virtual DtAssistantMsgKind DtAssistantLatencyReportMsg::internalMsgKind ( )

protectedvirtual

Returns the kind of a DtAssistantLatencyReportMsg message.

Implements DtAssistantMsg.

virtual int DtAssistantLatencyReportMsg::minSize ( ) const

protectedvirtual

Returns minimum size of a message, including header.

virtual DtNetAssistantLatencyReportMsg* DtAssistantLatencyReportMsg::netAssistantLatencyReportMsg ( )

protectedvirtual

The network representation for the AssistantLatencyReportMsg message.

virtual const DtNetAssistantLatencyReportMsg* DtAssistantLatencyReportMsg::netAssistantLatencyReportMsg ( ) const

protectedvirtual

virtual unsigned char* DtAssistantLatencyReportMsg::payload ( )

virtual

dataPointer to the payload.

virtual const unsigned char* DtAssistantLatencyReportMsg::payload ( ) const

virtual

dataPointer to the payload.

virtual void DtAssistantLatencyReportMsg::printData ( ) const

virtual

Print the data section.

Reimplemented from DtAssistantMsg.

static void DtAssistantLatencyReportMsg::removeCallback ( DtRtiAssistantServer *  conn, DtAssistantLatencyReportCb  cb, void *  usr  )

static

static void DtAssistantLatencyReportMsg::removeCallback ( DtRtiAssistantPeer *  conn, DtAssistantLatencyReportCb  cb, void *  usr  )

static

virtual void DtAssistantLatencyReportMsg::resize ( unsigned int  payLoadSize )

virtual

Resize the payload size.

virtual void DtAssistantLatencyReportMsg::set ( const DtAveragedLatencyTestReport &  report )

virtual

Encode report into message data.

virtual void DtAssistantLatencyReportMsg::setTime ( DtAssistantReportTimeStampType  type, unsigned int  time  )

protectedvirtual

Add a time to the message.

virtual void DtAssistantLatencyReportMsg::setTotalSize ( unsigned int  times )

virtual

setTotal Size of the payload.

virtual unsigned char* DtAssistantLatencyReportMsg::timesPtr ( ) const

protectedvirtual

Returns pointer to the times in the netMsg.

virtual unsigned int DtAssistantLatencyReportMsg::totalSize ( ) const

virtual

What is the total size of the payload?

---

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

• assistantLatencyReportMsg.h