The TransportManager manages all JAUS transport layer communications (JUDP/JTCP) so that multiple components can communicate on the same host PC without needing to reserve the JAUS port. More...

#include <transportmanager.h>

Public Member Functions
	TransportManager ()
	Constructor.
virtual	~TransportManager ()
	Destructor.
bool	IsInitialized () const
virtual bool	LoadSettings (const std::string &filename)
	Loads UDP configuration values from an XML file. Only loads values if transport has not been initialized.
virtual bool	Initialize ()
	Initializes the transport manager.
virtual void	Shutdown ()
	Shutsdown the transport manager.
virtual void	CheckServiceStatus (const unsigned int timeSinceLastCheckMs)
	Checks to see if any connections need to be closed out.
void	ProcessPacket (Packet &packet, Header &header, const IP4Address &ipAddress, const unsigned short sourcePort, const int transport)
	Process a packet received by a transport medium. This will route the packet to the appropriate destination.
virtual void	EnableDebugMessages (const bool on)
bool	AddConnection (const IP4Address &networkIP, const Address &jausID)
	Adds to the list of JAUS and network address to try and create connections to using UDP or TCP. Method can only be called before initialization, and will only have an affect if this transport manager is active.
unsigned int	GetNumLocalClients () const
Static Public Attributes
static const int	TCP = 0
static const int	UDP = 1
static const int	Serial = 2
Static Protected Member Functions
static void	TcpListenThread (void *args)
	Listens for TCP connections.
static void	UdpReceiveThread (void *args)
	Thread for UDP receiving.
Protected Attributes
bool	mUseTcpFlag
	If true, TCP is chosen over UDP for making connections.
IP4Address	mHostIP
	Host IP Address to use.
Mutex	mDebugMessagesMutex
	Mutex to lock console for message display.
volatile bool	mDebugMessagesFlag
	If true, show debugging messages.
unsigned int	mDelayTimeMs
	Delay time in polling for network/message data.
CxUtils::Mutex	mUdpMutex
	Mutex for UDP data.
CxUtils::UdpClient	mUdpSocket
	UDP server and multicast/broadcast socket.
unsigned int	mMaxPayloadSize
	Maximum payload size.
unsigned char	mTimeToLive
	Time to Live TTL for UDP.
CxUtils::IP4Address	mMulticastIP
	IP Address for local multicast group.
bool	mUseBroadcastingFlag
	If true, broadcasting is enabled over multicast.
Time::Stamp	mDisconnectTimeMs
	How long to wait in ms before a connection is closed.
CxUtils::Thread	mUdpReceiveThread
	UDP Receving thread.
std::map< Address, CxUtils::UdpClient * >	mUdpConnections
	UDP Socket connections made by TransportManager.
std::map< Address, Time::Stamp >	mUpdateTimes
	Times when connections were last updated.
Mutex	mTcpMutex
	Mutex for thread protection of sockets.
CxUtils::TcpListenSocket	mListenSocket
	TCP Listening socket for incomming connections.
CxUtils::Thread	mTcpListenThread
	TCP Listening thread.
std::map< Address, JTCP * >	mTcpConnections
	TCP connections made from external sources.
std::vector< JTCP * >	mUnknownConnections
	Temporary TCP connections.
std::map< Address, IP4Address >	mPermanentConnections
	Permanent connections added manually.

Detailed Description

The TransportManager manages all JAUS transport layer communications (JUDP/JTCP) so that multiple components can communicate on the same host PC without needing to reserve the JAUS port.

Definition at line 61 of file transportmanager.h.

Constructor & Destructor Documentation

TransportManager::TransportManager ( )

Constructor.

Definition at line 55 of file transportmanager.cpp.

TransportManager::~TransportManager ( ) [virtual]

Destructor.

Definition at line 73 of file transportmanager.cpp.

Member Function Documentation

bool TransportManager::AddConnection	(	const IP4Address &	networkIP,
		const Address &	jausID
	)

Adds to the list of JAUS and network address to try and create connections to using UDP or TCP. Method can only be called before initialization, and will only have an affect if this transport manager is active.

Parameters:

[in]	networkIP	Network IP address.
[in]	jausID	JAUS ID.

Returns:: True if added to list, false otherwise. True does not mean the mean the connection has actually been made.

Definition at line 624 of file transportmanager.cpp.

void TransportManager::CheckServiceStatus ( const unsigned int timeSinceLastCheckMs ) [virtual]

Checks to see if any connections need to be closed out.

Parameters:

[in] timeSinceLastCheckMs How many milliseconds that have past since the last time the CheckServiceStatus method was called.

Definition at line 307 of file transportmanager.cpp.

virtual void JAUS::TransportManager::EnableDebugMessages ( const bool on ) [inline, virtual]

Definition at line 86 of file transportmanager.h.

unsigned int TransportManager::GetNumLocalClients ( ) const

Returns:: Number of local TCP client connections.

Definition at line 641 of file transportmanager.cpp.

bool TransportManager::Initialize ( ) [virtual]

Initializes the transport manager.

Returns:: False on failure, true on success.

Definition at line 179 of file transportmanager.cpp.

bool JAUS::TransportManager::IsInitialized ( ) const [inline]

Definition at line 70 of file transportmanager.h.

bool TransportManager::LoadSettings ( const std::string & filename ) [virtual]

Loads UDP configuration values from an XML file. Only loads values if transport has not been initialized.

Parameters:

[in] filename File containing UDP settings data.

Returns:: True on success, false on failure.

Definition at line 89 of file transportmanager.cpp.

void TransportManager::ProcessPacket	(	Packet &	packet,
		Header &	header,
		const IP4Address &	ipAddress,
		const unsigned short	sourcePort,
		const int	transport
	)

Process a packet received by a transport medium. This will route the packet to the appropriate destination.

Parameters:

[in]	packet	JAUS formatted packket which includes transport header and general header data.
[in]	header	JAUS general header data for message.
[in]	ipAddress	IP address of the source of the message.
[in]	sourcePort	The source port the data arrived from.
[in]	transport	The transport medium the data arrived on.