DtMcastConfigureMsg Class Reference

IMPORTANT NOTE: Multicast Configuration message are not intended for dissemination over the network. More...

Inheritance diagram for DtMcastConfigureMsg:

Collaboration diagram for DtMcastConfigureMsg:

List of all members.

Public Member Functions
	DtMcastConfigureMsg (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Constructor.
	DtMcastConfigureMsg (unsigned long ID, MAKRti::DtInetAddr mcastAddr, MAKRti::DtInetAddr interfaceAddr, DtMcastConfigFlags flag, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	DtMcastConfigureMsg (const DtNetMulticastConfigureMsg *netRepMsg, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Constructor.
virtual	~DtMcastConfigureMsg ()
	Destructor.
virtual DtRtiMsg *	clone (bool copy=true) const
	Return a copy/empty object of the same type as this.
virtual void	set (unsigned long ID, const MAKRti::DtInetAddr &mcastAddr, const MAKRti::DtInetAddr &interfaceAddr, DtMcastConfigFlags flag)
	Set all parameters simultaneously.
void	setSourceID (const unsigned long ID)
	Set/Get source federate ID.
const unsigned long	sourceID () const
void	setMcastAddr (const MAKRti::DtInetAddr &mcastAddr)
	Set/Get multicast address.
MAKRti::DtInetAddr	mcastAddr () const
void	setInterfaceAddr (const MAKRti::DtInetAddr &interfaceAddr)
	Set/Get local interface address.
MAKRti::DtInetAddr	interfaceAddr () const
void	setConfigFlag (DtMcastConfigFlags flag)
	Set/Get listen / drop flag.
DtMcastConfigFlags	configFlag () 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, DtMcastConfigureMsgCb cb, void *usr)
	Callback management.
static void	removeCallback (DtConnectionMgr *conn, DtMcastConfigureMsgCb cb, void *usr)
Protected Member Functions
virtual DtNetMulticastConfigureMsg *	netMulticastConfigMsg ()
	The network representation.
virtual const DtNetMulticastConfigureMsg *	netMulticastConfigMsg () const
virtual DtRtiMsgKind	internalDtRtiMsgKind ()
	Returns the kind of an SmMulticastConfig Msg.
virtual int	minSize () const
	Returns minimum size of a message, including header.
virtual DtMcastConfigureMsg *	self () const
	Casts away const-ness.

---

Detailed Description

IMPORTANT NOTE: Multicast Configuration message are not intended for dissemination over the network.

They are to be exchanged over a shared memory message queue only to allow federates to instruct a shared memory queue manager's network I/O connection manager to listen or drop multicast groups.

---

Constructor & Destructor Documentation

DtMcastConfigureMsg::DtMcastConfigureMsg

(

DtBufferPtr

buffer = DtUSE_INTERNAL_BUFFER

)

Constructor.

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

Referenced by clone(), and create().

DtMcastConfigureMsg::DtMcastConfigureMsg	(	unsigned long	ID,
		MAKRti::DtInetAddr	mcastAddr,
		MAKRti::DtInetAddr	interfaceAddr,
		DtMcastConfigFlags	flag,
		DtBufferPtr	buffer = DtUSE_INTERNAL_BUFFER
	)

References DtRtiMsg::initDtRtiMsg(), internalDtRtiMsgKind(), minSize(), setConfigFlag(), setInterfaceAddr(), setMcastAddr(), and setSourceID().

DtMcastConfigureMsg::DtMcastConfigureMsg	(	const DtNetMulticastConfigureMsg *	netRepMsg,
		DtBufferPtr	buffer = DtUSE_INTERNAL_BUFFER
	)

Constructor.

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

DtMcastConfigureMsg::~DtMcastConfigureMsg

(

)

[virtual]

Destructor.

---

Member Function Documentation

void DtMcastConfigureMsg::addCallback	(	DtConnectionMgr *	conn,
		DtMcastConfigureMsgCb	cb,
		void *	usr
	)		[static]

Callback management.

References DtConnectionMgr::addMsgCallback(), and DtMcastConfigureMsgKind.

DtRtiMsg * DtMcastConfigureMsg::clone

(

bool

copy = true

)

const [virtual]

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

Implements DtRtiMsg.

References DtMcastConfigureMsg(), and netMulticastConfigMsg().

DtMcastConfigFlags DtMcastConfigureMsg::configFlag

(

)

const

References netMulticastConfigMsg().

Referenced by printData().

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

Creator.

References DtMcastConfigureMsg().

DtRtiMsg * DtMcastConfigureMsg::create

(

DtBufferPtr

buffer = DtUSE_INTERNAL_BUFFER

)

[static]

Creator.

References DtMcastConfigureMsg().

MAKRti::DtInetAddr DtMcastConfigureMsg::interfaceAddr

(

)

const

References netMulticastConfigMsg().

Referenced by printData().

DtRtiMsgKind DtMcastConfigureMsg::internalDtRtiMsgKind

(

)

[protected, virtual]

Returns the kind of an SmMulticastConfig Msg.

Implements DtRtiMsg.

References DtMcastConfigureMsgKind.

Referenced by DtMcastConfigureMsg().

MAKRti::DtInetAddr DtMcastConfigureMsg::mcastAddr

(

)

const

References netMulticastConfigMsg().

Referenced by printData().

int DtMcastConfigureMsg::minSize

(

)

const [protected, virtual]

Returns minimum size of a message, including header.

Referenced by DtMcastConfigureMsg().

DtNetMulticastConfigureMsg * DtMcastConfigureMsg::netMulticastConfigMsg

(

)

[protected, virtual]

The network representation.

Referenced by clone(), configFlag(), interfaceAddr(), mcastAddr(), setConfigFlag(), setInterfaceAddr(), setMcastAddr(), setSourceID(), and sourceID().

const DtNetMulticastConfigureMsg * DtMcastConfigureMsg::netMulticastConfigMsg

(

)

const [protected, virtual]

void DtMcastConfigureMsg::printData

(

DtLogicalTimeFactory *

logicalTimeFactory

)

const [virtual]

Print the data section.

Reimplemented from DtRtiMsg.

References configFlag(), interfaceAddr(), mcastAddr(), and sourceID().

void DtMcastConfigureMsg::removeCallback	(	DtConnectionMgr *	conn,
		DtMcastConfigureMsgCb	cb,
		void *	usr
	)		[static]

References DtMcastConfigureMsgKind, and DtConnectionMgr::removeMsgCallback().

DtMcastConfigureMsg * DtMcastConfigureMsg::self

(

)

const [inline, protected, virtual]

Casts away const-ness.

void DtMcastConfigureMsg::set	(	unsigned long	ID,
		const MAKRti::DtInetAddr &	mcastAddr,
		const MAKRti::DtInetAddr &	interfaceAddr,
		DtMcastConfigFlags	flag
	)		[virtual]

Set all parameters simultaneously.

References setConfigFlag(), setInterfaceAddr(), setMcastAddr(), and setSourceID().

Referenced by DtSmConnectionMgr::dropMulticastGroup(), DtConnectionMgr::dropMulticastGroup(), DtSmConnectionMgr::forceDropMulticastGroup(), DtConnectionMgr::forceDropMulticastGroup(), DtSmConnectionMgr::listenToMulticastGroup(), and DtConnectionMgr::listenToMulticastGroup().

void DtMcastConfigureMsg::setConfigFlag

(

DtMcastConfigFlags

flag

)

Set/Get listen / drop flag.

References DtNetMulticastConfigureMsg::listenDropFlag, and netMulticastConfigMsg().

Referenced by DtMcastConfigureMsg(), and set().

void DtMcastConfigureMsg::setInterfaceAddr

(

const MAKRti::DtInetAddr &

interfaceAddr

)

Set/Get local interface address.

References DtNetMulticastConfigureMsg::interfaceAddr, and netMulticastConfigMsg().

Referenced by DtMcastConfigureMsg(), and set().

void DtMcastConfigureMsg::setMcastAddr

(

const MAKRti::DtInetAddr &

mcastAddr

)

Set/Get multicast address.

References DtNetMulticastConfigureMsg::inetAddrFamily, DtNetMulticastConfigureMsg::multicastAddr, and netMulticastConfigMsg().

Referenced by DtMcastConfigureMsg(), and set().

void DtMcastConfigureMsg::setSourceID

(

const unsigned long

ID

)

Set/Get source federate ID.

References DtNetMulticastConfigureMsg::id, and netMulticastConfigMsg().

Referenced by DtMcastConfigureMsg(), and set().

const unsigned long DtMcastConfigureMsg::sourceID

(

)

const

References DtNetMulticastConfigureMsg::id, and netMulticastConfigMsg().

Referenced by printData().

---

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

• mcastConfigureMsg.h
• mcastConfigureMsg.cxx