DtMulticastDiscoveryMsg Class Reference

Inheritance diagram for DtMulticastDiscoveryMsg:

Collaboration diagram for DtMulticastDiscoveryMsg:

Public Types
enum	DtDiscoveryTarget { DtDiscoverRtiExec = 0, DtDiscoverTcpForwarder }
enum	DtDiscoveryStatus { DtDiscoveryRequest = 0, DtDiscoveryResponse }

Public Member Functions
	DtMulticastDiscoveryMsg (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Constructor.
	DtMulticastDiscoveryMsg (const DtNetMulticastDiscoveryMsg *netRep, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Constructor.
	DtMulticastDiscoveryMsg (DtDiscoveryTarget target, DtDiscoveryStatus status, MAKRti::DtInetAddr addr, unsigned int id, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Constructor.
virtual	~DtMulticastDiscoveryMsg ()
	Destructor.
virtual DtRtiMsg *	clone (bool copy=true) const
	Return a copy/empty object of the same type as this.
virtual void	set (DtDiscoveryTarget target, DtDiscoveryStatus status, MAKRti::DtInetAddr addr, unsigned int id)
	Set all fields simultaneously.
virtual void	setDiscoveryTarget (DtDiscoveryTarget target)
	Set/Get the discovery msg status/type.
virtual DtDiscoveryTarget	discoveryTarget () const
virtual void	setDiscoveryStatus (DtDiscoveryStatus status)
	Set/Get the discovery msg status/type.
virtual DtDiscoveryStatus	discoveryStatus () const
virtual void	setDiscoveryAddr (const MAKRti::DtInetAddr &addr)
	Set/Get the discovered IP for responses / source IP for requests.
virtual MAKRti::DtInetAddr	discoveryAddr () const
virtual void	setDiscoveryId (unsigned int id)
	Set/Get the discovered ID for responses / source ID for requests.
virtual unsigned int	discoveryId () const
virtual void	printData (DtLogicalTimeFactory *logicalTimeFactory) const
	Set whether discovery is complete.
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)
	Creator.
static DtRtiMsg *	create (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
static void	addCallback (DtConnectionMgr *conn, DtMulticastDiscoveryCb cb, void *usr, bool isMomCallback=false)
	Callback management.
static void	removeCallback (DtConnectionMgr *conn, DtMulticastDiscoveryCb cb, void *usr, bool isMomCallback=false)
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 unsigned long	totalSize (const void *buffer)
	Extracts the message total size form the given buffer.
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 unsigned char	flags (const void *buffer)
	Extracts the message flags form the given buffer.
static unsigned long	metadataSize (const void *buffer)
	Extracts the message metadata size 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 DtNetMulticastDiscoveryMsg *	netMulticastDiscoveryMsg ()
	The network representation.
virtual const DtNetMulticastDiscoveryMsg *	netMulticastDiscoveryMsg () const
virtual DtRtiMsgKind	internalDtRtiMsgKind ()
	Returns the kind of an Forwarder Discovery Msg.
virtual int	minSize () const
	Returns minimum size of a message, including header.
virtual DtMulticastDiscoveryMsg *	self () const
	Casts away const-ness.
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

Member Enumeration Documentation

enum DtMulticastDiscoveryMsg::DtDiscoveryStatus

Enumerator:

DtDiscoveryRequest
DtDiscoveryResponse

enum DtMulticastDiscoveryMsg::DtDiscoveryTarget

Enumerator:

DtDiscoverRtiExec
DtDiscoverTcpForwarder

Constructor & Destructor Documentation

DtMulticastDiscoveryMsg::DtMulticastDiscoveryMsg

(

DtBufferPtr

buffer = DtUSE_INTERNAL_BUFFER

)

Constructor.

DtMulticastDiscoveryMsg::DtMulticastDiscoveryMsg	(	const DtNetMulticastDiscoveryMsg *	netRep,
		DtBufferPtr	buffer = DtUSE_INTERNAL_BUFFER
	)

Constructor.

DtMulticastDiscoveryMsg::DtMulticastDiscoveryMsg	(	DtDiscoveryTarget	target,
		DtDiscoveryStatus	status,
		MAKRti::DtInetAddr	addr,
		unsigned int	id,
		DtBufferPtr	buffer = DtUSE_INTERNAL_BUFFER
	)

Constructor.

virtual DtMulticastDiscoveryMsg::~DtMulticastDiscoveryMsg ( )

virtual

Destructor.

Member Function Documentation

static void DtMulticastDiscoveryMsg::addCallback ( DtConnectionMgr *  conn, DtMulticastDiscoveryCb  cb, void *  usr, bool  isMomCallback = false  )

static

Callback management.

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

virtual

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

Implements DtRtiMsg.

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

static

Creator.

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

static

virtual MAKRti::DtInetAddr DtMulticastDiscoveryMsg::discoveryAddr ( ) const

virtual

virtual unsigned int DtMulticastDiscoveryMsg::discoveryId ( ) const

virtual

virtual DtDiscoveryStatus DtMulticastDiscoveryMsg::discoveryStatus ( ) const

virtual

virtual DtDiscoveryTarget DtMulticastDiscoveryMsg::discoveryTarget ( ) const

virtual

virtual DtRtiMsgKind DtMulticastDiscoveryMsg::internalDtRtiMsgKind ( )

protectedvirtual

Returns the kind of an Forwarder Discovery Msg.

Implements DtRtiMsg.

virtual int DtMulticastDiscoveryMsg::minSize ( ) const

protectedvirtual

Returns minimum size of a message, including header.

virtual DtNetMulticastDiscoveryMsg* DtMulticastDiscoveryMsg::netMulticastDiscoveryMsg ( )

protectedvirtual

The network representation.

virtual const DtNetMulticastDiscoveryMsg* DtMulticastDiscoveryMsg::netMulticastDiscoveryMsg ( ) const

protectedvirtual

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

virtual

Set whether discovery is complete.

Print the data section

Reimplemented from DtRtiMsg.

static void DtMulticastDiscoveryMsg::removeCallback ( DtConnectionMgr *  conn, DtMulticastDiscoveryCb  cb, void *  usr, bool  isMomCallback = false  )

static

DtMulticastDiscoveryMsg * DtMulticastDiscoveryMsg::self ( ) const

inlineprotectedvirtual

Casts away const-ness.

virtual void DtMulticastDiscoveryMsg::set ( DtDiscoveryTarget  target, DtDiscoveryStatus  status, MAKRti::DtInetAddr  addr, unsigned int  id  )

virtual

Set all fields simultaneously.

virtual void DtMulticastDiscoveryMsg::setDiscoveryAddr ( const MAKRti::DtInetAddr &  addr )

virtual

Set/Get the discovered IP for responses / source IP for requests.

virtual void DtMulticastDiscoveryMsg::setDiscoveryId ( unsigned int  id )

virtual

Set/Get the discovered ID for responses / source ID for requests.

virtual void DtMulticastDiscoveryMsg::setDiscoveryStatus ( DtDiscoveryStatus  status )

virtual

Set/Get the discovery msg status/type.

virtual void DtMulticastDiscoveryMsg::setDiscoveryTarget ( DtDiscoveryTarget  target )

virtual

Set/Get the discovery msg status/type.

---

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

• multicastDiscoveryMsg.h