carma::ui::rtd::SenderAddress Class Reference

SenderAddress stores and makes available peer information for the opposite (client) end of a connected socket. More...

#include <carma/ui/rtd/common/SenderAddress.h>

Public Member Functions
std::string	getDomainName () const
	Get the domain name. More...
std::string	getHostName () const
	Full host name, including domain. More...
int	getLocalAddress () const
	Return the local address. More...
std::string	getNetAddress () const
	Return a character string representation of the IP address in the standard 'dot' format - i.e. More...
int	getPortAddress () const
	Return the port. More...
std::string	getServerDomainName () const
	Get server's domain name. More...
std::string	getServerHostName () const
	Get server's address. More...
SenderAddress &	operator= (const SenderAddress &s)
	Allow initialize by assignment. More...
	SenderAddress (int fd)
	There is no default constructor. More...
	SenderAddress (const SenderAddress &s)
	Allow copy. More...

Detailed Description

SenderAddress stores and makes available peer information for the opposite (client) end of a connected socket.

Information about this send, the server end, is also exposed.

Definition at line 36 of file SenderAddress.h.

Constructor & Destructor Documentation

carma::ui::rtd::SenderAddress::SenderAddress

(

int

fd

)

There is no default constructor.

A SenderAddress constructor should be passed a connected socket descriptor. as its only argument.

If the integer argument is not a connected socket descriptor, then a SenderAddress object will still be constructed. In this case, SenderAddress.getHostname() and SenderAddress.getDomainName() will return valid 'char *' values initialized to a default value. All other member functions will return 0.

carma::ui::rtd::SenderAddress::SenderAddress

(

const SenderAddress &

s

)

Allow copy.

Member Function Documentation

std::string carma::ui::rtd::SenderAddress::getDomainName

(

)

const

Get the domain name.

std::string carma::ui::rtd::SenderAddress::getHostName

(

)

const

Full host name, including domain.

int carma::ui::rtd::SenderAddress::getLocalAddress

(

)

const

Return the local address.

std::string carma::ui::rtd::SenderAddress::getNetAddress

(

)

const

Return a character string representation of the IP address in the standard 'dot' format - i.e.

192.100.16.1

int carma::ui::rtd::SenderAddress::getPortAddress

(

)

const

Return the port.

std::string carma::ui::rtd::SenderAddress::getServerDomainName

(

)

const

Get server's domain name.

std::string carma::ui::rtd::SenderAddress::getServerHostName

(

)

const

Get server's address.

The server is the machine running the program that creates this object.

SenderAddress& carma::ui::rtd::SenderAddress::operator=

(

const SenderAddress &

s

)

Allow initialize by assignment.

---

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

• carma/ui/rtd/common/SenderAddress.h