DtForwarderPingMsg Class Reference

Inheritance diagram for DtForwarderPingMsg:

Collaboration diagram for DtForwarderPingMsg:

List of all members.

Public Types
enum	DtPingStatus { PingRequest = 0, PingResponseSuccess, PingResponseNotFound }
Public Member Functions
	DtForwarderPingMsg (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Constructor.
	DtForwarderPingMsg (const DtNetForwarderPingMsg *netRep, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Constructor.
	DtForwarderPingMsg (unsigned long target, DtPingStatus status, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Constructor.
virtual	~DtForwarderPingMsg ()
	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, DtPingStatus status)
	Set all fields simultaneously.
virtual void	setPingStatus (DtPingStatus status)
	Set/Get the ping msg status/type.
virtual DtPingStatus	pingStatus () const
virtual void	setDestination (unsigned long target)
	Set/Get the target ID for the ping ( note ID is the forwarder's 16-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, DtForwarderPingCb cb, void *usr, bool isMomCallback=false)
	Callback management.
static void	removeCallback (DtConnectionMgr *conn, DtForwarderPingCb cb, void *usr, bool isMomCallback=false)
Protected Member Functions
virtual DtNetForwarderPingMsg *	netForwarderPingMsg ()
	The network representation.
virtual const DtNetForwarderPingMsg *	netForwarderPingMsg () const
virtual DtRtiMsgKind	internalDtRtiMsgKind ()
	Returns the kind of an Forwarder Ping Msg.
virtual int	minSize () const
	Returns minimum size of a message, including header.
virtual DtForwarderPingMsg *	self () const
	Casts away const-ness.

---

Member Enumeration Documentation

enum DtForwarderPingMsg::DtPingStatus

Enumerator:

PingRequest
PingResponseSuccess
PingResponseNotFound

---

Constructor & Destructor Documentation

DtForwarderPingMsg::DtForwarderPingMsg

(

DtBufferPtr

buffer = DtUSE_INTERNAL_BUFFER

)

Constructor.

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

Referenced by clone(), and create().

DtForwarderPingMsg::DtForwarderPingMsg	(	const DtNetForwarderPingMsg *	netRep,
		DtBufferPtr	buffer = DtUSE_INTERNAL_BUFFER
	)

Constructor.

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

DtForwarderPingMsg::DtForwarderPingMsg	(	unsigned long	target,
		DtPingStatus	status,
		DtBufferPtr	buffer = DtUSE_INTERNAL_BUFFER
	)

Constructor.

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

DtForwarderPingMsg::~DtForwarderPingMsg

(

)

[virtual]

Destructor.

---

Member Function Documentation

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

Callback management.

References DtConnectionMgr::addMsgCallback(), and DtForwarderPingMsgKind.

DtRtiMsg * DtForwarderPingMsg::clone

(

bool

copy = true

)

const [virtual]

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

Implements DtRtiMsg.

References DtForwarderPingMsg(), and netForwarderPingMsg().

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

Creator.

References DtForwarderPingMsg().

DtRtiMsg * DtForwarderPingMsg::create

(

DtBufferPtr

buffer = DtUSE_INTERNAL_BUFFER

)

[static]

References DtForwarderPingMsg().

unsigned long DtForwarderPingMsg::destination

(

)

const [virtual]

References DtNetForwarderPingMsg::destinationAddress, and netForwarderPingMsg().

Referenced by printData(), DtForwarderPingProcessor::processInToOutMsg(), DtForwarderPingProcessor::processLanToOutMsg(), and DtForwarderFaultManager::processPing().

DtRtiMsgKind DtForwarderPingMsg::internalDtRtiMsgKind

(

)

[protected, virtual]

Returns the kind of an Forwarder Ping Msg.

Implements DtRtiMsg.

References DtForwarderPingMsgKind.

Referenced by DtForwarderPingMsg().

int DtForwarderPingMsg::minSize

(

)

const [protected, virtual]

Returns minimum size of a message, including header.

Referenced by DtForwarderPingMsg().

DtNetForwarderPingMsg * DtForwarderPingMsg::netForwarderPingMsg

(

)

[protected, virtual]

The network representation.

Referenced by clone(), destination(), pingStatus(), setDestination(), and setPingStatus().

const DtNetForwarderPingMsg * DtForwarderPingMsg::netForwarderPingMsg

(

)

const [protected, virtual]

DtForwarderPingMsg::DtPingStatus DtForwarderPingMsg::pingStatus

(

)

const [virtual]

References netForwarderPingMsg(), and DtNetForwarderPingMsg::pingStatus.

Referenced by printData(), DtForwarderPingProcessor::processInToOutMsg(), DtForwarderPingProcessor::processLanToOutMsg(), and DtForwarderFaultManager::processPing().

void DtForwarderPingMsg::printData

(

DtLogicalTimeFactory *

logicalTimeFactory

)

const [virtual]

Print the data section.

Reimplemented from DtRtiMsg.

References destination(), and pingStatus().

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

References DtForwarderPingMsgKind, and DtConnectionMgr::removeMsgCallback().

Referenced by DtForwarderFaultManager::~DtForwarderFaultManager().

DtForwarderPingMsg * DtForwarderPingMsg::self

(

)

const [inline, protected, virtual]

Casts away const-ness.

void DtForwarderPingMsg::set	(	unsigned long	target,
		DtPingStatus	status
	)		[virtual]

Set all fields simultaneously.

References setDestination(), and setPingStatus().

void DtForwarderPingMsg::setDestination

(

unsigned long

target

)

[virtual]

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

References DtNetForwarderPingMsg::destinationAddress, and netForwarderPingMsg().

Referenced by set().

void DtForwarderPingMsg::setPingStatus

(

DtPingStatus

status

)

[virtual]

Set/Get the ping msg status/type.

References netForwarderPingMsg(), and DtNetForwarderPingMsg::pingStatus.

Referenced by set().

---

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

• forwarderPingMsg.h
• forwarderPingMsg.cxx