OksSystem::LocalHost Class Reference

Network host - localhost. More...

#include <Host.hpp>

Inheritance diagram for OksSystem::LocalHost:

Collaboration diagram for OksSystem::LocalHost:

Public Member Functions
	LocalHost () throw ()
	~LocalHost () throw ()
const std::string &	os_name () const throw ()
	name of the operating system
const std::string &	os_release () const throw ()
	release of the operating system
const std::string &	os_version () const throw ()
	version of the operating system
const std::string &	machine () const throw ()
	version of the operating system
const std::string &	description () const throw ()
	machine type *‍/
Public Member Functions inherited from OksSystem::Host
	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 const std::string &	local_name () throw ()
	localhostname
static const std::string &	full_local_name () throw ()
	fully qualified local host name
static const LocalHost *	instance () throw ()
	pointer to the singleton local host
Static Public Member Functions inherited from OksSystem::Host
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 Attributes
std::string	m_os_name
	name of the operating system
std::string	m_release
	release of the operating system
std::string	m_version
	version of the operating system
std::string	m_machine
	machine type
std::string	m_description
	machine description (cached)
Protected Attributes inherited from OksSystem::Host
std::string	m_name
	name of the host
std::string	m_full_name
	cached fully qualified host name

Static Protected Attributes
static LocalHost *	s_instance = 0
	singleton for local host

Additional Inherited Members
Protected Member Functions inherited from OksSystem::Host
	Host () throw ()
	constructor for current host

Detailed Description

Network host - localhost.

This class represents the local host It has some additional fields with additional information about the host

Version

1.1

Author

Matthias Wiesmann

Definition at line 62 of file Host.hpp.

Constructor & Destructor Documentation

LocalHost()

OksSystem::LocalHost::LocalHost	(		)
throw	(	)

Constructor You should not construct new instances, use instance to get the singleton instance.

Definition at line 233 of file Host.cpp.

                                      : Host() {
    struct utsname u_name_data;
    const int status = ::uname(&u_name_data);
    if (status==0) { 
    m_name =    u_name_data.nodename;
    m_os_name = u_name_data.sysname;
    m_release = u_name_data.release;
    m_version = u_name_data.version;
    m_machine = u_name_data.machine;
    }  else {
    char buffer[NI_MAXHOST];
    const int host_status = gethostname(buffer,sizeof(buffer));
    if (host_status==0) {
        m_name = buffer;
    } else { // both uname and gethostname screwed 
        m_name.clear(); 
    } // check for host_name
    } // uname failed. 
} // LocalHost

~LocalHost()

OksSystem::LocalHost::~LocalHost	(		)
throw	(	)

Definition at line 253 of file Host.cpp.

                                       {
  //  delete s_instance;
}

Member Function Documentation

description()

const std::string & OksSystem::LocalHost::description	(		)	const
throw	(	)

machine type *‍/

This method builds a description of the localhost This contains all the of the information handled by this class.

Returns

description text

Definition at line 286 of file Host.cpp.

                                                                {
    if (m_description.empty()) {
    std::ostringstream stream;
    stream << m_os_name << " " << m_release << "/" << m_machine;
    m_description = stream.str(); 
    } 
    return m_description;
} // description

full_local_name()

const std::string & OksSystem::LocalHost::full_local_name ( ) throw (  )

static

fully qualified local host name

Short-cut method - gives the fully qualified local hostname

Returns

fully qualified hostname

See also

OksSystem::LocalHost::full_name()

Definition at line 211 of file Host.cpp.

                                                              {
    return instance()->full_name(); 
} // fulllocalhostname

instance()

const OksSystem::LocalHost * OksSystem::LocalHost::instance ( ) throw (  )

static

pointer to the singleton local host

This method returns a pointer to the singleton instance. There is no need to ever create any instance of LocalHost

Returns

pointer to singleton instance

Note

utility methods like full_local_name use this instance class

Definition at line 221 of file Host.cpp.

                                                               {
    if (0==s_instance) {
    s_instance = new LocalHost(); 
    } // 
    return s_instance;
} // instance

local_name()

const std::string & OksSystem::LocalHost::local_name ( ) throw (  )

static

localhostname

Short-cut method - gives the local hostname This name is not guaranteed to be a fully qualified name.

Returns

hostname

See also

OksSystem::LocalHost::name()

Definition at line 202 of file Host.cpp.

                                                         {
    return instance()->name(); 
} // localhostname

machine()

const std::string & OksSystem::LocalHost::machine	(		)	const
throw	(	)

version of the operating system

Returns

machine name

Definition at line 277 of file Host.cpp.

                                                            {
    return m_machine;
} // machine

os_name()

const std::string & OksSystem::LocalHost::os_name	(		)	const
throw	(	)

name of the operating system

Returns

Operating OksSystem name

Definition at line 259 of file Host.cpp.

                                                            {
    return m_os_name;
} // os_name

os_release()

const std::string & OksSystem::LocalHost::os_release	(		)	const
throw	(	)

release of the operating system

Returns

Operating OksSystem release

Definition at line 265 of file Host.cpp.

                                                               {
    return m_release;
} // os_release

os_version()

const std::string & OksSystem::LocalHost::os_version	(		)	const
throw	(	)

version of the operating system

Returns

Operating OksSystem version

Definition at line 271 of file Host.cpp.

                                                               {
    return m_version;
} // os_version

Member Data Documentation

m_description

std::string OksSystem::LocalHost::m_description

mutableprotected

machine description (cached)

Definition at line 70 of file Host.hpp.

m_machine

std::string OksSystem::LocalHost::m_machine

protected

machine type

Definition at line 69 of file Host.hpp.

m_os_name

std::string OksSystem::LocalHost::m_os_name

protected

name of the operating system

Definition at line 66 of file Host.hpp.

m_release

std::string OksSystem::LocalHost::m_release

protected

release of the operating system

Definition at line 67 of file Host.hpp.

m_version

std::string OksSystem::LocalHost::m_version

protected

version of the operating system

Definition at line 68 of file Host.hpp.

s_instance

OksSystem::LocalHost * OksSystem::LocalHost::s_instance = 0

staticprotected

singleton for local host

LocalHost singleton.

Instance of local host

Definition at line 65 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