DtInteractionRoMsg Class Reference

Message for sending receive order interaciotns. More...

Inheritance diagram for DtInteractionRoMsg:

Collaboration diagram for DtInteractionRoMsg:

List of all members.

Public Member Functions
	DtInteractionRoMsg (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Constructors.
	DtInteractionRoMsg (DtInteractionClassHandle theInteraction, const DtPhvps &theParameters, char const *theTag, unsigned long channel, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	DtInteractionRoMsg (const DtNetInteractionMsg *netRepMsg, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
virtual	~DtInteractionRoMsg ()
	Destructor.
virtual DtRtiMsg *	clone (bool copy=true) const
	Return a copy/empty object of the same type as this.
virtual void	set (DtInteractionClassHandle theInteraction, const DtPhvps &theParameters, char const *theTag, unsigned long channel)
	Set all fields simultaneously.
virtual void	setHandle (DtInteractionClassHandle hand)
	Set/Get handle.
virtual DtInteractionClassHandle	handle () const
virtual void	printData (DtLogicalTimeFactory *logicalTimeFactory) const
	Print the data section.
Static Public Member Functions
static DtRtiMsg *	create (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Creators.
static DtRtiMsg *	create (const DtNetMsgHeader *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
static void	addCallback (DtConnectionMgr *conn, DtInteractionCb cb, void *usr, bool isMomCallback=false)
	Callback management.
static void	removeCallback (DtConnectionMgr *conn, DtInteractionCb cb, void *usr, bool isMomCallback=false)
Protected Member Functions
virtual DtNetParams *	netParams ()
	Returns pointer to the network rep of the pvList.
virtual DtNetBigParams *	netBigParams ()
	Supports big parameter values > 64K.
virtual DtNetInteractionMsg *	netInterRoMsg ()
	The network representation.
virtual const DtNetInteractionMsg *	netInterRoMsg () const
virtual DtRtiMsgKind	internalDtRtiMsgKind ()
	Returns the kind of an Interaction Msg.
virtual int	minSize (const DtPhvps *params=NULL, char const *theTag=NULL) const
	Returns minimum size of a message, including header, time, and tag.
virtual void	setTagSize (int size)
	Set/Get tag size.
virtual int	tagSize () const
virtual DtNetU32 *	channelPtr () const
	Returns pointer to the channel in the netMsg.
virtual char *	tagPtr ()
	Returns pointer to the tag in the netMsg.
virtual DtInteractionRoMsg *	selfRo () const
	Casts away const-ness.

---

Detailed Description

Message for sending receive order interaciotns.

---

Constructor & Destructor Documentation

DtInteractionRoMsg::DtInteractionRoMsg

(

DtBufferPtr

buffer = DtUSE_INTERNAL_BUFFER

)

Constructors.

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

Referenced by clone(), create(), and DtInteractionRoMsg().

DtInteractionRoMsg::DtInteractionRoMsg	(	DtInteractionClassHandle	theInteraction,
		const DtPhvps &	theParameters,
		char const *	theTag,
		unsigned long	channel,
		DtBufferPtr	buffer = DtUSE_INTERNAL_BUFFER
	)

References DtRtiMsg::initDtRtiMsg(), internalDtRtiMsgKind(), minSize(), DtInteractionMsg::setChannel(), setHandle(), DtInteractionMsg::setParams(), and DtInteractionMsg::setTag().

DtInteractionRoMsg::DtInteractionRoMsg	(	const DtNetInteractionMsg *	netRepMsg,
		DtBufferPtr	buffer = DtUSE_INTERNAL_BUFFER
	)

References DtInteractionMsg::channelIncluded(), DtInteractionRoMsg(), DtNetInteractionMsg::header, DtRtiMsg::initDtRtiMsg(), DtInteractionMsg::myParamFieldLength, DtInteractionMsg::tagFieldSize(), and DtNetMsgHeader::totalSize.

DtInteractionRoMsg::~DtInteractionRoMsg

(

)

[virtual]

Destructor.

---

Member Function Documentation

void DtInteractionRoMsg::addCallback	(	DtConnectionMgr *	conn,
		DtInteractionCb	cb,
		void *	usr,
		bool	isMomCallback = false
	)		[static]

Callback management.

References DtConnectionMgr::addMsgCallback(), DtInteractionMsg::channelIncluded(), DtDdmInteractionRoMsgKind, DtInteractionRoMsgKind, and DtRtiMsg::msgKind().

Referenced by DtInteractionMgr::DtInteractionMgr().

DtNetU32 * DtInteractionRoMsg::channelPtr

(

)

const [protected, virtual]

Returns pointer to the channel in the netMsg.

Implements DtInteractionMsg.

References netInterRoMsg(), and DtNetInteractionMsg::tagSize.

Referenced by tagPtr().

DtRtiMsg * DtInteractionRoMsg::clone

(

bool

copy = true

)

const [virtual]

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

Implements DtRtiMsg.

References DtInteractionRoMsg(), and netInterRoMsg().

DtRtiMsg * DtInteractionRoMsg::create

(

DtBufferPtr

buffer = DtUSE_INTERNAL_BUFFER

)

[static]

Creators.

References DtInteractionRoMsg().

Referenced by DtDfltMsgFactory::DtDfltMsgFactory().

DtRtiMsg * DtInteractionRoMsg::create	(	const DtNetMsgHeader *	initial,
		DtBufferPtr	buffer = DtUSE_INTERNAL_BUFFER
	)		[static]

References DtInteractionRoMsg().

DtInteractionClassHandle DtInteractionRoMsg::handle

(

)

const [virtual]

Implements DtInteractionMsg.

References DtNetInteractionMsg::handle, and netInterRoMsg().

Referenced by printData().

DtRtiMsgKind DtInteractionRoMsg::internalDtRtiMsgKind

(

)

[protected, virtual]

Returns the kind of an Interaction Msg.

Implements DtRtiMsg.

References DtInteractionMsg::channelIncluded(), DtDdmInteractionRoMsgKind, and DtInteractionRoMsgKind.

Referenced by DtInteractionRoMsg().

int DtInteractionRoMsg::minSize	(	const DtPhvps *	params = NULL,
		char const *	theTag = NULL
	)		const [protected, virtual]

Returns minimum size of a message, including header, time, and tag.

Referenced by DtInteractionRoMsg().

DtNetBigParams * DtInteractionRoMsg::netBigParams

(

)

[protected, virtual]

Supports big parameter values > 64K.

Implements DtInteractionMsg.

References DtInteractionMsg::tagFieldSize(), and tagPtr().

DtNetInteractionMsg * DtInteractionRoMsg::netInterRoMsg

(

)

[protected, virtual]

The network representation.

Referenced by channelPtr(), clone(), handle(), setHandle(), setTagSize(), and tagSize().

const DtNetInteractionMsg * DtInteractionRoMsg::netInterRoMsg

(

)

const [protected, virtual]

DtNetParams * DtInteractionRoMsg::netParams

(

)

[protected, virtual]

Returns pointer to the network rep of the pvList.

Implements DtInteractionMsg.

References DtInteractionMsg::tagFieldSize(), and tagPtr().

void DtInteractionRoMsg::printData

(

DtLogicalTimeFactory *

logicalTimeFactory

)

const [virtual]

Print the data section.

Reimplemented from DtRtiMsg.

References DtInteractionMsg::channel(), DtInteractionMsg::channelIncluded(), DtInteractionMsg::getParams(), handle(), DtInteractionMsg::numParams(), DtRtiMsg::orderType(), DtInteractionMsg::tag(), and DtRtiMsg::transportType().

void DtInteractionRoMsg::removeCallback	(	DtConnectionMgr *	conn,
		DtInteractionCb	cb,
		void *	usr,
		bool	isMomCallback = false
	)		[static]

References DtInteractionMsg::channelIncluded(), DtDdmInteractionRoMsgKind, DtInteractionRoMsgKind, DtRtiMsg::msgKind(), and DtConnectionMgr::removeMsgCallback().

Referenced by DtInteractionMgr::~DtInteractionMgr().

DtInteractionRoMsg * DtInteractionRoMsg::selfRo

(

)

const [inline, protected, virtual]

Casts away const-ness.

void DtInteractionRoMsg::set	(	DtInteractionClassHandle	theInteraction,
		const DtPhvps &	theParameters,
		char const *	theTag,
		unsigned long	channel
	)		[virtual]

Set all fields simultaneously.

References DtInteractionMsg::setChannel(), setHandle(), DtInteractionMsg::setParams(), and DtInteractionMsg::setTag().

Referenced by DtInteractionMgr::sendInteractionMsg(), DtFedExec::sendSyncPointReport(), and DtFedExec::sendSyncPointStatusReport().

void DtInteractionRoMsg::setHandle

(

DtInteractionClassHandle

hand

)

[virtual]

Set/Get handle.

Implements DtInteractionMsg.

References DtNetInteractionMsg::handle, and netInterRoMsg().

Referenced by DtInteractionRoMsg(), and set().

void DtInteractionRoMsg::setTagSize

(

int

size

)

[protected, virtual]

Set/Get tag size.

Implements DtInteractionMsg.

References netInterRoMsg(), and DtNetInteractionMsg::tagSize.

char * DtInteractionRoMsg::tagPtr

(

)

[protected, virtual]

Returns pointer to the tag in the netMsg.

Implements DtInteractionMsg.

References DtInteractionMsg::channelFieldSize(), and channelPtr().

Referenced by netBigParams(), and netParams().

int DtInteractionRoMsg::tagSize

(

)

const [protected, virtual]

Implements DtInteractionMsg.

References netInterRoMsg(), and DtNetInteractionMsg::tagSize.

---

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

• interRoMsg.h
• interRoMsg.cxx