#include <WsfXIO_Connection.hpp>

Inherits PakConnection, and UtReferenceTracked.

Public Member Functions
WsfXIO_Connection *	GetLinkedConnection () const
void	SetLinkedConnection (WsfXIO_Connection *aConnectionPtr)
	Sets the linked connection.
PakSocketIO &	GetIO () const
	Returns the IO Device used in this connection.
PakTCP_IO *	GetTCP_IO () const
	Returns the GenTCP_IO is this connection uses TCP, returns null otherwise.
PakUDP_IO *	GetUDP_IO () const
	Returns the GenUDP_IO is this connection uses UDP, returns null otherwise.
WsfXIO_Interface &	GetInterface ()
	Returns the associated WsfXIO_Interface.
wsf::xio::ApplicationType	GetApplicationType () const
	Returns the application type.
void	SetApplicationType (wsf::xio::ApplicationType aApplicationType)
	Sets the application type.
void	Send (WsfXIO_Packet &aPkt)
	Sends a packet to this connection.
int	GetConnectionId () const
	Returns a locally unique identifier for this connection.
const std::string &	GetApplicationName () const
	Returns the name of the connected application.
void	SetApplicationName (const std::string &aApplicationName)
	Sets the name of the connected application.
void	SetApplicationId (GenUniqueId &aApplicationId)
	Sets the application ID.
GenUniqueId	GetApplicationId () const
bool	IsReliable () const
	Returns true if the connection is reliable.
void	SetInitialized ()
	Specifies that the connection is initialized.
bool	IsInitialized () const
	Returns 'true' if the connection is initialized.
bool	IsDisconnecting () const
	Returns 'true' if the connection is in the process of disconnecting.
void	SetDisconnecting ()
void	SetClockOffset (double aRecvOffset)
	Sets the offset between local and remote simulation time.
double	GetClockOffset () const
	Returns the offset between local and remote simulation time.
bool	HasClockTranslation ()
	Returns 'true' if the clock offset is configured for packet synchronization with this connection.
void	SetHasClockTranslation (bool aUseTranslation)
double	GetLastTimeStamp () const
	Returns the last time stamp (simulation-time) from a PDU received by this connection.
void	SetLastTimeStamp (double aTimeStamp)

Static Public Member Functions
static std::unique_ptr< UtScriptClass >	CreateScriptClass (UtScriptTypes *aScriptTypesPtr)
static UtScriptClass *	GetScriptClass ()

Static Public Attributes
static UtScriptClass *	mScriptClassPtr = nullptr

Protected Member Functions
	WsfXIO_Connection (WsfXIO_Interface aInterfacePtr, PakSocketIO aIOPtr)
	~WsfXIO_Connection () override

Friends
class	WsfXIO_Interface

Detailed Description

WsfXIO_Connection provides a means to communicate between applications. It may represent a single connection to a remote application, Or a broadcast/multicast setup between several applications.

Constructor & Destructor Documentation

◆ WsfXIO_Connection()

WsfXIO_Connection::WsfXIO_Connection	(	WsfXIO_Interface *	aInterfacePtr,
		PakSocketIO *	aIOPtr )

protected

References WsfXIO_Interface.

Referenced by GetLinkedConnection(), and SetLinkedConnection().

◆ ~WsfXIO_Connection()

WsfXIO_Connection::~WsfXIO_Connection ( )

overrideprotected

Member Function Documentation

◆ CreateScriptClass()

std::unique_ptr< UtScriptClass > WsfXIO_Connection::CreateScriptClass ( UtScriptTypes * aScriptTypesPtr )

static

References mScriptClassPtr.

◆ GetApplicationId()

GenUniqueId WsfXIO_Connection::GetApplicationId ( ) const

inline

Returns the remote application's unique ID This is only valid for TCP connections (UDP may have multiple listeners)

Referenced by WsfXIO_RemotePlatformList::AddConnection(), WsfXIO_TrackRequestManager::AddRequest(), WsfXIO_RemotePlatformList::DropConnection(), WsfXIO_RemotePlatformList::GetPlatformByIndex(), WsfXIO_TrackRequestManager::RequestCancelled(), WsfXIO_RemotePlatformList::SetInformationLevels(), and WsfXIO_Interface::WsfXIO_Interface().

◆ GetApplicationName()

const std::string & WsfXIO_Connection::GetApplicationName ( ) const

inline

Returns the name of the connected application.

◆ GetApplicationType()

wsf::xio::ApplicationType WsfXIO_Connection::GetApplicationType ( ) const

inline

Returns the application type.

◆ GetClockOffset()

double WsfXIO_Connection::GetClockOffset ( ) const

Returns the offset between local and remote simulation time.

◆ GetConnectionId()

int WsfXIO_Connection::GetConnectionId ( ) const

inline

Returns a locally unique identifier for this connection.

Referenced by WsfXIO_RemotePlatformList::FindPlatformByIndex(), WsfXIO_RemotePlatformList::FindPlatformByName(), WsfXIO_AutoDisMapping::FindRemotePlatform(), WsfXIO_Service::FindSubscription(), WsfXIO_AutoDisMapping::HandleDisconnect(), WsfXIO_Service::HandleDisconnect(), WsfXIO_AutoDisMapping::HandlePlatformInfo(), WsfXIO_RequestManager::HandleRequestResponse(), WsfXIO_ScriptService::HandleScriptDataRequest(), WsfXIO_AutoDisMapping::PlatformDeleted(), and WsfXIO_AutoDisMapping::TranslatePlatformIndex().

◆ GetInterface()

WsfXIO_Interface & WsfXIO_Connection::GetInterface ( )

inline

Returns the associated WsfXIO_Interface.

References WsfXIO_Interface.

Referenced by WsfXIO_RemotePlatformList::AddConnection().

◆ GetIO()

PakSocketIO & WsfXIO_Connection::GetIO ( ) const

inline

Returns the IO Device used in this connection.

Referenced by WsfXIO_Interface::Disconnect(), and WsfXIO_Interface::Send().

◆ GetLastTimeStamp()

double WsfXIO_Connection::GetLastTimeStamp ( ) const

inline

Returns the last time stamp (simulation-time) from a PDU received by this connection.

◆ GetLinkedConnection()

WsfXIO_Connection * WsfXIO_Connection::GetLinkedConnection ( ) const

inline

Returns a pointer to the linked connection if available This is only valid for TCP connections, and returns an unreliable connection capable of communicating to the remote application

References WsfXIO_Connection().

Referenced by wsf::event::HandleConnect::Print(), and wsf::event::HandleConnect::PrintCSV().

◆ GetScriptClass()

UtScriptClass * WsfXIO_Connection::GetScriptClass ( )

inlinestatic

References mScriptClassPtr.

◆ GetTCP_IO()

PakTCP_IO * WsfXIO_Connection::GetTCP_IO ( ) const

inline

Returns the GenTCP_IO is this connection uses TCP, returns null otherwise.

Referenced by WsfXIO_Interface::GetBytesCommunicated().

◆ GetUDP_IO()

PakUDP_IO * WsfXIO_Connection::GetUDP_IO ( ) const

inline

Returns the GenUDP_IO is this connection uses UDP, returns null otherwise.

Referenced by WsfXIO_Interface::GetBytesCommunicated(), wsf::event::HandleConnect::Print(), and wsf::event::HandleConnect::PrintCSV().

◆ HasClockTranslation()

bool WsfXIO_Connection::HasClockTranslation ( )

inline

Returns 'true' if the clock offset is configured for packet synchronization with this connection.

◆ IsDisconnecting()

bool WsfXIO_Connection::IsDisconnecting ( ) const

inline

Returns 'true' if the connection is in the process of disconnecting.

◆ IsInitialized()

bool WsfXIO_Connection::IsInitialized ( ) const

inline

Returns 'true' if the connection is initialized.

◆ IsReliable()

bool WsfXIO_Connection::IsReliable ( ) const

inline

Returns true if the connection is reliable.

Referenced by WsfXIO_AutoDisMapping::HandleConnect(), WsfXIO_AutoDisMapping::HandleDisconnect(), and WsfXIO_Query::WsfXIO_Query().

◆ Send()

void WsfXIO_Connection::Send ( WsfXIO_Packet & aPkt )

Sends a packet to this connection.

Referenced by WsfXIO_Service::DenyRequest(), WsfXIO_WeaponInfo::FireSalvo(), WsfXIO_WeaponInfo::FireSalvo(), WsfXIO_ScriptService::HandleInformationRequest(), WsfXIO_ScriptService::HandleScriptDataRequest(), WsfXIO_Service::RemoveSubscription(), WsfXIO_RequestManager::RequestCancelled(), WsfXIO_PlatformInfo::RequestDelete(), WsfXIO_TaskService::SendInitial(), WsfXIO_Subscription::SendResponse(), and WsfXIO_PlatformInfoService::SendTrackManagerState().

◆ SetApplicationId()

void WsfXIO_Connection::SetApplicationId ( GenUniqueId & aApplicationId )

inline

Sets the application ID.

◆ SetApplicationName()

void WsfXIO_Connection::SetApplicationName ( const std::string & aApplicationName )

inline

Sets the name of the connected application.

◆ SetApplicationType()

void WsfXIO_Connection::SetApplicationType ( wsf::xio::ApplicationType aApplicationType )

inline

Sets the application type.

◆ SetClockOffset()

void WsfXIO_Connection::SetClockOffset ( double aRecvOffset )

Sets the offset between local and remote simulation time.

◆ SetDisconnecting()

void WsfXIO_Connection::SetDisconnecting ( )

inline

◆ SetHasClockTranslation()

void WsfXIO_Connection::SetHasClockTranslation ( bool aUseTranslation )

inline

Referenced by WsfXIO_TimeSynchronization::~WsfXIO_TimeSynchronization().

◆ SetInitialized()

void WsfXIO_Connection::SetInitialized ( )

inline

Specifies that the connection is initialized.

◆ SetLastTimeStamp()

void WsfXIO_Connection::SetLastTimeStamp ( double aTimeStamp )

inline

◆ SetLinkedConnection()

void WsfXIO_Connection::SetLinkedConnection ( WsfXIO_Connection * aConnectionPtr )

inline

Sets the linked connection.

References WsfXIO_Connection().

◆ WsfXIO_Interface

friend class WsfXIO_Interface

friend

References WsfXIO_Interface.

Referenced by GetInterface(), WsfXIO_Connection(), and WsfXIO_Interface.

Member Data Documentation

◆ mScriptClassPtr

UtScriptClass * WsfXIO_Connection::mScriptClassPtr = nullptr

static

Referenced by CreateScriptClass(), and GetScriptClass().

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

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

◆ WsfXIO_Connection()

◆ ~WsfXIO_Connection()

Member Function Documentation

◆ CreateScriptClass()

◆ GetApplicationId()

◆ GetApplicationName()

◆ GetApplicationType()

◆ GetClockOffset()

◆ GetConnectionId()

◆ GetInterface()

◆ GetIO()

◆ GetLastTimeStamp()

◆ GetLinkedConnection()

◆ GetScriptClass()

◆ GetTCP_IO()

◆ GetUDP_IO()

◆ HasClockTranslation()

◆ IsDisconnecting()

◆ IsInitialized()

◆ IsReliable()

◆ Send()

◆ SetApplicationId()

◆ SetApplicationName()

◆ SetApplicationType()

◆ SetClockOffset()

◆ SetDisconnecting()

◆ SetHasClockTranslation()

◆ SetInitialized()

◆ SetLastTimeStamp()

◆ SetLinkedConnection()

Friends And Related Symbol Documentation

◆ WsfXIO_Interface

Member Data Documentation

◆ mScriptClassPtr