Inheritance diagram for DtRequestMsg:

Collaboration diagram for DtRequestMsg:

Public Member Functions
	DtRequestMsg (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Constructor.
	DtRequestMsg (DtRequestType type, DtHandle idOrClass, const DtAttributeHandleSet &theSet, char const *tag, DtHandle regionSetHandle=theDefaultRegionSetHandle, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	DtRequestMsg (const DtNetRequestMsg *netRepMsg, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Constructor.
virtual	~DtRequestMsg ()
	Destructor.
virtual DtRtiMsg *	clone (bool copy=true) const
	Return a copy/empty object of the same type as this.
virtual void	set (DtRequestType type, DtHandle idOrClass, const DtAttributeHandleSet &theSet, char const *tag, DtHandle regionSetHandle=theDefaultRegionSetHandle)
	Set all fields simultaneously.
virtual DtRequestType	requestType () const
	Set/Get request type.
virtual void	setRequestType (DtRequestType type)
virtual void	setObjectClassHandle (DtObjectClassHandle hand)
	Set/Get handle.
virtual DtObjectClassHandle	objectClassHandle () const
	Returns 0 if the message is of type DtRequestById.
virtual void	setId (DtObjectInstanceHandle id)
	Set/Get id.
virtual DtObjectInstanceHandle	id () const
	Returns 0 if the message is of type DtRequestByClass.
virtual void	setRegionSet (DtHandle handleValue)
	Set/Get DDM region set.
virtual DtHandle	regionSet () const
virtual void	setAttrHandles (const DtAttributeHandleSet &attrs)
	Set/Get attribute handles.
virtual const DtAttributeHandleSet &	attrHandles () const
virtual void	setTag (char const *tag)
	Set/Get tag.
virtual char const *	tag () const
virtual void	printData (DtLogicalTimeFactory *logicalTimeFactory) const
	Print the data section.
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)
	Creator.
static void	addCallback (DtConnectionMgr conn, DtRequestCb cb, void usr, bool isMomCallback=false)
	Callback management.
static void	removeCallback (DtConnectionMgr conn, DtRequestCb 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 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 DtNetRequestMsg *	netRequestMsg ()
	The network representation.
virtual const DtNetRequestMsg *	netRequestMsg () const
virtual DtRtiMsgKind	internalDtRtiMsgKind ()
	Returns the kind of an Request Msg.
virtual int	minSize (char const *tag=NULL) const
	Returns minimum size of a message, including header.
virtual void	setTagSize (int size)
	Set/Get tag size.
virtual int	tagSize () const
virtual int	tagFieldSize () const
	Returns size of tag field.
virtual char *	tagPtr () const
	Returns pointer to the tag in the netMsg.
virtual DtRequestMsg *	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.

Protected Attributes
int	myDirty
DtAttributeHandleSet *	myAttrs
char *	myTag
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

Additional Inherited Members
Static Public Attributes inherited from DtRtiMsg
static unsigned long	theDefaultRegionSetHandle = 0
static const char *	theDefaultTag = NULL
Static Protected Attributes inherited from DtRtiMsg
static bool	theUse32BitsForValueSize = false
static bool	theSmartForwardingEnabled = false

Constructor & Destructor Documentation

DtRequestMsg::DtRequestMsg ( DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER )

Constructor.

References DtRtiMsg::initDtRtiMsg(), internalDtRtiMsgKind(), and minSize().

Referenced by clone(), and create().

DtRequestMsg::DtRequestMsg	(	DtRequestType	type,
		DtHandle	idOrClass,
		const DtAttributeHandleSet &	theSet,
		char const *	tag,
		DtHandle	regionSetHandle = `theDefaultRegionSetHandle`,
		DtBufferPtr	buffer = `DtUSE_INTERNAL_BUFFER`
	)

References DtAutoRequestById, DtRequestById, DtRtiMsg::initDtRtiMsg(), internalDtRtiMsgKind(), minSize(), setAttrHandles(), setId(), setObjectClassHandle(), setRegionSet(), setRequestType(), and setTag().

DtRequestMsg::DtRequestMsg	(	const DtNetRequestMsg *	netRepMsg,
		DtBufferPtr	buffer = `DtUSE_INTERNAL_BUFFER`
	)

Constructor.

References DtNetRequestMsg::header, and DtRtiMsg::initDtRtiMsg().

DtRequestMsg::~DtRequestMsg ( )

virtual

Destructor.

References myAttrs, myTag, and NULL.

Member Function Documentation

void DtRequestMsg::addCallback	(	DtConnectionMgr *	conn,
		DtRequestCb	cb,
		void *	usr,
		bool	isMomCallback = `false`
	)

static

Callback management.

References DtConnectionMgr::addMsgCallback(), and DtRequestMsgKind.

Referenced by DtObjectMgr::DtObjectMgr().

const DtAttributeHandleSet & DtRequestMsg::attrHandles ( ) const

virtual

References DtAttributeHandleSet::decode(), DtNetRequestMsg::handleSet, myAttrs, myDirty, and netRequestMsg().

Referenced by printData(), and DtObjectMgr::processRequest().

DtRtiMsg * DtRequestMsg::clone ( bool copy = true ) const

virtual

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

Implements DtRtiMsg.

References DtRequestMsg(), and netRequestMsg().

DtRtiMsg * DtRequestMsg::create	(	const DtNetMsgHeader *	initial,
		DtBufferPtr	buffer = `DtUSE_INTERNAL_BUFFER`
	)

static

Creator.

References DtRequestMsg().

DtRtiMsg * DtRequestMsg::create ( DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER )

static

Creator.

References DtRequestMsg().

DtObjectInstanceHandle DtRequestMsg::id ( ) const

virtual

Returns 0 if the message is of type DtRequestByClass.

References DtAutoRequestById, DtRequestById, DtNetRequestMsg::handleOrId, netRequestMsg(), and requestType().

Referenced by DtObjectMgr::processRequest(), and setId().

DtRtiMsgKind DtRequestMsg::internalDtRtiMsgKind ( )

protectedvirtual

Returns the kind of an Request Msg.

Implements DtRtiMsg.

References DtRequestMsgKind.

Referenced by DtRequestMsg().

int DtRequestMsg::minSize ( char const * tag = NULL ) const

protectedvirtual

Returns minimum size of a message, including header.

Referenced by DtRequestMsg().

DtNetRequestMsg * DtRequestMsg::netRequestMsg ( )

protectedvirtual

The network representation.

Referenced by attrHandles(), clone(), id(), objectClassHandle(), regionSet(), requestType(), setAttrHandles(), setId(), setObjectClassHandle(), setRegionSet(), setRequestType(), setTagSize(), tagPtr(), and tagSize().

const DtNetRequestMsg * DtRequestMsg::netRequestMsg ( ) const

protectedvirtual

DtObjectClassHandle DtRequestMsg::objectClassHandle ( ) const

virtual

Returns 0 if the message is of type DtRequestById.

References DtRequestByClass, DtNetRequestMsg::handleOrId, netRequestMsg(), and requestType().

Referenced by printData(), and DtObjectMgr::processRequest().

void DtRequestMsg::printData ( DtLogicalTimeFactory * logicalTimeFactory ) const

virtual

Print the data section.

Reimplemented from DtRtiMsg.

References attrHandles(), DtAutoRequestById, DtRequestByClass, objectClassHandle(), DtRtiMsg::print(), regionSet(), and requestType().

DtHandle DtRequestMsg::regionSet ( ) const

virtual

References netRequestMsg(), and DtNetRequestMsg::regionSet.

Referenced by printData().

void DtRequestMsg::removeCallback	(	DtConnectionMgr *	conn,
		DtRequestCb	cb,
		void *	usr,
		bool	isMomCallback = `false`
	)

static

References DtRequestMsgKind, and DtConnectionMgr::removeMsgCallback().

Referenced by DtObjectMgr::~DtObjectMgr().

DtRequestType DtRequestMsg::requestType ( ) const

virtual

Set/Get request type.

References netRequestMsg().

Referenced by id(), objectClassHandle(), printData(), DtObjectMgr::processRequest(), setId(), and setObjectClassHandle().

DtRequestMsg * DtRequestMsg::self ( ) const

inlineprotectedvirtual

Casts away const-ness.

void DtRequestMsg::set	(	DtRequestType	type,
		DtHandle	idOrClass,
		const DtAttributeHandleSet &	theSet,
		char const *	tag,
		DtHandle	regionSetHandle = `theDefaultRegionSetHandle`
	)