MAK RTIspy API Documentation for HLA 1.3
Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions
DtHostNameAddress Class Reference

DtHostNameAddress stores information on a host, input as either hostname, IP address, or both. More...

+ Collaboration diagram for DtHostNameAddress:

List of all members.

Public Member Functions

 DtHostNameAddress (const MAKRti::DtString &hostName, const MAKRti::DtInetAddr &addr)
 Input both hostname and address.
 DtHostNameAddress (const MAKRti::DtString &address)
 Input either ipstring or hostname string.
 DtHostNameAddress (const DtHostNameAddress &orig)
 copy constructor
virtual ~DtHostNameAddress ()
virtual bool operator< (const DtHostNameAddress &other) const
 Less than, if address has been resolved to (or input as) an IP will just compare the IP number (Ipv4 or Ipv6).
virtual bool operator== (const DtHostNameAddress &other) const
 Equals operator.
virtual bool operator!= (const DtHostNameAddress &other) const
 Not equals operator.
virtual DtHostNameAddressoperator= (const DtHostNameAddress &other)
 Assignment operator.
virtual const MAKRti::DtInetAddr & ip () const
 Get IP address represented by this, returns 0 if error, unresolvable.
virtual void setIp (const MAKRti::DtInetAddr &newIp)
 Sets the IP address. Will not affect the hostname.
virtual const MAKRti::DtString & hostName () const
 Get the hostname represented by this, returns "" if error, can't look up.
virtual void setHostName (const MAKRti::DtString &newHostName)
 Sets the hostname.
virtual void setHostFromString (const MAKRti::DtString &newAddr)
 Attempts to set the hostname and IP from the given string.
virtual const MAKRti::DtString & compareHostName () const
 Return the hostname that should be used for comparison's sake.
virtual bool isValid () const
 Is this valid, IP address is ok.
virtual bool isLocal () const
 Is this host a local interface.

Protected Member Functions

virtual void setIsValid ()
 Determines and sets whether the current information is a valid host.
virtual MAKRti::DtInetAddr dottedStringToAddress (const MAKRti::DtString &address)
 Convert a dotted string address to an IP.

Protected Attributes

MAKRti::DtString myHostName
 Host name.
MAKRti::DtString myCaseInsensitiveHostname
 Case insensitive hostname, for comparison.
MAKRti::DtInetAddr myHostIp
 IP.
bool myIsLocal
 Does this represent a local address.
bool myIsValid
 Are both my ip and hostname valid?

Private Member Functions

 DtHostNameAddress ()

Detailed Description

DtHostNameAddress stores information on a host, input as either hostname, IP address, or both.


Constructor & Destructor Documentation

DtHostNameAddress::DtHostNameAddress ( const MAKRti::DtString &  hostName,
const MAKRti::DtInetAddr &  addr 
)

Input both hostname and address.

DtHostNameAddress::DtHostNameAddress ( const MAKRti::DtString &  address)

Input either ipstring or hostname string.

copy constructor


Member Function Documentation

const DtString & DtHostNameAddress::compareHostName ( ) const [virtual]

Return the hostname that should be used for comparison's sake.

References myCaseInsensitiveHostname.

Referenced by DtRtiConnectionInfo::isEquivalentHost(), operator<(), and operator==().

DtInetAddr DtHostNameAddress::dottedStringToAddress ( const MAKRti::DtString &  address) [protected, virtual]

Convert a dotted string address to an IP.

Returns INADDR_ANY if not a dotted string.

Referenced by setHostFromString().

const DtString & DtHostNameAddress::hostName ( ) const [virtual]
const DtInetAddr & DtHostNameAddress::ip ( ) const [virtual]
bool DtHostNameAddress::isLocal ( ) const [virtual]

Is this host a local interface.

References myIsLocal.

Referenced by DtRtiConnectionInfo::isLocalHost(), and DtAssistantInfo::isThisAssistant().

bool DtHostNameAddress::isValid ( ) const [virtual]
bool DtHostNameAddress::operator!= ( const DtHostNameAddress other) const [virtual]

Not equals operator.

See note in operator< comments for parameters which are used in comparison.

bool DtHostNameAddress::operator< ( const DtHostNameAddress other) const [virtual]

Less than, if address has been resolved to (or input as) an IP will just compare the IP number (Ipv4 or Ipv6).

References compareHostName(), isValid(), myCaseInsensitiveHostname, myHostIp, and myIsValid.

DtHostNameAddress & DtHostNameAddress::operator= ( const DtHostNameAddress other) [virtual]

Assignment operator.

References myCaseInsensitiveHostname, myHostIp, myHostName, myIsLocal, and myIsValid.

bool DtHostNameAddress::operator== ( const DtHostNameAddress other) const [virtual]

Equals operator.

See note in operator< comments for parameters which are used in comparison.

References compareHostName(), isValid(), myCaseInsensitiveHostname, myHostIp, and myIsValid.

void DtHostNameAddress::setHostFromString ( const MAKRti::DtString &  newAddr) [virtual]

Attempts to set the hostname and IP from the given string.

References dottedStringToAddress(), myCaseInsensitiveHostname, myHostIp, myHostName, and setIsValid().

Referenced by setHostName().

void DtHostNameAddress::setHostName ( const MAKRti::DtString &  newHostName) [virtual]

Sets the hostname.

If IP is already set, will not reset. If not, will try to look up the IP based on the hostname.

References myCaseInsensitiveHostname, myHostName, myIsValid, setHostFromString(), and setIsValid().

Referenced by DtRtiConnectionInfo::operator=(), DtAssistantInfo::setHostName(), and DtRtiConnectionInfo::setHostName().

void DtHostNameAddress::setIp ( const MAKRti::DtInetAddr &  newIp) [virtual]

Sets the IP address. Will not affect the hostname.

References myHostIp, and setIsValid().

Referenced by DtRtiConnectionInfo::operator=(), DtAssistantInfo::setAddress(), and DtRtiConnectionInfo::setReliableIp().

void DtHostNameAddress::setIsValid ( ) [protected, virtual]

Determines and sets whether the current information is a valid host.

References DtIsIpOfLocalInterface(), myHostIp, myIsLocal, and myIsValid.

Referenced by setHostFromString(), setHostName(), and setIp().


Member Data Documentation

MAKRti::DtString DtHostNameAddress::myCaseInsensitiveHostname [protected]

Case insensitive hostname, for comparison.

Referenced by compareHostName(), operator<(), operator=(), operator==(), setHostFromString(), and setHostName().

MAKRti::DtInetAddr DtHostNameAddress::myHostIp [protected]
MAKRti::DtString DtHostNameAddress::myHostName [protected]

Host name.

Referenced by hostName(), operator=(), setHostFromString(), and setHostName().

Does this represent a local address.

Referenced by isLocal(), operator=(), and setIsValid().

Are both my ip and hostname valid?

Referenced by isValid(), operator<(), operator=(), operator==(), setHostName(), and setIsValid().


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

Document ID: Generated on Thu Jun 14 14:15:04 EDT 2012 from SVN revision 116116
Copyright © 2005-2012 VT MÄK Inc. All Rights Reserved (www.mak.com)