WsfXIO_Subscription Class Reference

A WsfXIO_Subscription wraps information about a remote request for information. More...

#include <WsfXIO_Subscription.hpp>

Public Member Functions
	WsfXIO_Subscription (WsfXIO_Connection *aConnectionPtr)
	WsfXIO_Subscription (WsfXIO_RequestDataPkt &aRequest)
	~WsfXIO_Subscription ()
void	Initialize (WsfXIO_Service *aProviderPtr)
WsfXIO_SubscriptionId	GetId () const
	Returns a unique value identifying this subscription.
int	GetRequestId () const
int	GetConnectionId () const
WsfXIO_Service *	GetService () const
	Returns the service providing this subscription.
void	SetUserCancelled (bool aHasCancelled)
	Returns true if the user has canceled this connection remotely.
bool	HasUserCancelled () const
	Sets the 'User Canceled' flag value.
WsfXIO_Connection *	GetDataConnection () const
	Returns the connection used to send data to the requesting application.
WsfXIO_Connection &	GetConnection () const
	Returns the reliable connection used for control messages for this subscription.
void	SendResponse (WsfXIO_ResponsePkt &aPkt)
	Sends a response packet to the requestor of this subscription.
WsfXIO_Interface &	GetInterface () const

Detailed Description

A WsfXIO_Subscription wraps information about a remote request for information.

Constructor & Destructor Documentation

WsfXIO_Subscription() [1/2]

WsfXIO_Subscription::WsfXIO_Subscription

(

WsfXIO_Connection *

aConnectionPtr

)

WsfXIO_Subscription() [2/2]

WsfXIO_Subscription::WsfXIO_Subscription

(

WsfXIO_RequestDataPkt &

aRequest

)

References if(), WsfXIO_RequestDataPkt::mReliable, and WsfXIO_RequestDataPkt::mSubscriptionRequestId.

~WsfXIO_Subscription()

WsfXIO_Subscription::~WsfXIO_Subscription

(

)

Member Function Documentation

GetConnection()

WsfXIO_Connection & WsfXIO_Subscription::GetConnection ( ) const

inline

Returns the reliable connection used for control messages for this subscription.

Referenced by WsfXIO_MessageService::HandleMessage(), WsfXIO_Service::RemoveSubscription(), WsfXIO_TaskService::SendInitial(), SendResponse(), WsfXIO_PlatformInfoService::SendTrackManagerState(), and WsfXIO_PlatformListService::SubscriptionCancelled().

GetConnectionId()

int WsfXIO_Subscription::GetConnectionId ( ) const

inline

Returns the unique ID for the connection controlling the subscription This value combined with the SubscriptionId creates a unique identifier

GetDataConnection()

WsfXIO_Connection * WsfXIO_Subscription::GetDataConnection ( ) const

inline

Returns the connection used to send data to the requesting application.

Referenced by WsfXIO_DrawService::HandleRequest(), WsfXIO_PlatformInfoService::HandleRequest(), WsfXIO_PlatformPartInfoService::HandleRequest(), WsfXIO_DrawService::SubscriptionCancelled(), WsfXIO_PlatformInfoService::SubscriptionCancelledT(), WsfXIO_PlatformPartInfoService::SubscriptionCancelledT(), and WsfXIO_TrackService::SubscriptionCancelledT().

GetId()

WsfXIO_SubscriptionId WsfXIO_Subscription::GetId ( ) const

inline

Returns a unique value identifying this subscription.

Referenced by WsfXIO_RequestManager::AddSession(), WsfXIO_Service::AddSubscription(), WsfXIO_ServiceT< WsfXIO_RequestPlatformInfoPkt, WsfXIO_SimService >::CreateSubscription(), WsfXIO_SessionServiceT< SESSION_TYPE, REQUEST_TYPE, SERVICE_TYPE >::CreateSubscription(), WsfXIO_PlatformInfoService::HandleRequest(), WsfXIO_SimTimeService::HandleRequest(), WsfXIO_RequestManager::RemoveSession(), WsfXIO_Service::RemoveSubscription(), WsfXIO_SensorService::RequestCanceled(), WsfXIO_SensorService::RequestUpdated(), WsfXIO_SensorService::SensorTurnedOff(), WsfXIO_ServiceT< WsfXIO_RequestPlatformInfoPkt, WsfXIO_SimService >::SubscriptionCancelled(), WsfXIO_SessionServiceT< SESSION_TYPE, REQUEST_TYPE, SERVICE_TYPE >::SubscriptionCancelled(), and WsfXIO_SimTimeService::SubscriptionCancelled().

GetInterface()

WsfXIO_Interface & WsfXIO_Subscription::GetInterface

(

)

const

GetRequestId()

int WsfXIO_Subscription::GetRequestId ( ) const

inline

Returns the subscription ID. This ID is unique for a given application, but not necessarily unique across all applications.

Referenced by WsfXIO_PlatformInfoService::HandleRequest(), WsfXIO_Service::RemoveSubscription(), WsfXIO_TaskService::SendInitial(), WsfXIO_PlatformInfoService::SendPartState(), SendResponse(), and WsfXIO_PlatformInfoService::SendTrackManagerState().

GetService()

WsfXIO_Service * WsfXIO_Subscription::GetService ( ) const

inline

Returns the service providing this subscription.

HasUserCancelled()

bool WsfXIO_Subscription::HasUserCancelled ( ) const

inline

Sets the 'User Canceled' flag value.

Referenced by WsfXIO_Service::RemoveSubscription().

Initialize()

void WsfXIO_Subscription::Initialize

(

WsfXIO_Service *

aProviderPtr

)

Referenced by WsfXIO_Service::AddSubscription().

SendResponse()

void WsfXIO_Subscription::SendResponse

(

WsfXIO_ResponsePkt &

aPkt

)

Sends a response packet to the requestor of this subscription.

References GetConnection(), GetRequestId(), WsfXIO_ResponsePkt::mFromProvider, WsfXIO_ResponsePkt::mRequestId, and WsfXIO_Connection::Send().

Referenced by WsfXIO_PlatformInfoService::HandleRequest(), WsfXIO_SensorService::HandleRequest(), WsfXIO_ScriptService::HandleScriptCommand(), WsfXIO_SensorService::RequestCanceled(), WsfXIO_SensorService::RequestUpdated(), WsfXIO_PlatformInfoService::SendCommandChain(), WsfXIO_PlatformInfoService::EvaluateDeadReckoningEvent::SendState(), WsfXIO_ScriptService::SendState(), WsfXIO_SimTimeService::SendTimeStateToAll(), WsfXIO_SensorService::SensorTurnedOff(), and WsfXIO_SimTimeService::UpdateRequestInterval().

SetUserCancelled()

void WsfXIO_Subscription::SetUserCancelled ( bool aHasCancelled )

inline

Returns true if the user has canceled this connection remotely.

Referenced by WsfXIO_Service::HandleCancellation(), and WsfXIO_Service::HandleDisconnect().

---

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

• WsfXIO_Subscription.hpp
• WsfXIO_Subscription.cpp