WsfXIO_TaskRequest Class Reference

#include <WsfXIO_TaskRequest.hpp>

Inheritance diagram for WsfXIO_TaskRequest:

Collaboration diagram for WsfXIO_TaskRequest:

Public Member Functions
	WsfXIO_TaskRequest (WsfXIO_Connection *aConnectionPtr, unsigned int aPlatformIndex, WsfStringId aProcessorName, bool aTakeControl=false, bool aIsReliable=true)
virtual void	HandleInitialize (WsfXIO_TaskInitPkt &aPkt)=0
virtual void	HandleUpdate (WsfXIO_TaskUpdatePkt &aPkt)=0
Public Member Functions inherited from WsfXIO_Request
	WsfXIO_Request (WsfXIO_Connection *aConnectionPtr, bool aIsReliable=true)
void	SendRequest (WsfXIO_RequestDataPkt &aPkt)
	Sends the request to the remote application.
WsfXIO_Connection *	GetConnection () const
	Returns the connection to the application from which data is requested.
bool	IsReliable () const
	Returns 'true' if data for this request is to be sent reliably.
int	GetRequestId () const
	Returns the request's locally unique ID.
void	SetRequestManager (WsfXIO_RequestManager *aRequestManagerPtr)
	Sets the owner of this request.
void	SendResponse (WsfXIO_ResponsePkt &aPkt)

Protected Member Functions
void	HandleResponse (WsfXIO_ResponsePkt &aPkt) override
void	Initialized () override
Protected Member Functions inherited from WsfXIO_Request
virtual	~WsfXIO_Request ()
void	SetRequestId (unsigned int aRequestId)
void	SetRemotelyDestroyed ()
bool	IsRemotelyDestroyed () const
void	SetIsReliable (bool aIsReliable)

Protected Attributes
bool	mTakeControl
unsigned int	mPlatformIndex
WsfStringId	mProcessorName

Constructor & Destructor Documentation

WsfXIO_TaskRequest()

WsfXIO_TaskRequest::WsfXIO_TaskRequest	(	WsfXIO_Connection *	aConnectionPtr,
		unsigned int	aPlatformIndex,
		WsfStringId	aProcessorName,
		bool	aTakeControl = false,
		bool	aIsReliable = true )

References mPlatformIndex, mProcessorName, mTakeControl, and WsfXIO_Request::WsfXIO_Request().

Member Function Documentation

HandleInitialize()

virtual void WsfXIO_TaskRequest::HandleInitialize ( WsfXIO_TaskInitPkt & aPkt )

pure virtual

Referenced by HandleResponse().

HandleResponse()

void WsfXIO_TaskRequest::HandleResponse ( WsfXIO_ResponsePkt & aPkt )

overrideprotectedvirtual

Reimplemented from WsfXIO_Request.

References WsfXIO_Packet::cPACKET_ID, HandleInitialize(), and HandleUpdate().

HandleUpdate()

virtual void WsfXIO_TaskRequest::HandleUpdate ( WsfXIO_TaskUpdatePkt & aPkt )

pure virtual

Referenced by HandleResponse().

Initialized()

void WsfXIO_TaskRequest::Initialized ( )

overrideprotectedvirtual

Called from the WsfXIO_RequestManager indicating that the request message is ready to be sent SendRequest() should be done from Initialized()

Implements WsfXIO_Request.

References mPlatformIndex, WsfXIO_TaskRequestPkt::mPlatformIndex, mProcessorName, mTakeControl, WsfXIO_TaskRequestPkt::mTakeControl, WsfXIO_TaskRequestPkt::mTaskProcessorName, and WsfXIO_Request::SendRequest().

Member Data Documentation

mPlatformIndex

unsigned int WsfXIO_TaskRequest::mPlatformIndex

protected

Referenced by Initialized(), and WsfXIO_TaskRequest().

mProcessorName

WsfStringId WsfXIO_TaskRequest::mProcessorName

protected

Referenced by Initialized(), and WsfXIO_TaskRequest().

mTakeControl

bool WsfXIO_TaskRequest::mTakeControl

protected

Referenced by Initialized(), and WsfXIO_TaskRequest().

---

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

• WsfXIO_TaskRequest.hpp
• WsfXIO_TaskRequest.cpp