#include <WsfXIO_Interface.hpp>

Inheritance diagram for WsfXIO_Interface:

Collaboration diagram for WsfXIO_Interface:

[legend]

Classes
class	ClockSource

Public Types
typedef std::pair< int, int >	SenderAddress
typedef std::vector< WsfXIO_Connection * >	ConnectionList
typedef UtCallbackN< void(WsfXIO_Connection *)>	ConnectionCallback
typedef UtCallbackListN< void(WsfXIO_Connection *)>	ConnectionCallbackList
Public Types inherited from WsfXIO_InputData
enum	UDP_Type { cBROADCAST , cMULTICAST , cUNICAST }

Public Member Functions
	WsfXIO_Interface ()
	This form is used when the caller is not a WSF simulation.
	WsfXIO_Interface (const WsfXIO_InputData &aInputData)
	This form is used when the caller is a WSF simulation.
	~WsfXIO_Interface ()
Public Member Functions inherited from WsfXIO_InputData
	WsfXIO_InputData ()
bool	ProcessInput (UtInput &aInput)
void	AddConnectType (int aApplicationType)
	Specifies that applications of a certain type will be automatically connected to.

Miscellaneous methods.
bool	IsXIO_Requested () const
	Was a network connection requested?
void	SetXIO_Requested ()
bool	ShowConnections () const
	Should connection status messages be shown?
void	SetShowConnections (bool aShowConnections)
bool	IsDebugEnabled () const
	Was detailed debugging information requested?
void	SetDebugEnabled (bool aIsEnabled)
void	GetBytesCommunicated (size_t &aBytesSent, size_t &aBytesReceived)

Various callbacks to which others can subscribe.
UtCallbackListN< void(WsfXIO_Connection *)>	OnConnected
	Invoked when a connection is initialized.
UtCallbackListN< void(WsfXIO_Connection *)>	OnDisconnected
	Invoked when a connection is no longer connected, prior to deletion.
UtCallbackListN< void(double, GenUniqueId, bool)>	OnHeartbeatUpdate
UtCallbackListN< void(bool, const std::string &)>	OnApplicationBehind
	Invoked when a connected application has fallen behind the real-time clock by some threshold, or is no longer behind.
UtCallbackListN< void(int, int, int, int, double)>	BandwidthDataEvent
	Executes on the heartbeat to provide bandwidth information to event output.
std::unique_ptr< UtCallbackN< void()> >	TimeoutConnect (double aWaitTime, const std::function< void()> &aFunction)
std::unique_ptr< ConnectionCallback >	DisconnectConnect (WsfXIO_Connection *aConnectionPtr, const ConnectionCallback::FunctionType &aFunction)

Application identification methods
const GenUniqueId &	GetApplicationId () const
void	SetApplicationName (const std::string &aApplicationName)
std::string	GetApplicationName () const
void	SetApplicationType (wsf::xio::ApplicationType aApplicationType)
bool	Initialize ()
void	AdvanceTime (double aSimTime)

Simulation clock methods.
double	GetSimTime () const
	Returns the current simulation time.
double	GetLastAdvanceTime () const
void	SetClockSource (ClockSource *aClockSourcePtr)

Packet send methods.
void	Send (WsfXIO_Packet &aPktPtr, WsfXIO_Connection *aConnectionPtr)
void	Send (WsfXIO_Packet &aPkt, WsfXIO_Destination &aDestination)
void	Send (WsfXIO_Packet &aPktPtr, const std::vector< PakSocketIO * > &aConnections)
void	SendToAll (WsfXIO_Packet &aPkt)
void	SendToAllUDP (WsfXIO_Packet &aPkt)
void	SendToAllTCP (WsfXIO_Packet &aPkt)
void	SetValidApplicationTypes (const std::vector< int > &aApplicationTypes)
WsfXIO_Connection *	GetSender (PakPacket &aPkt)

Accessors to objects maintained by this class.
WsfXIO_RequestManager &	GetRequestManager ()
WsfXIO_QueryManager &	GetQueryManager () const
WsfXIO_Publisher &	GetPublisher () const

Service management
void	RegisterServiceType (std::string aServiceType, std::string aServiceVersion=std::string())
	Specifies that a service is available by this application.

Connection management
void	AddUDP_Target (UDP_Target aTarget)
	Adds a connection target. Can be called before or after initialization.
bool	RemoveUDP_Target (int aTargetIndex)
const std::vector< UDP_Target > &	GetUDP_Targets ()
const ConnectionList &	GetConnections () const
const ConnectionList &	GetReliableConnections () const
WsfXIO_Connection *	FindConnection (const GenUniqueId &aApplicationId)
WsfXIO_Connection *	FindConnection (int aConnectionIndex)
	Returns a pointer to the connection with the given ID.
WsfXIO_Connection *	FindConnection (const std::string &aApplicationName)
void	Disconnect (WsfXIO_Connection *aConnectionPtr)

Additional Inherited Members
Public Attributes inherited from WsfXIO_InputData
InputCallbackList	ProcessInputEvent
	XIO extenders can subscribe to this to add additional input into the 'xio_interface' block.
WsfStringId	mApplicationName
	The current application's name.
int	mTCP_Port
	Socket port used to receive TCP connections.
int	mMulticastTimeToLive
	Time to live for multicast connections.
bool	mMulticastLoopback
	Determines if sent multicast can be received on the local machine.
double	mHeartbeatInterval
ut::optional< double >	mFallingBehindThreshold
std::set< int >	mApplicationTypeFilter
	Set of application types to connect with automatically.
std::vector< UDP_Target >	mUDP_Targets
	Contains user input UDP target information.
std::vector< WsfXIO_EntityId >	mRegularApplications
std::vector< WsfXIO_EntityId >	mAutoMappedApplications
bool	mAutoMappingDefault
int	mPublisherDebugLevel
bool	mDebugEnabled
bool	mShowConnections
bool	mShowTransferRate
bool	mPauseForConnection
bool	mInterfaceRequested
	true if user has requested the XIO interface
bool	mAuxDataUpdates = true

Detailed Description

This is communications interface for XIO. It is responsible for:

Maintaining all XIO connections to other applications
Sending out heartbeat messages via UDP connections
Connecting to applications upon receipt of heartbeats
Sending and receiving of data

Member Typedef Documentation

◆ ConnectionCallback

typedef UtCallbackN<void(WsfXIO_Connection*)> WsfXIO_Interface::ConnectionCallback

◆ ConnectionCallbackList

typedef UtCallbackListN<void(WsfXIO_Connection*)> WsfXIO_Interface::ConnectionCallbackList

◆ ConnectionList

typedef std::vector<WsfXIO_Connection*> WsfXIO_Interface::ConnectionList

◆ SenderAddress

typedef std::pair<int, int> WsfXIO_Interface::SenderAddress

Constructor & Destructor Documentation

◆ WsfXIO_Interface() [1/2]

WsfXIO_Interface::WsfXIO_Interface ( )

This form is used when the caller is not a WSF simulation.

References WsfXIO_InputData::WsfXIO_InputData(), and WsfXIO_Interface().

Referenced by WsfXIO_Interface().

◆ WsfXIO_Interface() [2/2]

WsfXIO_Interface::WsfXIO_Interface ( const WsfXIO_InputData & aInputData )

This form is used when the caller is a WSF simulation.

References WsfXIO_Connection::GetApplicationId(), WsfXIO_Packet::mApplicationId, WsfXIO_TimeBehindPkt::mIsBehind, WsfXIO_InputData::mPublisherDebugLevel, OnApplicationBehind, OnDisconnected, WsfXIO_PacketRegistry::RegisterPackets(), and WsfXIO_InputData::WsfXIO_InputData().

◆ ~WsfXIO_Interface()

WsfXIO_Interface::~WsfXIO_Interface ( )

References GetBytesCommunicated(), and IsDebugEnabled().

Member Function Documentation

◆ AddUDP_Target()

void WsfXIO_Interface::AddUDP_Target ( UDP_Target aTarget )

Adds a connection target. Can be called before or after initialization.

References WsfXIO_InputData::mInterfaceRequested, and WsfXIO_InputData::mUDP_Targets.

◆ AdvanceTime()

void WsfXIO_Interface::AdvanceTime ( double aSimTime )

References BandwidthDataEvent, GetBytesCommunicated(), WsfXIO_InputData::mHeartbeatInterval, and WsfXIO_InputData::mShowTransferRate.

Referenced by WsfXIO_Simulation::Initialize(), WsfXIO_ScriptService::OnUpdate(), and WsfXIO_ScriptService::UpdateWhileAtBreak().

◆ Disconnect()

void WsfXIO_Interface::Disconnect ( WsfXIO_Connection * aConnectionPtr )

References WsfXIO_Connection::GetIO().

Referenced by RemoveUDP_Target().

◆ DisconnectConnect()

std::unique_ptr< WsfXIO_Interface::ConnectionCallback > WsfXIO_Interface::DisconnectConnect	(	WsfXIO_Connection *	aConnectionPtr,
		const ConnectionCallback::FunctionType &	aFunction )

◆ FindConnection() [1/3]

WsfXIO_Connection * WsfXIO_Interface::FindConnection ( const GenUniqueId & aApplicationId )

Referenced by RemoveUDP_Target(), UT_DEFINE_SCRIPT_METHOD(), and UT_DEFINE_SCRIPT_METHOD().

◆ FindConnection() [2/3]

WsfXIO_Connection * WsfXIO_Interface::FindConnection ( const std::string & aApplicationName )

◆ FindConnection() [3/3]

WsfXIO_Connection * WsfXIO_Interface::FindConnection ( int aConnectionIndex )

Returns a pointer to the connection with the given ID.

◆ GetApplicationId()

const GenUniqueId & WsfXIO_Interface::GetApplicationId ( ) const

inline

◆ GetApplicationName()

std::string WsfXIO_Interface::GetApplicationName ( ) const

inline

References WsfXIO_InputData::mApplicationName.

◆ GetBytesCommunicated()

void WsfXIO_Interface::GetBytesCommunicated	(	size_t &	aBytesSent,
		size_t &	aBytesReceived )

References WsfXIO_Connection::GetTCP_IO(), and WsfXIO_Connection::GetUDP_IO().

Referenced by AdvanceTime(), and ~WsfXIO_Interface().

◆ GetConnections()

const ConnectionList & WsfXIO_Interface::GetConnections ( ) const

inline

◆ GetLastAdvanceTime()

double WsfXIO_Interface::GetLastAdvanceTime ( ) const

inline

◆ GetPublisher()

WsfXIO_Publisher & WsfXIO_Interface::GetPublisher ( ) const

inline

Referenced by UT_DEFINE_SCRIPT_METHOD(), and UT_DEFINE_SCRIPT_METHOD().

◆ GetQueryManager()

WsfXIO_QueryManager & WsfXIO_Interface::GetQueryManager ( ) const

inline

◆ GetReliableConnections()

const ConnectionList & WsfXIO_Interface::GetReliableConnections ( ) const

inline

◆ GetRequestManager()

WsfXIO_RequestManager & WsfXIO_Interface::GetRequestManager ( )

inline

◆ GetSender()

WsfXIO_Connection * WsfXIO_Interface::GetSender ( PakPacket & aPkt )

Referenced by SetValidApplicationTypes().

◆ GetSimTime()

double WsfXIO_Interface::GetSimTime ( ) const

inline

Returns the current simulation time.

Referenced by Send(), Send(), SendToAll(), and SendToAllUDP().

◆ GetUDP_Targets()

const std::vector< UDP_Target > & WsfXIO_Interface::GetUDP_Targets ( )

inline

References WsfXIO_InputData::mUDP_Targets.

◆ Initialize()

bool WsfXIO_Interface::Initialize ( )

References WsfXIO_InputData::mDebugEnabled, WsfXIO_InputData::mInterfaceRequested, WsfXIO_InputData::mShowConnections, WsfXIO_InputData::mTCP_Port, and WsfXIO_InputData::mUDP_Targets.

◆ IsDebugEnabled()

bool WsfXIO_Interface::IsDebugEnabled ( ) const

inline

Was detailed debugging information requested?

References WsfXIO_InputData::mDebugEnabled.

Referenced by ~WsfXIO_Interface().

◆ IsXIO_Requested()

bool WsfXIO_Interface::IsXIO_Requested ( ) const

inline

Was a network connection requested?

References WsfXIO_InputData::mInterfaceRequested.

◆ RegisterServiceType()

void WsfXIO_Interface::RegisterServiceType	(	std::string	aServiceType,
		std::string	aServiceVersion = std::string() )

Specifies that a service is available by this application.

◆ RemoveUDP_Target()

bool WsfXIO_Interface::RemoveUDP_Target ( int aTargetIndex )

References Disconnect(), FindConnection(), WsfXIO_InputData::UDP_Target::mConnectionId, and WsfXIO_InputData::mUDP_Targets.

◆ Send() [1/3]

void WsfXIO_Interface::Send	(	WsfXIO_Packet &	aPkt,
		WsfXIO_Destination &	aDestination )

References WsfXIO_Destination::GetIO_List(), and Send().

◆ Send() [2/3]

void WsfXIO_Interface::Send	(	WsfXIO_Packet &	aPktPtr,
		const std::vector< PakSocketIO * > &	aConnections )

References GetSimTime(), WsfXIO_Packet::mApplicationId, and WsfXIO_Packet::SetTimeStamp().

◆ Send() [3/3]

void WsfXIO_Interface::Send	(	WsfXIO_Packet &	aPktPtr,
		WsfXIO_Connection *	aConnectionPtr )

References WsfXIO_Connection::GetIO(), GetSimTime(), WsfXIO_Packet::mApplicationId, and WsfXIO_Packet::SetTimeStamp().

Referenced by Send().

◆ SendToAll()

void WsfXIO_Interface::SendToAll ( WsfXIO_Packet & aPkt )

References GetSimTime(), WsfXIO_Packet::mApplicationId, and WsfXIO_Packet::SetTimeStamp().

◆ SendToAllTCP()

void WsfXIO_Interface::SendToAllTCP ( WsfXIO_Packet & aPkt )

References WsfXIO_Packet::mApplicationId.

◆ SendToAllUDP()

void WsfXIO_Interface::SendToAllUDP ( WsfXIO_Packet & aPkt )

References GetSimTime(), WsfXIO_Packet::mApplicationId, and WsfXIO_Packet::SetTimeStamp().

◆ SetApplicationName()

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

inline

References WsfXIO_InputData::mApplicationName.

◆ SetApplicationType()

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

inline

◆ SetClockSource()

void WsfXIO_Interface::SetClockSource ( ClockSource * aClockSourcePtr )

Referenced by WsfXIO_Simulation::WsfXIO_Simulation().

◆ SetDebugEnabled()

void WsfXIO_Interface::SetDebugEnabled ( bool aIsEnabled )

inline

References WsfXIO_InputData::mDebugEnabled.

◆ SetShowConnections()

void WsfXIO_Interface::SetShowConnections ( bool aShowConnections )

inline

References WsfXIO_InputData::mShowConnections.

◆ SetValidApplicationTypes()

void WsfXIO_Interface::SetValidApplicationTypes ( const std::vector< int > & aApplicationTypes )

References GetSender().

◆ SetXIO_Requested()

void WsfXIO_Interface::SetXIO_Requested ( )

inline

References WsfXIO_InputData::mInterfaceRequested.

◆ ShowConnections()

bool WsfXIO_Interface::ShowConnections ( ) const

inline

Should connection status messages be shown?

References WsfXIO_InputData::mShowConnections.

◆ TimeoutConnect()

std::unique_ptr< UtCallbackN< void()> > WsfXIO_Interface::TimeoutConnect	(	double	aWaitTime,
		const std::function< void()> &	aFunction )

Member Data Documentation

◆ BandwidthDataEvent

UtCallbackListN<void(int, int, int, int, double)> WsfXIO_Interface::BandwidthDataEvent

Executes on the heartbeat to provide bandwidth information to event output.

Referenced by AdvanceTime().

◆ OnApplicationBehind

UtCallbackListN<void(bool, const std::string&)> WsfXIO_Interface::OnApplicationBehind

Invoked when a connected application has fallen behind the real-time clock by some threshold, or is no longer behind.

Referenced by WsfXIO_Interface().

◆ OnConnected

UtCallbackListN<void(WsfXIO_Connection*)> WsfXIO_Interface::OnConnected

Invoked when a connection is initialized.

◆ OnDisconnected

UtCallbackListN<void(WsfXIO_Connection*)> WsfXIO_Interface::OnDisconnected

Invoked when a connection is no longer connected, prior to deletion.

Referenced by WsfXIO_Interface(), and WsfXIO_RequestManager::WsfXIO_RequestManager().

◆ OnHeartbeatUpdate

UtCallbackListN<void(double, GenUniqueId, bool)> WsfXIO_Interface::OnHeartbeatUpdate

Invoked when a heartbeat is sent or received. double = Time Stamp GenUniqueId = ApplicationId bool = Received (!Sent)

Referenced by wsf::xio::EventPipe::EventPipe().

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

Classes

Public Types

Public Member Functions

Miscellaneous methods.

Various callbacks to which others can subscribe.

Application identification methods

Simulation clock methods.

Packet send methods.

Accessors to objects maintained by this class.

Service management

Connection management

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ ConnectionCallback

◆ ConnectionCallbackList

◆ ConnectionList

◆ SenderAddress

Constructor & Destructor Documentation

◆ WsfXIO_Interface() [1/2]

◆ WsfXIO_Interface() [2/2]

◆ ~WsfXIO_Interface()

Member Function Documentation

◆ AddUDP_Target()

◆ AdvanceTime()

◆ Disconnect()

◆ DisconnectConnect()

◆ FindConnection() [1/3]

◆ FindConnection() [2/3]

◆ FindConnection() [3/3]

◆ GetApplicationId()

◆ GetApplicationName()

◆ GetBytesCommunicated()

◆ GetConnections()

◆ GetLastAdvanceTime()

◆ GetPublisher()

◆ GetQueryManager()

◆ GetReliableConnections()

◆ GetRequestManager()

◆ GetSender()

◆ GetSimTime()

◆ GetUDP_Targets()

◆ Initialize()

◆ IsDebugEnabled()

◆ IsXIO_Requested()

◆ RegisterServiceType()

◆ RemoveUDP_Target()

◆ Send() [1/3]

◆ Send() [2/3]

◆ Send() [3/3]

◆ SendToAll()

◆ SendToAllTCP()

◆ SendToAllUDP()

◆ SetApplicationName()

◆ SetApplicationType()

◆ SetClockSource()

◆ SetDebugEnabled()

◆ SetShowConnections()

◆ SetValidApplicationTypes()

◆ SetXIO_Requested()

◆ ShowConnections()

◆ TimeoutConnect()

Member Data Documentation

◆ BandwidthDataEvent

◆ OnApplicationBehind

◆ OnConnected

◆ OnDisconnected

◆ OnHeartbeatUpdate