DtRequestMsg Class Reference

Inheritance diagram for DtRequestMsg:

Collaboration diagram for DtRequestMsg:

List of all members.

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

---

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

(

)

[protected, virtual]

Returns the kind of an Request Msg.

Implements DtRtiMsg.

References DtRequestMsgKind.

Referenced by DtRequestMsg().

int DtRequestMsg::minSize

(

char const *

tag = NULL

)

const [protected, virtual]

Returns minimum size of a message, including header.

Referenced by DtRequestMsg().

DtNetRequestMsg * DtRequestMsg::netRequestMsg

(

)

[protected, virtual]

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 [protected, virtual]

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 [inline, protected, virtual]

Casts away const-ness.

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

Set all fields simultaneously.

References DtAutoRequestById, DtRequestById, setAttrHandles(), setId(), setObjectClassHandle(), setRegionSet(), setRequestType(), and setTag().

Referenced by DtObjectMgr::sendRequestMsg().

void DtRequestMsg::setAttrHandles

(

const DtAttributeHandleSet &

attrs

)

[virtual]

Set/Get attribute handles.

References myDirty, and netRequestMsg().

Referenced by DtRequestMsg(), and set().

void DtRequestMsg::setId

(

DtObjectInstanceHandle

id

)

[virtual]

Set/Get id.

Does nothing if the message is of type DtRequestByClass

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

Referenced by DtRequestMsg(), and set().

void DtRequestMsg::setObjectClassHandle

(

DtObjectClassHandle

hand

)

[virtual]

Set/Get handle.

Does nothing if the message is of type DtRequestById

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

Referenced by DtRequestMsg(), and set().

void DtRequestMsg::setRegionSet

(

DtHandle

handleValue

)

[virtual]

Set/Get DDM region set.

References netRequestMsg(), and DtNetRequestMsg::regionSet.

Referenced by DtRequestMsg(), and set().

void DtRequestMsg::setRequestType

(

DtRequestType

type

)

[virtual]

References netRequestMsg(), and DtNetRequestMsg::requestType.

Referenced by DtRequestMsg(), and set().

void DtRequestMsg::setTag

(

char const *

tag

)

[virtual]

Set/Get tag.

References DtRtiMsg::adjustBytes(), myTag, NULL, setTagSize(), tagFieldSize(), tagPtr(), and tagSize().

Referenced by DtRequestMsg(), and set().

void DtRequestMsg::setTagSize

(

int

size

)

[protected, virtual]

Set/Get tag size.

References netRequestMsg(), and DtNetRequestMsg::tagSize.

Referenced by setTag().

const char * DtRequestMsg::tag

(

)

const [virtual]

References myTag, NULL, tagPtr(), and tagSize().

Referenced by DtObjectMgr::processRequest().

int DtRequestMsg::tagFieldSize

(

)

const [protected, virtual]

Returns size of tag field.

References tagSize().

Referenced by setTag().

char * DtRequestMsg::tagPtr

(

)

const [protected, virtual]

Returns pointer to the tag in the netMsg.

References DtNetRequestMsg::handleSet, and netRequestMsg().

Referenced by setTag(), and tag().

int DtRequestMsg::tagSize

(

)

const [protected, virtual]

References netRequestMsg(), and DtNetRequestMsg::tagSize.

Referenced by setTag(), tag(), and tagFieldSize().

---

Member Data Documentation

DtAttributeHandleSet* DtRequestMsg::myAttrs [protected]

Referenced by attrHandles(), and ~DtRequestMsg().

int DtRequestMsg::myDirty [protected]

Referenced by attrHandles(), and setAttrHandles().

char* DtRequestMsg::myTag [protected]

Referenced by setTag(), tag(), and ~DtRequestMsg().

---

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

• reqObjMsg.h
• reqObjMsg.cxx