DtLatencyReportMsg Class Reference

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

Inheritance diagram for DtLatencyReportMsg:

Collaboration diagram for DtLatencyReportMsg:

Public Member Functions
	DtLatencyReportMsg (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Constructors.
	DtLatencyReportMsg (const DtAveragedLatencyTestReport &rep, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	DtLatencyReportMsg (const DtNetLatencyReportMsg *netRepMsg, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
virtual	~DtLatencyReportMsg ()
	Destructor.
virtual DtRtiMsg *	clone (bool copy=true) const
	Return a copy/empty object of the same type as this.
virtual void	printData (DtLogicalTimeFactory *logicalTimeFactory) 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 DtRtiMsg
virtual	~DtRtiMsg ()
	Destructor.
virtual DtRtiMsg *	cloneWithTransport (bool copy=true) const
	Return a copy/empty object of the same type as this using clone and set the transport type from the host message.
virtual DtNetMsgHeader *	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 void	setFedEx (const MAKRti::DtString &name)
	All RTI messages contain information to identify which federation execution the message applies to.
virtual void	setFedEx (int handle)
	Set federation execution identifier as a handle.
virtual bool	isForExec (const MAKRti::DtString &execName, int execHandle) const
	Returns true if the current message belongs to the indicated federation execution, false otherwise.
virtual DtRtiMsgKind	msgKind () const
	Get the message kind.
virtual const char *	kindString () const
	Returns the message kind string name.
virtual bool	isConstrained () const
	Return boolean: message type can be time constrained?
virtual bool	isAllowedDuringSave () const
	Return boolean: message type can be processed during save?
virtual void	setTime (const RTI::FedTime &time)
	Set/Get time Used in timestamped messages.
virtual RTI::FedTime const *	time (DtLogicalTimeFactory *fedTimeFactory) const
virtual bool	hasTime () const
	Returns true if time field is valid.
virtual void	setSerialNumber (unsigned long serialNumberValue)
	Set/Get event retraction serial number Used in timestamped messages.
virtual unsigned long	serialNumber () const
virtual void	setTransportType (DtTransportHandle type)
	Set/Get transport type.
virtual DtTransportHandle	transportType () const
virtual DtOrderHandle	orderType () const
	This base implementation always returns recieve order.
virtual bool	isMetadataPresent () const
	Test if metadata has been added to a DtRtiMsg object.
virtual bool	addMetadata (caddr_t *mtdAddr, unsigned int size, unsigned int *alignPad, unsigned int *headerPad=NULL)
	Allocate space for next block of metadata.
virtual void	removeMetadata (unsigned int size)
	Update the size of the message when metadata has been removed.
bool	isInteractionMsgType () const
	Utility functions, check the message type against known interaciton/update message types.
bool	isUpdateMsgType () const
virtual void	print (DtLogicalTimeFactory *logicalTimeFactory) const
	Printing functions.
virtual void	printHeader (DtLogicalTimeFactory *logicalTimeFactory) const
virtual void	printTime (const char *label, RTI::FedTime const *timeValue) const
	Print the given time.
virtual void	printInterval (const char *label, RTI::FedTime const *intervalValue) const
	Print the interval.
virtual int	status () const
	Returns MSG_STATUS_OK if OK, a reason enumeration otherwise.
virtual const MAKRti::DtString	fedExName () const
	These two functions should be avoided in favor of isForExec().
virtual int	fedExHandle () const
	Get the federation execution identifier as a handle Returns 0 if the identifier is being represented as a name.
virtual void	setFederateHandle (DtFederateHandle handle)
	Set/Get federate handle.
virtual DtFederateHandle	federateHandle () const
	Set/Get federate handle.
virtual void	setSequenceNumber (unsigned long value)
	Set/Get message sequence number.
virtual unsigned long	sequenceNumber () const
	Set/Get message sequence number.
virtual void	setServiceCallNumber (unsigned long value)
	Set/Get service call number.
virtual unsigned long	serviceCallNumber () const
	Set/Get service call number.
virtual void	setTriggerMessageNumber (unsigned long value)
	Set/Get trigger message sequence number (i.e., the message being processed that triggered this message being sent).
virtual unsigned long	triggerMessageNumber () const
	Set/Get trigger message sequence number (i.e., the message being processed that triggered this message being sent).

Static Public Member Functions
static DtRtiMsg *	create (const DtNetMsgHeader *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Creators.
static DtRtiMsg *	create (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
static void	addCallback (DtConnectionMgr *conn, DtLatencyReportCb cb, void *usr)
	Adds or removes a callback with the given connection manager for this message type.
static void	removeCallback (DtConnectionMgr *conn, DtLatencyReportCb cb, void *usr)
Static Public Member Functions inherited from DtRtiMsg
static const DtNetMsgHeader *	netHeader (const void *buffer)
	Extracts the header network representation from the buffer.
static const char *	kindToString (DtRtiMsgKind kind)
	Returns the name of the message, by kind enumeration.
static const char *	kindString (const void *buffer)
	Extracts the message kind from the given buffer and returns its string name.
static const DtRtiMsgKind	msgKind (const void *buffer)
	Extracts the message kind from the given buffer.
static unsigned int	version (const void *buffer)
	Extracts the message version form the given buffer.
static unsigned int	fedExHandle (const void *buffer)
	Extracts the message fedEx handle form the given buffer (0 if lightweight fedEx name)
static DtFederateHandle	federateHandle (const void *buffer)
	Extracts the message federate handle form the given buffer.
static unsigned long	sequenceNumber (const void *buffer)
	Extracts the message sequence number form the given buffer.
static void	setDefaultRegionSet (unsigned long defaultRegionSet)
	Set the default region set handle.
static void	setUse32BitsForValueSize (bool use32BitsForValueSizeEnabled)
	Set/Get flag to enable use of 32 bit size field for attribute/parameter values.
static bool	use32BitsForValueSize ()
static void	setSmartForwardingEnabled (bool enabled)
	Set/Get is SmartForwarding enabled?
static bool	smartForwardingEnabled ()

Protected Member Functions
virtual DtNetLatencyReportMsg *	netLatencyReportMsg ()
	The network representation for the LatencyReportMsg message.
virtual const DtNetLatencyReportMsg *	netLatencyReportMsg () const
virtual DtRtiMsgKind	internalDtRtiMsgKind ()
	Returns the kind of a DtLatencyReportMsg 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 DtRtiMsg
	DtRtiMsg ()
	Constructor.
virtual void	sizeChanged (int size)
	Called whenever size is changed using changeSize, or insert/deleteBytes.
void	initDtRtiMsg (int size, DtRtiMsgKind msgKindVal, DtBufferPtr buffer)
	Called by ctor, so not virtual.
void	initDtRtiMsg (const void *initial, int size, DtBufferPtr buffer)
void	initDtRtiMsg (const DtNetMsgHeader *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 addres.

Additional Inherited Members
Static Public Attributes inherited from DtRtiMsg
static unsigned long	theDefaultRegionSetHandle
static const char *	theDefaultTag
Protected Attributes inherited from DtRtiMsg
DtTransportHandle	myTransportType
DtOrderHandle	myOrderType
RTI::FedTime *	myFedTime
bool	myTimeIsValid
bool	myConstrained
bool	myAllowedDuringSave
unsigned long	mySerialNumber
unsigned long	myServiceCallNumber
unsigned long	myTriggerMessage
Static Protected Attributes inherited from DtRtiMsg
static bool	theUse32BitsForValueSize
static bool	theSmartForwardingEnabled

Detailed Description

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

Constructor & Destructor Documentation

DtLatencyReportMsg::DtLatencyReportMsg

(

DtBufferPtr

buffer = DtUSE_INTERNAL_BUFFER

)

Constructors.

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

DtLatencyReportMsg::DtLatencyReportMsg	(	const DtNetLatencyReportMsg *	netRepMsg,
		DtBufferPtr	buffer = DtUSE_INTERNAL_BUFFER
	)

virtual DtLatencyReportMsg::~DtLatencyReportMsg ( )

virtual

Destructor.

Member Function Documentation

static void DtLatencyReportMsg::addCallback ( DtConnectionMgr *  conn, DtLatencyReportCb  cb, void *  usr  )

static

Adds or removes a callback with the given connection manager for this message type.

virtual DtRtiMsg* DtLatencyReportMsg::clone ( bool  copy = true ) const

virtual

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

Implements DtRtiMsg.

static DtRtiMsg* DtLatencyReportMsg::create ( const DtNetMsgHeader *  initial, DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER  )

static

Creators.

static DtRtiMsg* DtLatencyReportMsg::create ( DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER )

static

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

virtual

Decode msg data into input latency test report.

virtual DtRtiMsgKind DtLatencyReportMsg::internalDtRtiMsgKind ( )

protectedvirtual

Returns the kind of a DtLatencyReportMsg message.

Implements DtRtiMsg.

virtual int DtLatencyReportMsg::minSize ( ) const

protectedvirtual

Returns minimum size of a message, including header.

virtual DtNetLatencyReportMsg* DtLatencyReportMsg::netLatencyReportMsg ( )

protectedvirtual

The network representation for the LatencyReportMsg message.

virtual const DtNetLatencyReportMsg* DtLatencyReportMsg::netLatencyReportMsg ( ) const

protectedvirtual

virtual unsigned char* DtLatencyReportMsg::payload ( )

virtual

dataPointer to the payload.

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

virtual

dataPointer to the payload.

virtual void DtLatencyReportMsg::printData ( DtLogicalTimeFactory *  logicalTimeFactory ) const

virtual

Print the data section.

Reimplemented from DtRtiMsg.

static void DtLatencyReportMsg::removeCallback ( DtConnectionMgr *  conn, DtLatencyReportCb  cb, void *  usr  )

static

virtual void DtLatencyReportMsg::resize ( unsigned int  payLoadSize )

virtual

Resize the payload size.

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

virtual

Encode report into message data.

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

protectedvirtual

Add a time to the message.

virtual void DtLatencyReportMsg::setTotalSize ( unsigned int  times )

virtual

setTotal Size of the payload.

virtual unsigned char* DtLatencyReportMsg::timesPtr ( ) const

protectedvirtual

Returns pointer to the times in the netMsg.

virtual unsigned int DtLatencyReportMsg::totalSize ( ) const

virtual

What is the total size of the payload?

---

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

• latencyReportMsg.h