WSF: WsfXIO_Request Class Reference

WSF

#include <WsfXIO_Request.hpp>

Inheritance diagram for WsfXIO_Request:

Inheritance graph

[legend]

Public Member Functions
	WsfXIO_Request (WsfXIO_Connection *aConnectionPtr, bool aIsReliable=true)
virtual void	HandleResponse (WsfXIO_ResponsePkt &aPkt)
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
virtual	~WsfXIO_Request ()
virtual void	Initialized ()=0
void	SetRequestId (unsigned int aRequestId)
void	SetRemotelyDestroyed ()
bool	IsRemotelyDestroyed () const
void	SetIsReliable (bool aIsReliable)

Friends
class	WsfXIO_RequestManager

Detailed Description

WsfXIO_Request maintains the lifetime of a subscription request. WsfXIO_Request is destroyed when the subscription is no longer available

Constructor & Destructor Documentation

◆ WsfXIO_Request()

WsfXIO_Request::WsfXIO_Request	(	WsfXIO_Connection *	aConnectionPtr,
		bool	aIsReliable = true )

Referenced by WsfXIO_DisRequest::WsfXIO_DisRequest(), WsfXIO_DrawRequest::WsfXIO_DrawRequest(), WsfXIO_MessageRequest::WsfXIO_MessageRequest(), WsfXIO_PlatformInfoRequest::WsfXIO_PlatformInfoRequest(), WsfXIO_PlatformListRequest::WsfXIO_PlatformListRequest(), WsfXIO_PlatformPartInfoRequest::WsfXIO_PlatformPartInfoRequest(), WsfXIO_RequestManager, WsfXIO_SensorDataRequest::WsfXIO_SensorDataRequest(), WsfXIO_SimTimeRequest::WsfXIO_SimTimeRequest(), WsfXIO_TaskRequest::WsfXIO_TaskRequest(), and WsfXIO_TrackRequest::WsfXIO_TrackRequest().

◆ ~WsfXIO_Request()

WsfXIO_Request::~WsfXIO_Request ( )

protectedvirtual

Member Function Documentation

◆ GetConnection()

WsfXIO_Connection * WsfXIO_Request::GetConnection ( ) const

inline

Returns the connection to the application from which data is requested.

Referenced by WsfXIO_TrackRequestManager::AddRequest(), WsfXIO_PlatformListRequest::Initialized(), WsfXIO_RequestManager::RequestCancelled(), WsfXIO_TrackRequestManager::RequestCancelled(), and WsfXIO_TimeSynchronization::~WsfXIO_TimeSynchronization().

◆ GetRequestId()

int WsfXIO_Request::GetRequestId ( ) const

inline

Returns the request's locally unique ID.

Referenced by WsfXIO_RequestManager::RequestCancelled().

◆ HandleResponse()

virtual void WsfXIO_Request::HandleResponse ( WsfXIO_ResponsePkt & aPkt )

inlinevirtual

Reimplemented in WsfXIO_TaskRequest, WsfXIO_TimeSynchronization, and WsfXIO_TrackRequest.

◆ Initialized()

virtual void WsfXIO_Request::Initialized ( )

protectedpure virtual

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

Implemented in WsfXIO_DisRequest, WsfXIO_DrawRequest, WsfXIO_PlatformInfoRequest, WsfXIO_PlatformListRequest, WsfXIO_PlatformPartInfoRequest, WsfXIO_TaskRequest, and WsfXIO_TrackRequest.

Referenced by WsfXIO_RequestManager::AddRequest().

◆ IsReliable()

bool WsfXIO_Request::IsReliable ( ) const

inline

Returns 'true' if data for this request is to be sent reliably.

◆ IsRemotelyDestroyed()

bool WsfXIO_Request::IsRemotelyDestroyed ( ) const

inlineprotected

Referenced by WsfXIO_RequestManager::RequestCancelled().

◆ SendRequest()

void WsfXIO_Request::SendRequest ( WsfXIO_RequestDataPkt & aPkt )

Sends the request to the remote application.

References WsfXIO_RequestDataPkt::mReliable, and WsfXIO_RequestDataPkt::mSubscriptionRequestId.

Referenced by WsfXIO_DisRequest::Initialized(), WsfXIO_DrawRequest::Initialized(), WsfXIO_PlatformInfoRequest::Initialized(), WsfXIO_PlatformListRequest::Initialized(), WsfXIO_PlatformPartInfoRequest::Initialized(), WsfXIO_TaskRequest::Initialized(), and WsfXIO_TrackRequest::Initialized().

◆ SendResponse()

void WsfXIO_Request::SendResponse ( WsfXIO_ResponsePkt & aPkt )

Sends a 'response' message to the service. Can only be used after the request has been initialized

References WsfXIO_ResponsePkt::mFromProvider, and WsfXIO_ResponsePkt::mRequestId.

◆ SetIsReliable()

void WsfXIO_Request::SetIsReliable ( bool aIsReliable )

inlineprotected

Referenced by WsfXIO_PlatformListRequest::Initialized().

◆ SetRemotelyDestroyed()

void WsfXIO_Request::SetRemotelyDestroyed ( )

inlineprotected

Referenced by WsfXIO_RequestManager::HandleCancel(), and WsfXIO_RequestManager::HandleDisconnect().

◆ SetRequestId()

void WsfXIO_Request::SetRequestId ( unsigned int aRequestId )

inlineprotected

Referenced by WsfXIO_RequestManager::AddRequest().

◆ SetRequestManager()

void WsfXIO_Request::SetRequestManager ( WsfXIO_RequestManager * aRequestManagerPtr )

inline

Sets the owner of this request.

References WsfXIO_RequestManager.

Referenced by WsfXIO_RequestManager::AddRequest().

◆ WsfXIO_RequestManager

friend class WsfXIO_RequestManager

friend

References WsfXIO_Request(), and WsfXIO_RequestManager.

Referenced by SetRequestManager(), and WsfXIO_RequestManager.

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

Copyrights Multiple, All Rights Reserved