A 128 bit IPv6 address and 16-bit port number plus some IPv6 specific extra fields. More...

#include <IPAddress.hxx>

Inheritance diagram for cosmos::IP6Address:

Public Member Functions
	IP6Address (const sockaddr_in6 &raw)

	IP6Address (const IP6RawAddress &addr, const IPPort port=IPPort{0})

SocketFamily	family () const override
	Returns the concrete SocketFamily for the implementation address type.

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

IPPort	port () const

void	setPort (const IPPort port)

IP6RawAddress	addr () const

void	setAddr (const IP6RawAddress &addr)

InterfaceIndex	getScopeID () const
	Returns the currently set scope ID.

void	setScopeID (const InterfaceIndex index)
	Set a new scope ID interface index.

uint32_t	getFlowInfo () const
	Returns the IPv6 flow info identifier.

void	setFlowInfo (const uint32_t flowinfo)

bool	operator== (const IP6Address &other) const

bool	operator!= (const IP6Address &other) const

Public Member Functions inherited from cosmos::IPAddressBase
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 size_t	maxSize () const
	Returns the maximum number of bytes the socket address can hold.

Static Public Attributes
static constexpr SocketFamily	FAMILY = SocketFamily::INET6

Protected Member Functions
sockaddr *	basePtr () override
	Returns a mutable pointer to the `sockaddr*` base structure.

const sockaddr *	basePtr () const override
	Returns a const pointer to the `sockaddr*` base structure.

void	setFamily ()

Protected Member Functions inherited from cosmos::IPAddressBase
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
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.

Protected Attributes
sockaddr_in6	m_addr

Additional Inherited Members
Public Types inherited from cosmos::IPAddressBase
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.

Detailed Description

A 128 bit IPv6 address and 16-bit port number plus some IPv6 specific extra fields.

Definition at line 170 of file IPAddress.hxx.

Constructor & Destructor Documentation

◆ IP6Address() [1/3]

cosmos::IP6Address::IP6Address ( )

inline

Definition at line 178 of file IPAddress.hxx.

                     {
                clear();
        }

◆ IP6Address() [2/3]

cosmos::IP6Address::IP6Address ( const sockaddr_in6 & raw )

inlineexplicit

Definition at line 182 of file IPAddress.hxx.

                                                     {
                m_addr = raw;
        }

◆ IP6Address() [3/3]

cosmos::IP6Address::IP6Address	(	const IP6RawAddress &	addr,
		const IPPort	port = IPPort{0} )

inlineexplicit

Definition at line 186 of file IPAddress.hxx.

                                                                                 {0}) {
                clear();
                setAddr(addr);
                setPort(port);
        }

Member Function Documentation

◆ addr()

IP6RawAddress cosmos::IP6Address::addr ( ) const

inline

Definition at line 203 of file IPAddress.hxx.

                                   {
                IP6RawAddress ret;
                std::memcpy(ret.data(), m_addr.sin6_addr.s6_addr, ret.size());
                return ret;
        }

◆ basePtr() [1/2]

const sockaddr * cosmos::IP6Address::basePtr ( ) const

inlineoverrideprotectedvirtual

Returns a const pointer to the sockaddr* base structure.

Implements cosmos::SocketAddress.

Definition at line 262 of file IPAddress.hxx.

                                                 {
                return reinterpret_cast<const sockaddr*>(&m_addr);
        }

◆ basePtr() [2/2]

sockaddr * cosmos::IP6Address::basePtr ( )

inlineoverrideprotectedvirtual

Returns a mutable pointer to the sockaddr* base structure.

Implements cosmos::SocketAddress.

Definition at line 258 of file IPAddress.hxx.

                                     {
                return reinterpret_cast<sockaddr*>(&m_addr);
        }

◆ family()

SocketFamily cosmos::IP6Address::family ( ) const

inlineoverridevirtual

Returns the concrete SocketFamily for the implementation address type.

Implements cosmos::SocketAddress.

Definition at line 192 of file IPAddress.hxx.

                                             {
                return FAMILY;
        }

◆ getFlowInfo()

uint32_t cosmos::IP6Address::getFlowInfo ( ) const

inline

Returns the IPv6 flow info identifier.

This value can be set to zero to disable its use. Otherwise it has a protocol specific meaning that is interpreted at routers e.g. to prioritize certain traffic types.

Definition at line 237 of file IPAddress.hxx.

                                     {
                return m_addr.sin6_flowinfo;
        }

◆ getScopeID()

InterfaceIndex cosmos::IP6Address::getScopeID ( ) const

inline

Returns the currently set scope ID.

This ID allows to link a local address to a local network device via an InterfaceIndex. It is only supported for link-local addresses.

Definition at line 219 of file IPAddress.hxx.

                                          {
                // the type for the scope_id and index are inconsistent
                // overly large scope_ids should not occur in practice though,
                // so we shouldn't run into trouble here.
                return InterfaceIndex{static_cast<int>(m_addr.sin6_scope_id)};
        }

◆ operator!=()

bool cosmos::IP6Address::operator!= ( const IP6Address & other ) const

inline

Definition at line 252 of file IPAddress.hxx.

                                                       {
                return !(*this == other);
        }

◆ operator==()

bool cosmos::IP6Address::operator== ( const IP6Address & other ) const

inline

Definition at line 245 of file IPAddress.hxx.

                                                       {
                const auto cmp_res = std::memcmp(m_addr.sin6_addr.s6_addr,
                                other.m_addr.sin6_addr.s6_addr,
                                sizeof(m_addr.sin6_addr.s6_addr));
                return cmp_res == 0 && port() == other.port();
        }

◆ port()

IPPort cosmos::IP6Address::port ( ) const

inline

Definition at line 200 of file IPAddress.hxx.

200{ return IPPort{net::RawNetInt16{m_addr.sin6_port}}; }

◆ setAddr()

void cosmos::IP6Address::setAddr ( const IP6RawAddress & addr )

inline

Definition at line 209 of file IPAddress.hxx.

                                                {
                std::memcpy(m_addr.sin6_addr.s6_addr, addr.begin(), addr.size());
        }

◆ setFamily()

void cosmos::IP6Address::setFamily ( )

inlineprotected

Definition at line 266 of file IPAddress.hxx.

                         {
                m_addr.sin6_family = to_integral(family());
        }

◆ setFlowInfo()

void cosmos::IP6Address::setFlowInfo ( const uint32_t flowinfo )

inline

Definition at line 241 of file IPAddress.hxx.

                                                  {
                m_addr.sin6_flowinfo = flowinfo;
        }

◆ setPort()

void cosmos::IP6Address::setPort ( const IPPort port )

inline

Definition at line 201 of file IPAddress.hxx.

201{ m_addr.sin6_port = to_integral(port.raw()); }

◆ setScopeID()

void cosmos::IP6Address::setScopeID ( const InterfaceIndex index )

inline

Set a new scope ID interface index.

Definition at line 227 of file IPAddress.hxx.

                                                    {
                m_addr.sin6_scope_id = to_integral(index);
        }

◆ size()

size_t cosmos::IP6Address::size ( ) const

inlineoverridevirtual

Returns the size of the socket address in bytes found at basePtr().

This returns the number of bytes currently used in the socket address. Some implementations may have dynamic sizes in which case this can differ from maxSize().

Implements cosmos::SocketAddress.

Definition at line 196 of file IPAddress.hxx.

                                     {
                return sizeof(m_addr);
        }

Member Data Documentation

◆ FAMILY

SocketFamily cosmos::IP6Address::FAMILY = SocketFamily::INET6

inlinestaticconstexpr

Definition at line 174 of file IPAddress.hxx.

◆ m_addr

sockaddr_in6 cosmos::IP6Address::m_addr

protected

Definition at line 272 of file IPAddress.hxx.

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

include/net/IPAddress.hxx

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ IP6Address() [1/3]

◆ IP6Address() [2/3]

◆ IP6Address() [3/3]

Member Function Documentation

◆ addr()

◆ basePtr() [1/2]

◆ basePtr() [2/2]

◆ family()

◆ getFlowInfo()

◆ getScopeID()

◆ operator!=()

◆ operator==()

◆ port()

◆ setAddr()

◆ setFamily()

◆ setFlowInfo()

◆ setPort()

◆ setScopeID()

◆ size()

Member Data Documentation

◆ FAMILY

◆ m_addr