DtWwwControlMsg Class Reference

The DtWwwControlMsg defines a wrapper for the WebSpy messages used for control communication between the WWW Server and the RTI Componenets. More...

Inheritance diagram for DtWwwControlMsg:

Collaboration diagram for DtWwwControlMsg:

List of all members.

Public Types
typedef std::vector< std::pair < MAKRti::DtString, MAKRti::DtString > >	ParameterValuePairList
Public Member Functions
	DtWwwControlMsg (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Constructor.
	DtWwwControlMsg (unsigned long commandId, unsigned long connId, unsigned long fedexId, unsigned long targetFedId, const MAKRti::DtString &xml, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Constructor.
	DtWwwControlMsg (const DtNetWwwControlMsg *netRep, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Constructor.
virtual	~DtWwwControlMsg ()
	Destructor.
virtual DtRtiMsg *	clone (bool copy=true) const
	Return a copy/empty object of the same type as this.
virtual unsigned long	commandId () const
	Set/Get command ID.
virtual void	setCommandId (unsigned long commandId)
virtual unsigned long	connectionId () const
	Set/Get target/source connection ID (if specified)
virtual void	setConnectionId (unsigned long connId)
virtual unsigned long	targetFederateHandle () const
	Set/Get target federate ID (if specified)
virtual void	setTargetFederateHandle (unsigned long fedId)
virtual MAKRti::DtString	command () const
	Set/Get the command data.
virtual void	setCommand (const MAKRti::DtString &command)
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, DtWwwControlCb cb, void *usr)
	Callback management.
static void	removeCallback (DtConnectionMgr *conn, DtWwwControlCb cb, void *usr)
Protected Member Functions
virtual DtNetWwwControlMsg *	netWwwControlMsg ()
	The network representation.
virtual const DtNetWwwControlMsg *	netWwwControlMsg () const
virtual DtRtiMsgKind	internalDtRtiMsgKind ()
	Returns the kind of an DtWwwControlMsg Msg.
virtual char *	netMsgCommand ()
	Get a pointer to the message payload.
virtual const char *	netMsgCommand () const
virtual int	minSize () const
	Returns minimum size of a message, including header.

---

Detailed Description

The DtWwwControlMsg defines a wrapper for the WebSpy messages used for control communication between the WWW Server and the RTI Componenets.

The contained data is defined by the WebSpy library based on the commandId.

---

Member Typedef Documentation

typedef std::vector< std::pair< MAKRti::DtString, MAKRti::DtString > > DtWwwControlMsg::ParameterValuePairList

---

Constructor & Destructor Documentation

DtWwwControlMsg::DtWwwControlMsg

(

DtBufferPtr

buffer = DtUSE_INTERNAL_BUFFER

)

Constructor.

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

Referenced by clone(), and create().

DtWwwControlMsg::DtWwwControlMsg	(	unsigned long	commandId,
		unsigned long	connId,
		unsigned long	fedexId,
		unsigned long	targetFedId,
		const MAKRti::DtString &	xml,
		DtBufferPtr	buffer = DtUSE_INTERNAL_BUFFER
	)

Constructor.

References DtRtiMsg::initDtRtiMsg(), internalDtRtiMsgKind(), minSize(), setCommand(), setCommandId(), setConnectionId(), DtRtiMsg::setFedEx(), and setTargetFederateHandle().

DtWwwControlMsg::DtWwwControlMsg	(	const DtNetWwwControlMsg *	netRep,
		DtBufferPtr	buffer = DtUSE_INTERNAL_BUFFER
	)

Constructor.

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

DtWwwControlMsg::~DtWwwControlMsg

(

)

[virtual]

Destructor.

---

Member Function Documentation

void DtWwwControlMsg::addCallback	(	DtConnectionMgr *	conn,
		DtWwwControlCb	cb,
		void *	usr
	)		[static]

Callback management.

References DtConnectionMgr::addMsgCallback(), and DtWwwControlMsgKind.

DtRtiMsg * DtWwwControlMsg::clone

(

bool

copy = true

)

const [virtual]

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

Implements DtRtiMsg.

References DtWwwControlMsg(), and netWwwControlMsg().

MAKRti::DtString DtWwwControlMsg::command

(

)

const [virtual]

Set/Get the command data.

References netMsgCommand().

Referenced by DtRtiExecWebManager::controlMsgHandler(), DtTcpRtiConnectionMgr::establishConnection(), DtForwarderWebManager::handleWwwCommandMsg(), DtRtiExecWebManager::issueDeleteFederateCommand(), DtRtiExecWebManager::issueDestroyFederationCommand(), and printData().

unsigned long DtWwwControlMsg::commandId

(

)

const [virtual]

Set/Get command ID.

References DtNetWwwControlMsg::commandId, and netWwwControlMsg().

Referenced by DtRtiExecWebManager::controlMsgHandler(), DtTcpRtiConnectionMgr::establishConnection(), DtForwarderWebManager::handleWwwCommandMsg(), and printData().

unsigned long DtWwwControlMsg::connectionId

(

)

const [virtual]

Set/Get target/source connection ID (if specified)

References DtNetWwwControlMsg::connectionId, and netWwwControlMsg().

Referenced by DtTcpRtiConnectionMgr::establishConnection(), and DtRtiExecWebManager::issueStateRequest().

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

Creator.

References DtWwwControlMsg().

DtRtiMsg * DtWwwControlMsg::create

(

DtBufferPtr

buffer = DtUSE_INTERNAL_BUFFER

)

[static]

References DtWwwControlMsg().

DtRtiMsgKind DtWwwControlMsg::internalDtRtiMsgKind

(

)

[protected, virtual]

Returns the kind of an DtWwwControlMsg Msg.

Implements DtRtiMsg.

References DtWwwControlMsgKind.

Referenced by DtWwwControlMsg().

int DtWwwControlMsg::minSize

(

)

const [protected, virtual]

Returns minimum size of a message, including header.

Referenced by DtWwwControlMsg().

char * DtWwwControlMsg::netMsgCommand

(

)

[protected, virtual]

Get a pointer to the message payload.

References DtNetWwwControlMsg::commandLength, and netWwwControlMsg().

Referenced by command(), and setCommand().

const char * DtWwwControlMsg::netMsgCommand

(

)

const [protected, virtual]

References DtNetWwwControlMsg::commandLength, and netWwwControlMsg().

DtNetWwwControlMsg * DtWwwControlMsg::netWwwControlMsg

(

)

[protected, virtual]

The network representation.

Referenced by clone(), commandId(), connectionId(), netMsgCommand(), setCommand(), setCommandId(), setConnectionId(), setTargetFederateHandle(), and targetFederateHandle().

const DtNetWwwControlMsg * DtWwwControlMsg::netWwwControlMsg

(

)

const [protected, virtual]

void DtWwwControlMsg::printData

(

DtLogicalTimeFactory *

logicalTimeFactory

)

const [virtual]

Print the data section.

Reimplemented from DtRtiMsg.

References command(), commandId(), and targetFederateHandle().

void DtWwwControlMsg::removeCallback	(	DtConnectionMgr *	conn,
		DtWwwControlCb	cb,
		void *	usr
	)		[static]

References DtWwwControlMsgKind, and DtConnectionMgr::removeMsgCallback().

void DtWwwControlMsg::setCommand

(

const MAKRti::DtString &

command

)

[virtual]

References DtNetWwwControlMsg::commandLength, rti1516e::insertBytes(), netMsgCommand(), and netWwwControlMsg().

Referenced by DtWwwControlMsg(), DtWwwClientProtocol::parseCommand(), and DtTcpWwwSpyAdapter::sendTypeInfo().

void DtWwwControlMsg::setCommandId

(

unsigned long

commandId

)

[virtual]

References DtNetWwwControlMsg::commandId, and netWwwControlMsg().

Referenced by DtWwwControlMsg(), DtWwwClientProtocol::parseCommand(), and DtTcpWwwSpyAdapter::sendTypeInfo().

void DtWwwControlMsg::setConnectionId

(

unsigned long

connId

)

[virtual]

References DtNetWwwControlMsg::connectionId, and netWwwControlMsg().

Referenced by DtWwwControlMsg(), DtWwwClientProtocol::parseCommand(), and DtTcpWwwSpyAdapter::sendTypeInfo().

void DtWwwControlMsg::setTargetFederateHandle

(

unsigned long

fedId

)

[virtual]

References DtNetWwwControlMsg::federateHandle, and netWwwControlMsg().

Referenced by DtWwwControlMsg(), DtWwwClientProtocol::parseCommand(), and DtTcpWwwSpyAdapter::sendTypeInfo().

unsigned long DtWwwControlMsg::targetFederateHandle

(

)

const [virtual]

Set/Get target federate ID (if specified)

References DtNetWwwControlMsg::federateHandle, and netWwwControlMsg().

Referenced by DtRtiExecWebManager::issueStateRequest(), and printData().

---

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

• wwwControlMsg.h
• wwwControlMsg.cxx