Stores basic information about a remote assistant. More...

Collaboration diagram for DtAssistantInfo:

Public Member Functions
	~DtAssistantInfo ()
	Destructor. More...

DtAssistantInfo &	operator= (const DtAssistantInfo &other)
	Overloaded operator. More...

bool	operator< (const DtAssistantInfo &other) const
	Overloaded operator. More...

bool	operator== (const DtAssistantInfo &other) const
	Overloaded operator. Determines if all params are equal. More...

bool	operator!= (const DtAssistantInfo &other) const
	Overloaded operator. Determines if any param is not equal. More...

DtHostNameAddress	host () const
	Get the host of the assistant. More...

void	setHost (const DtHostNameAddress &host)
	Set the host of the assistant. More...

const MAKRti::DtString &	hostName () const
	Get the host name of the assistant. More...

void	setHostName (const MAKRti::DtString &name)
	Set the host name of the assistant. More...

const MAKRti::DtInetAddr &	address () const
	Get IP address of the assistant. More...

void	setAddress (const MAKRti::DtInetAddr &addr)
	Set the IP address of the assistant. More...

const MAKRti::DtInetAddr &	publicAddress () const
	Get the public IP address of the assistant. More...

void	setPublicAddress (const MAKRti::DtInetAddr &addr)
	Set the public IP address of the assistant. More...

const DtInetAddrSet &	networkInterfaces () const
	Get the network interfaces on the assistant's host. More...

void	setNetworkInterfaces (const DtInetAddrSet &addresses)
	Set the network interfaces on the assistant host. More...

const MAKRti::DtInetAddr &	localInterface () const
	Get address of local interface to the remote the assistant. More...

void	setLocalInterface (const MAKRti::DtInetAddr &interfaceAddr)
	Set address of local interface to the remote the assistant. More...

void	setIsForeign (bool isForeignValue)
	Set whether the executing assistant considers this assistant to be foreign (running across WAN) More...

bool	isForeign () const
	Get whether the executing assistant considers this assistant to be foreign (running across WAN) More...

void	setUuid (const DtAssistantUuid &uuid)

const DtAssistantUuid &	uuid () const

void	setIsConnected (bool isConnectedValue)
	Set whether the assistant is connected. More...

bool	isConnected () const
	Get whether the assistant is connected. More...

int	id () const
	Get the ID which is used to distinguish between assistants running on the same machine. More...

void	setId (int id)
	Set the ID which is used to distinguish between assistants running on the same machine. More...

DtAssistantInfoSet::const_iterator	findMatchingHostInfo (const DtAssistantInfoSet &set)
	Returns an iterator into the given set of an item in the set that matches this assistant's host info. More...

void	removeMatchingHostName (DtAssistantInfoSet &sourceSet)
	Remove the set of assistants from given set that have matching host names. More...

bool	isThisAssistant () const
	Returns true if this assistant info is for this assistant. More...

bool	isValid () const
	Return true if this assistant info is valid (validity is based off UUID not being NIL) More...


	DtAssistantInfo ()
	Constructor. More...

	DtAssistantInfo (const DtAssistantUuid &uuid)
	Constructor. More...

	DtAssistantInfo (const DtAssistantInfo &other)
	Constructor. More...

	DtAssistantInfo (DtAssistantUuid uuid, int id, const MAKRti::DtString &host, const MAKRti::DtInetAddr &addr, const DtInetAddr &publicAddr, const DtInetAddrSet &networkInterfaces, const MAKRti::DtInetAddr &localInterface, bool isForeign=false)
	Constructor. More...

	DtAssistantInfo (DtAssistantUuid uuid, int id, const DtHostNameAddress &host, const DtInetAddr &publicAddr, const DtInetAddrSet &networkInterfaces, const MAKRti::DtInetAddr &interfaceAddr, bool isForeign=false)
	Constructor. More...

Static Public Member Functions
static void	setThisAssistantId (int id)
	Sets the ID of this assistant for comparisons. More...

static int	collectMatching (const DtRtiConnectionInfo &connection, const DtAssistantInfoSet &sourceSet, DtAssistantInfoSet &matchSet)
	Collects the set of assistants from given set that match the given connection host name and tcp address. More...

static int	collectMatching (const DtString &hostName, const DtInetAddr &address, const DtAssistantInfoSet &sourceSet, DtAssistantInfoSet &matchSet)
	Collects the set of assistants from given set that match the given host name and IP; empty name and isAny addr are wildcard. More...

Static Public Attributes
static const DtAssistantInfo	DtDefaultAssistantInfo

static const DtAssistantUuid	DtInvalidAssistantInfo

Protected Attributes
DtHostNameAddress	myHost
	Host on which the assistant is running. More...

MAKRti::DtInetAddr	myPublicAddr
	Public address of remote host (WAN). This is the same as the address in myHost when detected on a local network. More...

DtInetAddrSet	myNetworkInterfaces
	Network interfaces on the assistant host. More...

MAKRti::DtInetAddr	myLocalInterface
	Address of local interface to remote host. More...

int	myId
	ID used to distinguish between assistants running on the same machine. More...

bool	myIsForeign
	Does the executing assistant consider this assistant to be foreign (running across WAN) More...

bool	myIsConnected
	Is the assistant connected. More...

DtAssistantUuid	myUuid

DtAssistantConnectionType	myConnectionType

int	myRemoteAssistantPort

Static Protected Attributes
static int	theIdOfThisAssistant
	The ID of this assistant. Must be set with setThisAssistantInfo(). More...

Detailed Description

Stores basic information about a remote assistant.

Constructor & Destructor Documentation

DtAssistantInfo::DtAssistantInfo ( )

Constructor.

DtAssistantInfo::DtAssistantInfo ( const DtAssistantUuid & uuid )

Constructor.

DtAssistantInfo::DtAssistantInfo ( const DtAssistantInfo & other )

Constructor.

DtAssistantInfo::DtAssistantInfo	(	DtAssistantUuid	uuid,
		int	id,
		const MAKRti::DtString &	host,
		const MAKRti::DtInetAddr &	addr,
		const DtInetAddr &	publicAddr,
		const DtInetAddrSet &	networkInterfaces,
		const MAKRti::DtInetAddr &	localInterface,
		bool	isForeign = `false`
	)

Constructor.

DtAssistantInfo::DtAssistantInfo	(	DtAssistantUuid	uuid,
		int	id,
		const DtHostNameAddress &	host,
		const DtInetAddr &	publicAddr,
		const DtInetAddrSet &	networkInterfaces,
		const MAKRti::DtInetAddr &	interfaceAddr,
		bool	isForeign = `false`
	)

Constructor.

DtAssistantInfo::~DtAssistantInfo ( )

Destructor.

Member Function Documentation

const MAKRti::DtInetAddr& DtAssistantInfo::address ( ) const

Get IP address of the assistant.

static int DtAssistantInfo::collectMatching	(	const DtRtiConnectionInfo &	connection,
		const DtAssistantInfoSet &	sourceSet,
		DtAssistantInfoSet &	matchSet
	)

static

Collects the set of assistants from given set that match the given connection host name and tcp address.

Connect must use rtiexec and empty name and isAny addr are wildcard. Returns the number of matching items.

static int DtAssistantInfo::collectMatching	(	const DtString &	hostName,
		const DtInetAddr &	address,
		const DtAssistantInfoSet &	sourceSet,
		DtAssistantInfoSet &	matchSet
	)

static

Collects the set of assistants from given set that match the given host name and IP; empty name and isAny addr are wildcard.

Returns the number of matching items.

DtAssistantInfoSet::const_iterator DtAssistantInfo::findMatchingHostInfo ( const DtAssistantInfoSet & set )

Returns an iterator into the given set of an item in the set that matches this assistant's host info.

Does not attempt to match ID.

DtHostNameAddress DtAssistantInfo::host ( ) const

Get the host of the assistant.

const MAKRti::DtString& DtAssistantInfo::hostName ( ) const

Get the host name of the assistant.

int DtAssistantInfo::id ( ) const

Get the ID which is used to distinguish between assistants running on the same machine.

bool DtAssistantInfo::isConnected ( ) const

Get whether the assistant is connected.

bool DtAssistantInfo::isForeign ( ) const

Get whether the executing assistant considers this assistant to be foreign (running across WAN)

bool DtAssistantInfo::isThisAssistant ( ) const

Returns true if this assistant info is for this assistant.

bool DtAssistantInfo::isValid ( ) const

Return true if this assistant info is valid (validity is based off UUID not being NIL)

const MAKRti::DtInetAddr& DtAssistantInfo::localInterface ( ) const

Get address of local interface to the remote the assistant.

const DtInetAddrSet& DtAssistantInfo::networkInterfaces ( ) const

Get the network interfaces on the assistant's host.

bool DtAssistantInfo::operator!= ( const DtAssistantInfo & other ) const

Overloaded operator. Determines if any param is not equal.

bool DtAssistantInfo::operator< ( const DtAssistantInfo & other ) const

Overloaded operator.

DtAssistantInfo& DtAssistantInfo::operator= ( const DtAssistantInfo & other )

Overloaded operator.

bool DtAssistantInfo::operator== ( const DtAssistantInfo & other ) const

Overloaded operator. Determines if all params are equal.

const MAKRti::DtInetAddr& DtAssistantInfo::publicAddress ( ) const

Get the public IP address of the assistant.

void DtAssistantInfo::removeMatchingHostName ( DtAssistantInfoSet & sourceSet )

Remove the set of assistants from given set that have matching host names.

void DtAssistantInfo::setAddress ( const MAKRti::DtInetAddr & addr )

Set the IP address of the assistant.

void DtAssistantInfo::setHost ( const DtHostNameAddress & host )

Set the host of the assistant.

void DtAssistantInfo::setHostName ( const MAKRti::DtString & name )

Set the host name of the assistant.

void DtAssistantInfo::setId ( int id )

Set the ID which is used to distinguish between assistants running on the same machine.

void DtAssistantInfo::setIsConnected ( bool isConnectedValue )

Set whether the assistant is connected.

void DtAssistantInfo::setIsForeign ( bool isForeignValue )

Set whether the executing assistant considers this assistant to be foreign (running across WAN)

void DtAssistantInfo::setLocalInterface ( const MAKRti::DtInetAddr & interfaceAddr )

Set address of local interface to the remote the assistant.

void DtAssistantInfo::setNetworkInterfaces ( const DtInetAddrSet & addresses )

Set the network interfaces on the assistant host.

void DtAssistantInfo::setPublicAddress ( const MAKRti::DtInetAddr & addr )

Set the public IP address of the assistant.

static void DtAssistantInfo::setThisAssistantId ( int id )

static

Sets the ID of this assistant for comparisons.

void DtAssistantInfo::setUuid ( const DtAssistantUuid & uuid )

const DtAssistantUuid& DtAssistantInfo::uuid ( ) const

Referenced by DtAssistantConnectionInfoMgr::cmpByBoostUuid::operator()().

Member Data Documentation

const DtAssistantInfo DtAssistantInfo::DtDefaultAssistantInfo

static

const DtAssistantUuid DtAssistantInfo::DtInvalidAssistantInfo

static

DtAssistantConnectionType DtAssistantInfo::myConnectionType

protected

DtHostNameAddress DtAssistantInfo::myHost

protected

Host on which the assistant is running.

int DtAssistantInfo::myId

protected

ID used to distinguish between assistants running on the same machine.

bool DtAssistantInfo::myIsConnected

protected

Is the assistant connected.

bool DtAssistantInfo::myIsForeign

protected

Does the executing assistant consider this assistant to be foreign (running across WAN)

MAKRti::DtInetAddr DtAssistantInfo::myLocalInterface

protected

Address of local interface to remote host.

DtInetAddrSet DtAssistantInfo::myNetworkInterfaces

protected

Network interfaces on the assistant host.

MAKRti::DtInetAddr DtAssistantInfo::myPublicAddr

protected

Public address of remote host (WAN). This is the same as the address in myHost when detected on a local network.

int DtAssistantInfo::myRemoteAssistantPort

protected

DtAssistantUuid DtAssistantInfo::myUuid

protected

int DtAssistantInfo::theIdOfThisAssistant

staticprotected

The ID of this assistant. Must be set with setThisAssistantInfo().

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

assistantInfo.h

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Attributes

Static Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation