DtForwarderResignMsg Class Reference

Inheritance diagram for DtForwarderResignMsg:

Collaboration diagram for DtForwarderResignMsg:

List of all members.

Public Types
enum	DtResignStatus { ResignCommand = 0, ResignResponseSuccess, ResignResponseNotFound }
Public Member Functions
	DtForwarderResignMsg (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Constructor.
	DtForwarderResignMsg (const DtNetForwarderResignMsg *netRep, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Constructor.
	DtForwarderResignMsg (unsigned long target, DtResignStatus status, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Constructor.
virtual	~DtForwarderResignMsg ()
	Destructor.
virtual DtRtiMsg *	clone (bool copy=true) const
	Return a copy/empty object of the same type as this.
virtual void	set (unsigned long target, DtResignStatus status)
	Set all fields simultaneously.
virtual void	setResignStatus (DtResignStatus status)
	Set/Get the resign msg status/type.
virtual DtResignStatus	resignStatus () const
virtual void	setDestination (unsigned long target)
	Set/Get the target ID for the resign ( note ID is the forwarder's 32-bit Forwarder ID, not IP )
virtual unsigned long	destination () 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)
static void	addCallback (DtConnectionMgr *conn, DtForwarderResignCb cb, void *usr, bool isMomCallback=false)
	Callback management.
static void	removeCallback (DtConnectionMgr *conn, DtForwarderResignCb cb, void *usr, bool isMomCallback=false)
Protected Member Functions
virtual DtNetForwarderResignMsg *	netForwarderResignMsg ()
	The network representation.
virtual const DtNetForwarderResignMsg *	netForwarderResignMsg () const
virtual DtRtiMsgKind	internalDtRtiMsgKind ()
	Returns the kind of an Forwarder Resign Msg.
virtual int	minSize () const
	Returns minimum size of a message, including header.
virtual DtForwarderResignMsg *	self () const
	Casts away const-ness.

---

Member Enumeration Documentation

enum DtForwarderResignMsg::DtResignStatus

Enumerator:

ResignCommand
ResignResponseSuccess
ResignResponseNotFound

---

Constructor & Destructor Documentation

DtForwarderResignMsg::DtForwarderResignMsg

(

DtBufferPtr

buffer = DtUSE_INTERNAL_BUFFER

)

Constructor.

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

Referenced by clone(), and create().

DtForwarderResignMsg::DtForwarderResignMsg	(	const DtNetForwarderResignMsg *	netRep,
		DtBufferPtr	buffer = DtUSE_INTERNAL_BUFFER
	)

Constructor.

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

DtForwarderResignMsg::DtForwarderResignMsg	(	unsigned long	target,
		DtResignStatus	status,
		DtBufferPtr	buffer = DtUSE_INTERNAL_BUFFER
	)

Constructor.

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

DtForwarderResignMsg::~DtForwarderResignMsg

(

)

[virtual]

Destructor.

---

Member Function Documentation

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

Callback management.

References DtConnectionMgr::addMsgCallback(), and DtForwarderResignMsgKind.

DtRtiMsg * DtForwarderResignMsg::clone

(

bool

copy = true

)

const [virtual]

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

Implements DtRtiMsg.

References DtForwarderResignMsg(), and netForwarderResignMsg().

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

Creator.

References DtForwarderResignMsg().

DtRtiMsg * DtForwarderResignMsg::create

(

DtBufferPtr

buffer = DtUSE_INTERNAL_BUFFER

)

[static]

References DtForwarderResignMsg().

unsigned long DtForwarderResignMsg::destination

(

)

const [virtual]

References DtNetForwarderResignMsg::destinationAddress, and netForwarderResignMsg().

Referenced by printData().

DtRtiMsgKind DtForwarderResignMsg::internalDtRtiMsgKind

(

)

[protected, virtual]

Returns the kind of an Forwarder Resign Msg.

Implements DtRtiMsg.

References DtForwarderResignMsgKind.

Referenced by DtForwarderResignMsg().

int DtForwarderResignMsg::minSize

(

)

const [protected, virtual]

Returns minimum size of a message, including header.

Referenced by DtForwarderResignMsg().

DtNetForwarderResignMsg * DtForwarderResignMsg::netForwarderResignMsg

(

)

[protected, virtual]

The network representation.

Referenced by clone(), destination(), resignStatus(), setDestination(), and setResignStatus().

const DtNetForwarderResignMsg * DtForwarderResignMsg::netForwarderResignMsg

(

)

const [protected, virtual]

void DtForwarderResignMsg::printData

(

DtLogicalTimeFactory *

logicalTimeFactory

)

const [virtual]

Print the data section.

Reimplemented from DtRtiMsg.

References destination(), and DtRtiMsg::status().

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

References DtForwarderResignMsgKind, and DtConnectionMgr::removeMsgCallback().

DtForwarderResignMsg::DtResignStatus DtForwarderResignMsg::resignStatus

(

)

const [virtual]

References netForwarderResignMsg(), and DtNetForwarderResignMsg::resignStatus.

DtForwarderResignMsg * DtForwarderResignMsg::self

(

)

const [inline, protected, virtual]

Casts away const-ness.

void DtForwarderResignMsg::set	(	unsigned long	target,
		DtResignStatus	status
	)		[virtual]

Set all fields simultaneously.

References setDestination(), and setResignStatus().

void DtForwarderResignMsg::setDestination

(

unsigned long

target

)

[virtual]

Set/Get the target ID for the resign ( note ID is the forwarder's 32-bit Forwarder ID, not IP )

References DtNetForwarderResignMsg::destinationAddress, and netForwarderResignMsg().

Referenced by set().

void DtForwarderResignMsg::setResignStatus

(

DtResignStatus

status

)

[virtual]

Set/Get the resign msg status/type.

References netForwarderResignMsg(), and DtNetForwarderResignMsg::resignStatus.

Referenced by set().

---

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

• forwarderResignMsg.h
• forwarderResignMsg.cxx