WsfXIO_Service Class Reference

#include <WsfXIO_Service.hpp>

Inheritance diagram for WsfXIO_Service:

Collaboration diagram for WsfXIO_Service:

Public Member Functions
	WsfXIO_Service (WsfXIO_Interface *aInterfacePtr)
virtual	~WsfXIO_Service ()
WsfXIO_Subscription *	FindSubscription (WsfXIO_Connection *aConnectionPtr, int aSubscriptionId)
WsfXIO_Interface *	GetInterface () const

Protected Types
using	SubscriptionMap = std::map<WsfXIO_SubscriptionId, WsfXIO_Subscription*>

Protected Member Functions
void	DenyRequest (WsfXIO_RequestDataPkt &aRequest)
void	HandleDisconnect (WsfXIO_Connection *aConnection)
void	AddSubscription (WsfXIO_Subscription *aSubscriptionPtr)
bool	RemoveSubscription (WsfXIO_Subscription *aSubscriptionPtr)
WsfXIO_Subscription *	CreateSubscription (WsfXIO_RequestDataPkt &aRequest)
void	HandleCancellation (WsfXIO_SubscriptionCancelPkt &aPkt)
virtual void	SubscriptionCancelled (WsfXIO_Subscription *aSubscriptionPtr)
const SubscriptionMap	GetSubscriptions () const
WsfXIO_Subscription *	FindSubscription (const WsfXIO_SubscriptionId &aSubscriptionId)
virtual void	RemovingSubscription (WsfXIO_Subscription *aSubscriptionPtr)

Protected Attributes
UtCallbackHolder	mCallbacks
WsfXIO_Interface *	mInterfacePtr

Detailed Description

Provides basic functionality for handling WsfXIO_Requests Generally, only a single service of each type is used. See WsfXIO_ServiceSession to create a new object for each active request.

Member Typedef Documentation

SubscriptionMap

using WsfXIO_Service::SubscriptionMap = std::map<WsfXIO_SubscriptionId, WsfXIO_Subscription*>

protected

Constructor & Destructor Documentation

WsfXIO_Service()

WsfXIO_Service::WsfXIO_Service

(

WsfXIO_Interface *

aInterfacePtr

)

References HandleCancellation(), HandleDisconnect(), mCallbacks, and mInterfacePtr.

Referenced by WsfXIO_DisService::WsfXIO_DisService(), WsfXIO_DrawService::WsfXIO_DrawService(), WsfXIO_MessageService::WsfXIO_MessageService(), WsfXIO_PlatformListService::WsfXIO_PlatformListService(), WsfXIO_SimService::WsfXIO_SimService(), and WsfXIO_TaskService::WsfXIO_TaskService().

~WsfXIO_Service()

WsfXIO_Service::~WsfXIO_Service ( )

virtual

Member Function Documentation

AddSubscription()

void WsfXIO_Service::AddSubscription ( WsfXIO_Subscription * aSubscriptionPtr )

protected

References WsfXIO_Subscription::GetId(), and WsfXIO_Subscription::Initialize().

Referenced by CreateSubscription().

CreateSubscription()

WsfXIO_Subscription * WsfXIO_Service::CreateSubscription ( WsfXIO_RequestDataPkt & aRequest )

protected

References AddSubscription().

Referenced by WsfXIO_DrawService::HandleRequest(), WsfXIO_MessageService::HandleRequest(), WsfXIO_SimTimeService::HandleRequest(), and WsfXIO_TaskService::HandleRequest().

DenyRequest()

void WsfXIO_Service::DenyRequest ( WsfXIO_RequestDataPkt & aRequest )

protected

References WsfXIO_SubscriptionCancelPkt::mIsRequest, WsfXIO_SubscriptionCancelPkt::mSubscriptionId, WsfXIO_RequestDataPkt::mSubscriptionRequestId, and WsfXIO_Connection::Send().

Referenced by WsfXIO_PlatformInfoService::HandleRequest(), WsfXIO_PlatformPartInfoService::HandleRequest(), WsfXIO_ScriptService::HandleRequest(), WsfXIO_SensorService::HandleRequest(), and WsfXIO_TaskService::HandleRequest().

FindSubscription() [1/2]

WsfXIO_Subscription * WsfXIO_Service::FindSubscription ( const WsfXIO_SubscriptionId & aSubscriptionId )

protected

FindSubscription() [2/2]

WsfXIO_Subscription * WsfXIO_Service::FindSubscription	(	WsfXIO_Connection *	aConnectionPtr,
		int	aSubscriptionId )

Returns a pointer to a subscription

Parameters

aConnectionPtr	A connection to the application that requested the subscription
aSubscriptionId	The ID of the subscription.

References WsfXIO_Connection::GetConnectionId().

Referenced by HandleCancellation(), and WsfXIO_SimTimeService::UpdateRequestInterval().

GetInterface()

WsfXIO_Interface * WsfXIO_Service::GetInterface ( ) const

inline

References mInterfacePtr.

Referenced by WsfXIO_ScriptService::OnUpdate(), WsfXIO_ScriptService::UpdateWhileAtBreak(), WsfXIO_DisService::WsfXIO_DisService(), WsfXIO_DrawService::WsfXIO_DrawService(), WsfXIO_MessageService::WsfXIO_MessageService(), WsfXIO_PlatformInfoService::WsfXIO_PlatformInfoService(), WsfXIO_PlatformListService::WsfXIO_PlatformListService(), WsfXIO_PlatformPartInfoService::WsfXIO_PlatformPartInfoService(), WsfXIO_ScriptService::WsfXIO_ScriptService(), WsfXIO_SensorService::WsfXIO_SensorService(), WsfXIO_SimTimeService::WsfXIO_SimTimeService(), WsfXIO_TaskService::WsfXIO_TaskService(), and WsfXIO_TrackService::WsfXIO_TrackService().

GetSubscriptions()

const SubscriptionMap WsfXIO_Service::GetSubscriptions ( ) const

inlineprotected

Referenced by WsfXIO_ScriptService::GetSubscription(), WsfXIO_SimTimeService::SendTimeStateToAll(), WsfXIO_TaskService::TaskAccepted(), WsfXIO_TaskService::TaskAssigned(), WsfXIO_TaskService::TaskCanceled(), and WsfXIO_TaskService::TaskCompleted().

HandleCancellation()

void WsfXIO_Service::HandleCancellation ( WsfXIO_SubscriptionCancelPkt & aPkt )

protected

References FindSubscription(), WsfXIO_SubscriptionCancelPkt::mIsRequest, WsfXIO_SubscriptionCancelPkt::mSubscriptionId, WsfXIO_Subscription::SetUserCancelled(), and SubscriptionCancelled().

Referenced by WsfXIO_Service().

HandleDisconnect()

void WsfXIO_Service::HandleDisconnect ( WsfXIO_Connection * aConnection )

protected

References WsfXIO_Connection::GetConnectionId(), WsfXIO_Subscription::SetUserCancelled(), and SubscriptionCancelled().

Referenced by WsfXIO_Service().

RemoveSubscription()

bool WsfXIO_Service::RemoveSubscription ( WsfXIO_Subscription * aSubscriptionPtr )

protected

References WsfXIO_Subscription::GetConnection(), WsfXIO_Subscription::GetId(), WsfXIO_Subscription::GetRequestId(), WsfXIO_Subscription::HasUserCancelled(), WsfXIO_SubscriptionCancelPkt::mIsRequest, WsfXIO_SubscriptionCancelPkt::mSubscriptionId, RemovingSubscription(), and WsfXIO_Connection::Send().

Referenced by SubscriptionCancelled().

RemovingSubscription()

virtual void WsfXIO_Service::RemovingSubscription ( WsfXIO_Subscription * aSubscriptionPtr )

inlineprotectedvirtual

Reimplemented in WsfXIO_SimService.

Referenced by RemoveSubscription().

SubscriptionCancelled()

void WsfXIO_Service::SubscriptionCancelled ( WsfXIO_Subscription * aSubscriptionPtr )

protectedvirtual

Reimplemented in WsfXIO_DrawService, WsfXIO_MessageService, WsfXIO_PlatformListService, WsfXIO_ServiceT< T, SERVICE_TYPE >, WsfXIO_ServiceT< WsfXIO_RequestPlatformInfoPkt, WsfXIO_SimService >, WsfXIO_ServiceT< WsfXIO_RequestPlatformPartInfoPkt, WsfXIO_SimService >, WsfXIO_ServiceT< WsfXIO_RequestScriptSessionPkt, WsfXIO_SimService >, WsfXIO_ServiceT< WsfXIO_RequestSensorDataPkt, WsfXIO_SimService >, WsfXIO_ServiceT< WsfXIO_RequestTracksPkt, WsfXIO_SimService >, WsfXIO_SimTimeService, and WsfXIO_TaskService.

References RemoveSubscription().

Referenced by HandleCancellation(), HandleDisconnect(), and WsfXIO_SimTimeService::SubscriptionCancelled().

Member Data Documentation

mCallbacks

UtCallbackHolder WsfXIO_Service::mCallbacks

protected

Referenced by WsfXIO_SimService::Initialize(), WsfXIO_DisService::WsfXIO_DisService(), WsfXIO_DrawService::WsfXIO_DrawService(), WsfXIO_MessageService::WsfXIO_MessageService(), WsfXIO_PlatformInfoService::WsfXIO_PlatformInfoService(), WsfXIO_PlatformListService::WsfXIO_PlatformListService(), WsfXIO_PlatformPartInfoService::WsfXIO_PlatformPartInfoService(), WsfXIO_SensorService::WsfXIO_SensorService(), WsfXIO_Service(), WsfXIO_SimTimeService::WsfXIO_SimTimeService(), and WsfXIO_TaskService::WsfXIO_TaskService().

mInterfacePtr

WsfXIO_Interface* WsfXIO_Service::mInterfacePtr

protected

Referenced by GetInterface(), WsfXIO_DisService::WsfXIO_DisService(), WsfXIO_DrawService::WsfXIO_DrawService(), WsfXIO_PlatformInfoService::WsfXIO_PlatformInfoService(), and WsfXIO_Service().

---

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

• WsfXIO_Service.hpp
• WsfXIO_Service.cpp