DtFedAmbCallbackMsg Class Reference

A message that delivers stored callbacks generated by asynchronous thread. More...

Inheritance diagram for DtFedAmbCallbackMsg:

Collaboration diagram for DtFedAmbCallbackMsg:

Public Member Functions
	DtFedAmbCallbackMsg (std::auto_ptr< DtFedAmbCallback > callback)
	Constructor.
virtual	~DtFedAmbCallbackMsg ()
	Destructor.
virtual DtRtiMsg *	clone (bool copy=true) const
	Return a copy/empty object of the same type as this.
virtual DtRtiMsgKind	internalDtRtiMsgKind ()
	Return the message type.
virtual void	evokeCallback (RTI::FederateAmbassador *fedAmb) const
	Evoke the callback.
virtual void	printData (DtLogicalTimeFactory *logicalTimeFactory) const
	Print 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 void	addCallback (DtConnectionMgr *conn, DtCallbackCb cb, void *usr)
	Add a callback for this message type.
static void	removeCallback (DtConnectionMgr *conn, DtCallbackCb cb, void *usr)
	Remove a callback for this message type.
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 Attributes
std::auto_ptr< DtFedAmbCallback >	myCallback
	The federate ambassador callback parameters.
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

Private Member Functions
	DtFedAmbCallbackMsg (DtFedAmbCallbackMsg const &orig)
	Copy and Assignment Not Allowed.
DtFedAmbCallbackMsg &	operator= (DtFedAmbCallbackMsg const &orig)

Additional Inherited Members
Static Public Attributes inherited from DtRtiMsg
static unsigned long	theDefaultRegionSetHandle
static const char *	theDefaultTag
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.
Static Protected Attributes inherited from DtRtiMsg
static bool	theUse32BitsForValueSize
static bool	theSmartForwardingEnabled

Detailed Description

A message that delivers stored callbacks generated by asynchronous thread.

The callback message is processed in the federate's thread when it evokes tick or evokeCallback. An appropriate federate ambassador callback is made and passed the stored parameters.

Constructor & Destructor Documentation

DtFedAmbCallbackMsg::DtFedAmbCallbackMsg

(

std::auto_ptr< DtFedAmbCallback >

callback

)

Constructor.

virtual DtFedAmbCallbackMsg::~DtFedAmbCallbackMsg ( )

virtual

Destructor.

DtFedAmbCallbackMsg::DtFedAmbCallbackMsg ( DtFedAmbCallbackMsg const &  orig )

private

Copy and Assignment Not Allowed.

Member Function Documentation

static void DtFedAmbCallbackMsg::addCallback ( DtConnectionMgr *  conn, DtCallbackCb  cb, void *  usr  )

static

Add a callback for this message type.

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

virtual

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

NOTE: The transport type is not carried in the network representation used to make clones; therefore, it must be set after the clone is made

Implements DtRtiMsg.

virtual void DtFedAmbCallbackMsg::evokeCallback ( RTI::FederateAmbassador *  fedAmb ) const

virtual

Evoke the callback.

virtual DtRtiMsgKind DtFedAmbCallbackMsg::internalDtRtiMsgKind ( )

virtual

Return the message type.

Implements DtRtiMsg.

DtFedAmbCallbackMsg& DtFedAmbCallbackMsg::operator= ( DtFedAmbCallbackMsg const &  orig )

private

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

virtual

Print message data.

Reimplemented from DtRtiMsg.

static void DtFedAmbCallbackMsg::removeCallback ( DtConnectionMgr *  conn, DtCallbackCb  cb, void *  usr  )

static

Remove a callback for this message type.

Member Data Documentation

std::auto_ptr<DtFedAmbCallback> DtFedAmbCallbackMsg::myCallback

protected

The federate ambassador callback parameters.

---

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

• fedAmbCallbackMsg.h