#include <WsfXIO_PacketRegistry.hpp>

Inheritance diagram for WsfXIO_ResponsePkt:

[legend]

Collaboration diagram for WsfXIO_ResponsePkt:

Public Member Functions
	XIO_DEFINE_PACKET_CTOR (WsfXIO_ResponsePkt, WsfXIO_Packet, 5)
	mFromProvider (false)
	mCompletesRequest (false)
	mRequestId (0)
	XIO_DEFINE_PACKET_SERIALIZE ()
Public Member Functions inherited from WsfXIO_Packet
	WsfXIO_Packet (int aPacketId)
template<typename T>
void	Serialize (T &aBuff)
	Serializes the packet header. Must be called first from derived class Serialize().
float	GetTimeStamp () const
void	SetTimeStamp (float aTimeStamp)
void	SetFlags (uint32_t aFlags)
void	AddFlags (uint32_t aFlags)
uint32_t	GetFlags () const

Public Attributes
bool	mFromProvider
bool	mCompletesRequest
	If true, the receipt of this response indicates the request has been satisfied and should be closed.
int32_t	mRequestId
	Request ID. If this is 0, the packet is for any receiver.
Public Attributes inherited from WsfXIO_Packet
GenUniqueId	mApplicationId

Additional Inherited Members
Public Types inherited from WsfXIO_Packet
enum	PacketFlags { cSYNCHRONIZED = 1 }
typedef bool	BaseType
Static Public Attributes inherited from WsfXIO_Packet
static const int	cPACKET_ID = -1
Protected Attributes inherited from WsfXIO_Packet
uint32_t	mFlags
float	mTimeStamp

Detailed Description

Base class for packets that communicate between a WsfXIO_Request and WsfXIO_ServiceSession. Usage of this packet type provides automatic routing back to the requester or session.

Member Function Documentation

◆ mCompletesRequest()

WsfXIO_ResponsePkt::mCompletesRequest ( false )

References mFromProvider, and WsfXIO_Packet::WsfXIO_Packet().

◆ mFromProvider()

WsfXIO_ResponsePkt::mFromProvider ( false )

◆ mRequestId()

WsfXIO_ResponsePkt::mRequestId ( 0 )

inline

◆ XIO_DEFINE_PACKET_CTOR()

WsfXIO_ResponsePkt::XIO_DEFINE_PACKET_CTOR	(	WsfXIO_ResponsePkt	,
		WsfXIO_Packet	,
		5	)

◆ XIO_DEFINE_PACKET_SERIALIZE()

WsfXIO_ResponsePkt::XIO_DEFINE_PACKET_SERIALIZE ( )

inline

References mCompletesRequest, mFromProvider, and mRequestId.

Member Data Documentation

◆ mCompletesRequest

bool WsfXIO_ResponsePkt::mCompletesRequest

If true, the receipt of this response indicates the request has been satisfied and should be closed.

Referenced by WsfXIO_RequestManager::HandleRequestResponse(), WsfXIO_RequestScriptDataResponsePkt::XIO_DEFINE_PACKET_CTOR(), and XIO_DEFINE_PACKET_SERIALIZE().

◆ mFromProvider

bool WsfXIO_ResponsePkt::mFromProvider

Referenced by WsfXIO_RequestManager::HandleRequestResponse(), WsfXIO_ScriptService::HandleScriptDataRequest(), mCompletesRequest(), WsfXIO_Request::SendResponse(), WsfXIO_Subscription::SendResponse(), and XIO_DEFINE_PACKET_SERIALIZE().

◆ mRequestId

int32_t WsfXIO_ResponsePkt::mRequestId

Request ID. If this is 0, the packet is for any receiver.

Referenced by WsfXIO_TrackRequestManager::HandleDropTrack(), WsfXIO_TrackRequestManager::HandleLocalTrack(), WsfXIO_TrackRequestManager::HandleRawTrack(), WsfXIO_PlatformInfoService::HandleRequest(), WsfXIO_RequestManager::HandleRequestResponse(), WsfXIO_ScriptService::HandleScriptDataRequest(), WsfXIO_TaskService::SendInitial(), WsfXIO_PlatformInfoService::SendPartState(), WsfXIO_Request::SendResponse(), WsfXIO_Subscription::SendResponse(), WsfXIO_PlatformInfoService::SendTrackManagerState(), and XIO_DEFINE_PACKET_SERIALIZE().

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

WsfXIO_PacketRegistry.hpp

Public Member Functions

Public Attributes

Additional Inherited Members