Base class for both IPv4 and IPv6 addresses. More...

#include <IPAddress.hxx>

Inheritance diagram for cosmos::IPAddressBase:

Public Types
enum class	NameInfoFlag : int { NAME_REQUIRED = NI_NAMEREQD , DGRAM = NI_DGRAM , NO_FQDN = NI_NOFQDN , NUMERIC_HOST = NI_NUMERICHOST , NUMERIC_SERVICE = NI_NUMERICSERV , IDN = NI_IDN }
	Flags used with the getNameInfo() function. More...

using	NameInfoFlags = BitMask<NameInfoFlag>
	Collection of NameInfoFlag used with the getNameInfo() function.

Public Member Functions
bool	isV4 () const

bool	isV6 () const

std::string	ipAsString () const
	Returns a textual representation of the currently set IP.

void	setIpFromString (const SysString str)
	Sets the binary IP address from the given string.

void	getNameInfo (std::string &host, std::string &service, const NameInfoFlags flags={})
	Reverse resolve the binary IP address and port into DNS and service names.

std::string	getHostInfo (const NameInfoFlags flags={})
	Reverse resolve only the IP address portion into a DNS name and return it.

std::string	getServiceInfo (const NameInfoFlags flags={})
	Reverse resolve only the port portion into a service name and return it.

Public Member Functions inherited from cosmos::SocketAddress
virtual SocketFamily	family () const =0
	Returns the concrete SocketFamily for the implementation address type.

virtual size_t	size () const =0
	Returns the size of the socket address in bytes found at basePtr().

virtual size_t	maxSize () const
	Returns the maximum number of bytes the socket address can hold.

Protected Member Functions
void *	ipAddrPtr ()
	returns a pointer to the in_addr or in6_addr.

const void *	ipAddrPtr () const
	returns a pointer to the in_addr or in6_addr.

void	getNameInfo (std::string host, std::string service, const NameInfoFlags flags)

Protected Member Functions inherited from cosmos::SocketAddress
virtual sockaddr *	basePtr ()=0
	Returns a mutable pointer to the `sockaddr*` base structure.

virtual const sockaddr *	basePtr () const =0
	Returns a const pointer to the `sockaddr*` base structure.

void	clear ()
	Clears the complete address structure.

virtual void	update (size_t new_length)
	Update the address structure after it has been filled in by the kernel.

Detailed Description

Base class for both IPv4 and IPv6 addresses.

This base class for IP address types offers some common logic to convert IP address string to binary and vice versa.

Definition at line 25 of file IPAddress.hxx.

Member Typedef Documentation

◆ NameInfoFlags

using cosmos::IPAddressBase::NameInfoFlags = BitMask<NameInfoFlag>

Collection of NameInfoFlag used with the getNameInfo() function.

Definition at line 50 of file IPAddress.hxx.

Member Enumeration Documentation

◆ NameInfoFlag

enum class cosmos::IPAddressBase::NameInfoFlag : int

strong

Flags used with the getNameInfo() function.

Enumerator
NAME_REQUIRED	Return an error if a hostname cannot be determined (instead of returning a numerical string address).
DGRAM	Use UDP context instead of TCP (this will return different service names for a few ports).
NO_FQDN	Return only the hostname part of the FQDN for local hosts.
NUMERIC_HOST	Return the numeric form of the hostname.
NUMERIC_SERVICE	Return the numeric form of the service (if unset this can still happen if the service's name cannot be determined).
IDN	If necessary convert the resulting hostname from IDN format to the current locale.

Definition at line 30 of file IPAddress.hxx.

                                : int {
                NAME_REQUIRED    = NI_NAMEREQD,
                DGRAM            = NI_DGRAM,
                NO_FQDN          = NI_NOFQDN,
                NUMERIC_HOST     = NI_NUMERICHOST,
                NUMERIC_SERVICE  = NI_NUMERICSERV,
                IDN              = NI_IDN,
#if 0 /* these are declared as deprecated */
                IDN_ALLOW_UNASSIGNED = NI_IDN_ALLOW_UNASSIGNED,
                IDN_USE_STD3_ASCII_RULES = NI_IDN_USE_STD3_ASCII_RULES,
#endif
        };

Member Function Documentation

◆ getHostInfo()

std::string cosmos::IPAddressBase::getHostInfo ( const NameInfoFlags flags = {} )

Reverse resolve only the IP address portion into a DNS name and return it.

This does the same as getNameInfo() but only reverse resolves the hostname, not the service.

See also: getNameInfo()

Definition at line 60 of file IPAddress.cxx.

                                                              {
        std::string ret;
 
        getNameInfo(&ret, nullptr, flags);
 
        return ret;
}

◆ getNameInfo() [1/2]

void cosmos::IPAddressBase::getNameInfo	(	std::string &	host,
		std::string &	service,
		const NameInfoFlags	flags = {} )

Reverse resolve the binary IP address and port into DNS and service names.

host and service will be filled with the textual representation of the currently stored binary IP address and port number. The given flags influence the behaviour of this reverse lookup.

On error conditions a cosmos::ResolveError is thrown.

Definition at line 56 of file IPAddress.cxx.

                                                                                              {
        getNameInfo(&host, &service, flags);
}

◆ getNameInfo() [2/2]

void cosmos::IPAddressBase::getNameInfo	(	std::string *	host,
		std::string *	service,
		const NameInfoFlags	flags )

protected

Definition at line 76 of file IPAddress.cxx.

                                                                                              {
 
        if (host) {
                host->resize(MAX_HOSTNAME);
        }
 
        if (service) {
                service->resize(MAX_SERVICE);
        }
 
        const auto res = ::getnameinfo(
                        this->basePtr(), this->size(),
                        host    ? host->data()    : nullptr, host    ? host->size()    : 0,
                        service ? service->data() : nullptr, service ? service->size() : 0,
                        flags.raw());
 
        if (res != 0) {
                cosmos_throw (ResolveError(ResolveError::Code{res}));
        }
 
        if (host) {
                host->resize(std::strlen(host->c_str()));
        }
 
        if (service) {
                service->resize(std::strlen(service->c_str()));
        }
}

◆ getServiceInfo()

std::string cosmos::IPAddressBase::getServiceInfo ( const NameInfoFlags flags = {} )

Reverse resolve only the port portion into a service name and return it.

This does the same as getNameInfo() but only reverse resolves the port, not the hostname.

Definition at line 68 of file IPAddress.cxx.

                                                                 {
        std::string ret;
 
        getNameInfo(nullptr, &ret, flags);
 
        return ret;
}

◆ ipAddrPtr() [1/2]

void * cosmos::IPAddressBase::ipAddrPtr ( )

protected

returns a pointer to the in_addr or in6_addr.

Definition at line 12 of file IPAddress.cxx.

                               {
        return const_cast<void*>(static_cast<const IPAddressBase&>(*this).ipAddrPtr());
}

◆ ipAddrPtr() [2/2]

const void * cosmos::IPAddressBase::ipAddrPtr ( ) const

protected

returns a pointer to the in_addr or in6_addr.

Definition at line 16 of file IPAddress.cxx.

                                           {
        if (isV4()) {
                return &reinterpret_cast<const sockaddr_in*>(basePtr())->sin_addr;
        } else {
                return &reinterpret_cast<const sockaddr_in6*>(basePtr())->sin6_addr;
        }
}

◆ ipAsString()

std::string cosmos::IPAddressBase::ipAsString ( ) const

Returns a textual representation of the currently set IP.

Definition at line 24 of file IPAddress.cxx.

                                          {
        std::string ret;
        ret.resize(64);
 
        while (!::inet_ntop(
                        to_integral(this->family()),
                        ipAddrPtr(),
                        ret.data(),
                        ret.size())) {
                if (ret.size() > 512) {
                        cosmos_throw (ApiError("inet_ntop()"));
                }
                ret.resize(ret.size() * 2);
        }
 
        ret.resize(std::strlen(ret.data()));
        return ret;
}

◆ isV4()

bool cosmos::IPAddressBase::isV4 ( ) const

inline

Definition at line 54 of file IPAddress.hxx.

54{ return this->family() == SocketFamily::INET; }

◆ isV6()

bool cosmos::IPAddressBase::isV6 ( ) const

inline

Definition at line 55 of file IPAddress.hxx.

55{ return this->family() == SocketFamily::INET6; }

◆ setIpFromString()

void cosmos::IPAddressBase::setIpFromString ( const SysString str )

Sets the binary IP address from the given string.

Definition at line 43 of file IPAddress.cxx.

                                                       {
        const auto res = ::inet_pton(
                        to_integral(this->family()),
                        str.raw(),
                        ipAddrPtr());
 
        if (res < 0) {
                cosmos_throw (ApiError("inet_pton()"));
        } else if (res == 0) {
                cosmos_throw (RuntimeError("inet_pton: bad IP address string"));
        }
}

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

include/net/IPAddress.hxx
src/net/IPAddress.cxx

Public Types

Public Member Functions

Protected Member Functions

Detailed Description

Member Typedef Documentation

◆ NameInfoFlags

Member Enumeration Documentation

◆ NameInfoFlag

Member Function Documentation

◆ getHostInfo()

◆ getNameInfo() [1/2]

◆ getNameInfo() [2/2]

◆ getServiceInfo()

◆ ipAddrPtr() [1/2]

◆ ipAddrPtr() [2/2]

◆ ipAsString()

◆ isV4()

◆ isV6()

◆ setIpFromString()