DtWwwControlRspMsg Class Reference

The DtWwwControlRspMsg defines a wrapper for the WebSpy messages in response to DtWwwControlMsgs. More...

Inheritance diagram for DtWwwControlRspMsg:

Collaboration diagram for DtWwwControlRspMsg:

List of all members.

Public Types
typedef std::vector< std::pair < MAKRti::DtString, MAKRti::DtString > >	ParameterValuePairList
Public Member Functions
	DtWwwControlRspMsg (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Constructor.
	DtWwwControlRspMsg (unsigned long commandId, unsigned long connId, unsigned long fedexId, unsigned long fedId, const MAKRti::DtString &xml, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Constructor.
	DtWwwControlRspMsg (const DtNetWwwControlMsg *netRep, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Constructor.
virtual	~DtWwwControlRspMsg ()
	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	sourceFederateHandle () const
	Set/Get target/source federate ID (if specified)
virtual void	setSourceFederateHandle (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, DtWwwControlRspCb cb, void *usr)
	Callback management.
static void	removeCallback (DtConnectionMgr *conn, DtWwwControlRspCb cb, void *usr)
Protected Member Functions
virtual DtNetWwwControlMsg *	netWwwControlRspMsg ()
	The network representation.
virtual const DtNetWwwControlMsg *	netWwwControlRspMsg () const
virtual DtRtiMsgKind	internalDtRtiMsgKind ()
	Returns the kind of an DtWwwControlRspMsg 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 DtWwwControlRspMsg defines a wrapper for the WebSpy messages in response to DtWwwControlMsgs.

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 > > DtWwwControlRspMsg::ParameterValuePairList

---

Constructor & Destructor Documentation

DtWwwControlRspMsg::DtWwwControlRspMsg

(

DtBufferPtr

buffer = DtUSE_INTERNAL_BUFFER

)

Constructor.

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

Referenced by clone(), and create().

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

Constructor.

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

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

Constructor.

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

DtWwwControlRspMsg::~DtWwwControlRspMsg

(

)

[virtual]

Destructor.

---

Member Function Documentation

void DtWwwControlRspMsg::addCallback	(	DtConnectionMgr *	conn,
		DtWwwControlRspCb	cb,
		void *	usr
	)		[static]

Callback management.

References DtConnectionMgr::addMsgCallback(), and DtWwwControlRspMsgKind.

DtRtiMsg * DtWwwControlRspMsg::clone

(

bool

copy = true

)

const [virtual]

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

Implements DtRtiMsg.

References DtWwwControlRspMsg(), and netWwwControlRspMsg().

MAKRti::DtString DtWwwControlRspMsg::command

(

)

const [virtual]

Set/Get the command data.

References netMsgCommand().

Referenced by DtWwwClientProtocol::parseControlMsg(), and printData().

unsigned long DtWwwControlRspMsg::commandId

(

)

const [virtual]

Set/Get command ID.

References DtNetWwwControlMsg::commandId, and netWwwControlRspMsg().

Referenced by printData(), and DtRtiexecObserverForWebService::processControlRspMsg().

unsigned long DtWwwControlRspMsg::connectionId

(

)

const [virtual]

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

References DtNetWwwControlMsg::connectionId, and netWwwControlRspMsg().

Referenced by DtWwwClientProtocol::parseControlMsg(), and DtRtiexecObserverForWebService::processControlRspMsg().

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

Creator.

References DtWwwControlRspMsg().

DtRtiMsg * DtWwwControlRspMsg::create

(

DtBufferPtr

buffer = DtUSE_INTERNAL_BUFFER

)

[static]

References DtWwwControlRspMsg().

DtRtiMsgKind DtWwwControlRspMsg::internalDtRtiMsgKind

(

)

[protected, virtual]

Returns the kind of an DtWwwControlRspMsg Msg.

Implements DtRtiMsg.

References DtWwwControlRspMsgKind.

Referenced by DtWwwControlRspMsg().

int DtWwwControlRspMsg::minSize

(

)

const [protected, virtual]

Returns minimum size of a message, including header.

Referenced by DtWwwControlRspMsg().

char * DtWwwControlRspMsg::netMsgCommand

(

)

[protected, virtual]

Get a pointer to the message payload.

References DtNetWwwControlMsg::commandLength, and netWwwControlRspMsg().

Referenced by command(), and setCommand().

const char * DtWwwControlRspMsg::netMsgCommand

(

)

const [protected, virtual]

References DtNetWwwControlMsg::commandLength, and netWwwControlRspMsg().

DtNetWwwControlMsg * DtWwwControlRspMsg::netWwwControlRspMsg

(

)

[protected, virtual]

The network representation.

Referenced by clone(), commandId(), connectionId(), netMsgCommand(), setCommand(), setCommandId(), setConnectionId(), setSourceFederateHandle(), and sourceFederateHandle().

const DtNetWwwControlMsg * DtWwwControlRspMsg::netWwwControlRspMsg

(

)

const [protected, virtual]

void DtWwwControlRspMsg::printData

(

DtLogicalTimeFactory *

logicalTimeFactory

)

const [virtual]

Print the data section.

Reimplemented from DtRtiMsg.

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

void DtWwwControlRspMsg::removeCallback	(	DtConnectionMgr *	conn,
		DtWwwControlRspCb	cb,
		void *	usr
	)		[static]

References DtWwwControlRspMsgKind, and DtConnectionMgr::removeMsgCallback().

void DtWwwControlRspMsg::setCommand

(

const MAKRti::DtString &

command

)

[virtual]

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

Referenced by DtWwwControlRspMsg().

void DtWwwControlRspMsg::setCommandId

(

unsigned long

commandId

)

[virtual]

References DtNetWwwControlMsg::commandId, and netWwwControlRspMsg().

Referenced by DtWwwControlRspMsg().

void DtWwwControlRspMsg::setConnectionId

(

unsigned long

connId

)

[virtual]

References DtNetWwwControlMsg::connectionId, and netWwwControlRspMsg().

Referenced by DtWwwControlRspMsg().

void DtWwwControlRspMsg::setSourceFederateHandle

(

unsigned long

fedId

)

[virtual]

References DtNetWwwControlMsg::federateHandle, and netWwwControlRspMsg().

Referenced by DtWwwControlRspMsg().

unsigned long DtWwwControlRspMsg::sourceFederateHandle

(

)

const [virtual]

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

References DtNetWwwControlMsg::federateHandle, and netWwwControlRspMsg().

Referenced by printData(), and DtRtiexecObserverForWebService::processControlRspMsg().

---

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

• wwwControlRspMsg.h
• wwwControlRspMsg.cxx