OksSystem::Host Class Reference

Network host. More...

#include <Host.hpp>

Inheritance diagram for OksSystem::Host:

Public Member Functions
	Host (const Host &other)
	copy constructor
	Host (const std::string &name)
	constructor from name
	Host (struct sockaddr_in ip_addr)
	constructor from ip address
virtual	~Host () throw ()
	destructor
	operator struct sockaddr_in () const throw ()
	cast to ip address
bool	equals (const Host &other) const throw ()
	equality method
struct sockaddr_in	ip () const throw ()
	get ip address
const std::string &	name () const throw ()
	get name
const std::string &	full_name () const throw ()
	get fully qualified name
std::string	ip_string () const throw ()
	get ip in string mode

Static Public Member Functions
static struct sockaddr_in	resolve (const std::string &name) throw ()
	name to ip conversion
static std::string	resolve (struct sockaddr_in address) throw ()
	ip to name conversion
static std::string	expand (const std::string &name) throw ()
	expands to full name
static std::string	to_string (struct sockaddr_in ip_addr)
	ip to string conversion

Protected Member Functions
	Host () throw ()
	constructor for current host

Protected Attributes
std::string	m_name
	name of the host
std::string	m_full_name
	cached fully qualified host name

Detailed Description

Network host.

This class represents an network host. It offers facilities to translate name to addresses and vice versa.

Author

Matthias Wiesmann

Version

1.0

Definition at line 28 of file Host.hpp.

Constructor & Destructor Documentation

Host() [1/4]

OksSystem::Host::Host ( ) throw (  )

protected

constructor for current host

Constructors for the local host

Definition at line 92 of file Host.cpp.

{} // Host

Host() [2/4]

OksSystem::Host::Host

(

const Host &

other

)

copy constructor

Definition at line 94 of file Host.cpp.

                                              {
    m_name = other.m_name;
    if (! other.m_full_name.empty()) {
    m_full_name = other.m_full_name;
    } // if
} // Host

Host() [3/4]

OksSystem::Host::Host

(

const std::string &

s_name

)

constructor from name

Constructor for host by name

Parameters

name	name of the host

Definition at line 106 of file Host.cpp.

                                           {
    m_name = s_name;
} // Host

Host() [4/4]

OksSystem::Host::Host

(

struct sockaddr_in

ip_addr

)

constructor from ip address

Definition at line 111 of file Host.cpp.

                                              {
    m_name = resolve(ip_addr);
    m_full_name = m_name;
} // Host

~Host()

OksSystem::Host::~Host ( ) throw (  )

virtual

destructor

Definition at line 117 of file Host.cpp.

                             {
} // OksSystem

Member Function Documentation

equals()

bool OksSystem::Host::equals	(	const Host &	other	)	const
throw	(	)

equality method

Comparison method We try to expand both name and compare those

Parameters

other

the host to compare to

Returns

true if both have the same fully qualified name

Definition at line 137 of file Host.cpp.

                                                          {
    return full_name()==other.full_name();
} // equals

expand()

std::string OksSystem::Host::expand ( const std::string & name ) throw (  )

static

expands to full name

Tries to build a fully qualified name. This is done first by converting the name to ip then the ip to a name. If this fails (basically, we cannot do DNS resolves) the non fully qualified name is returned

Parameters

name	the (partial) name

Returns

fullname

Definition at line 69 of file Host.cpp.

                                                             {
    const struct sockaddr_in address = resolve(name); 
    if (address.sin_addr.s_addr!=0) return resolve(address); 
    return std::string(name) ;
} // expand

full_name()

const std::string & OksSystem::Host::full_name	(		)	const
throw	(	)

get fully qualified name

Fully qualified name of the host

Returns

Fully qualified name of the host, or the string "0.0.0.0"

Definition at line 161 of file Host.cpp.

                                                         {
    if (m_full_name.empty()) {
    m_full_name = expand(m_name); 
    }  // if
    return m_full_name;
} // full_name

ip()

struct sockaddr_in OksSystem::Host::ip	(		)	const
throw	(	)

get ip address

IP address of the host

Returns

IP address of the host, or 0.0.0.0 if it cannot be resolved

Definition at line 155 of file Host.cpp.

{ return resolve(m_name);}

ip_string()

std::string OksSystem::Host::ip_string	(		)	const
throw	(	)

get ip in string mode

The IP Address of the host, as a string

Returns

a string containing the IP address of the host in w.x.y.z format

Definition at line 172 of file Host.cpp.

                                                 {
    const struct sockaddr_in address = ip(); 
    return to_string(address);
} // ip_string

name()

const std::string & OksSystem::Host::name	(		)	const
throw	(	)

get name

Name (this might be non fully qualified name)

Returns

name of the host

Definition at line 149 of file Host.cpp.

{ return m_name;} 

operator struct sockaddr_in()

OksSystem::Host::operator struct sockaddr_in	(		)	const
throw	(	)

cast to ip address

Cast conversion into ip address

Returns

ip address

Definition at line 127 of file Host.cpp.

                                                         {
    return ip(); 
} // struct sockaddr_in

resolve() [1/2]

struct sockaddr_in OksSystem::Host::resolve ( const std::string & name ) throw (  )

static

name to ip conversion

Translates an hostname into an ip address

Parameters

name	hostname to translate

Returns

the ip addrress, 0.0.0.0 if name not found.

Note

only returns the first ip address associated with name

Definition at line 32 of file Host.cpp.

                                                                       {
    struct addrinfo *info_ptr;
    const char *str = name.c_str(); 
    const int status = getaddrinfo(str,0,0,&info_ptr); 
    struct sockaddr_in address;
    bzero(&address,sizeof(address)); 
    address.sin_family = AF_INET;
    address.sin_addr.s_addr=0;
    if (status==0) {
    struct sockaddr_in *ptr = (sockaddr_in *) info_ptr->ai_addr;
    address = *ptr;
    freeaddrinfo(info_ptr); 
    } // if
    return address;
} // resolve

resolve() [2/2]

std::string OksSystem::Host::resolve ( struct sockaddr_in address ) throw (  )

static

ip to name conversion

Translates an ip address into an hostname

Parameters

address

the address to translate

Returns

the hostname an empty string if the hostname could not be resolved

Definition at line 53 of file Host.cpp.

                                                                   {
    char buffer[NI_MAXHOST];
    const struct sockaddr *ptr = (const struct sockaddr *) &address;
    const int status= getnameinfo(ptr,sizeof(address),buffer,sizeof(buffer),0,0,0);
    if (status!=0) return to_string(address); 
    return std::string(buffer); 
} // resolve

to_string()

std::string OksSystem::Host::to_string ( struct sockaddr_in ip_addr )

static

ip to string conversion

Transliterate an ip address into the canonical dotted text version (w.x.y.z).

Parameters

ip_addr

the address to translate

Returns

string containing the text version

Note

Should use addr2ascii

Definition at line 81 of file Host.cpp.

                                                             {
    const char* s = inet_ntoa(ip_addr.sin_addr);
    return std::string(s);
} // to_string

Member Data Documentation

m_full_name

std::string OksSystem::Host::m_full_name

mutableprotected

cached fully qualified host name

Definition at line 31 of file Host.hpp.

m_name

std::string OksSystem::Host::m_name

protected

name of the host

Definition at line 30 of file Host.hpp.

---

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

• /github/workspace/dunedaq/sourcecode/okssystem/include/okssystem/Host.hpp
• /github/workspace/dunedaq/sourcecode/okssystem/src/Host.cpp