A 32-bit IPv4 address and 16 bit port number for use with SocketFamily::INET sockets. More...

#include <IPAddress.hxx>

Inheritance diagram for cosmos::IP4Address:

Public Member Functions
	IP4Address (const sockaddr_in &raw)

	IP4Address (const IP4RawAddress addr, const IPPort port=IPPort{0})

	IP4Address (const SysString ip, 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().

net::NetInt16	port () const

void	setPort (const net::NetInt16 port)

IP4RawAddress	addr () const

void	setAddr (const IP4RawAddress addr)

bool	operator== (const IP4Address &other) const

bool	operator!= (const IP4Address &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::INET

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_in	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 32-bit IPv4 address and 16 bit port number for use with SocketFamily::INET sockets.

Definition at line 100 of file IPAddress.hxx.

Constructor & Destructor Documentation

◆ IP4Address() [1/4]

cosmos::IP4Address::IP4Address ( )

inline

Definition at line 108 of file IPAddress.hxx.

                     {
                clear();
        }

◆ IP4Address() [2/4]

cosmos::IP4Address::IP4Address ( const sockaddr_in & raw )

inlineexplicit

Definition at line 112 of file IPAddress.hxx.

                                                    {
                m_addr = raw;
        }

◆ IP4Address() [3/4]

cosmos::IP4Address::IP4Address	(	const IP4RawAddress	addr,
		const IPPort	port = IPPort{0} )

inlineexplicit

Definition at line 116 of file IPAddress.hxx.

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

◆ IP4Address() [4/4]

cosmos::IP4Address::IP4Address	(	const SysString	ip,
		const IPPort	port = IPPort{0} )

inlineexplicit

Definition at line 122 of file IPAddress.hxx.

                                                                          {0}) {
                setFamily();
                setIpFromString(ip);
                setPort(port);
        }

Member Function Documentation

◆ addr()

IP4RawAddress cosmos::IP4Address::addr ( ) const

inline

Definition at line 139 of file IPAddress.hxx.

139{ return IP4RawAddress{net::RawNetInt32{m_addr.sin_addr.s_addr}}; }

◆ basePtr() [1/2]

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

inlineoverrideprotectedvirtual

Returns a const pointer to the sockaddr* base structure.

Implements cosmos::SocketAddress.

Definition at line 156 of file IPAddress.hxx.

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

◆ basePtr() [2/2]

sockaddr * cosmos::IP4Address::basePtr ( )

inlineoverrideprotectedvirtual

Returns a mutable pointer to the sockaddr* base structure.

Implements cosmos::SocketAddress.

Definition at line 152 of file IPAddress.hxx.

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

◆ family()

SocketFamily cosmos::IP4Address::family ( ) const

inlineoverridevirtual

Returns the concrete SocketFamily for the implementation address type.

Implements cosmos::SocketAddress.

Definition at line 128 of file IPAddress.hxx.

                                             {
                return FAMILY;
        }

◆ operator!=()

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

inline

Definition at line 146 of file IPAddress.hxx.

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

◆ operator==()

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

inline

Definition at line 142 of file IPAddress.hxx.

                                                       {
                return addr() == other.addr() && port() == other.port();
        }

◆ port()

net::NetInt16 cosmos::IP4Address::port ( ) const

inline

Definition at line 136 of file IPAddress.hxx.

136{ return net::NetInt16{net::RawNetInt16{m_addr.sin_port}}; }

◆ setAddr()

void cosmos::IP4Address::setAddr ( const IP4RawAddress addr )

inline

Definition at line 140 of file IPAddress.hxx.

140{ m_addr.sin_addr.s_addr = to_integral(addr.raw()); }

◆ setFamily()

void cosmos::IP4Address::setFamily ( )

inlineprotected

Definition at line 160 of file IPAddress.hxx.

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

◆ setPort()

void cosmos::IP4Address::setPort ( const net::NetInt16 port )

inline

Definition at line 137 of file IPAddress.hxx.

137{ m_addr.sin_port = to_integral(port.raw()); }

◆ size()

size_t cosmos::IP4Address::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 132 of file IPAddress.hxx.

                                     {
                return sizeof(m_addr);
        }

Member Data Documentation

◆ FAMILY

SocketFamily cosmos::IP4Address::FAMILY = SocketFamily::INET

inlinestaticconstexpr

Definition at line 104 of file IPAddress.hxx.

◆ m_addr

sockaddr_in cosmos::IP4Address::m_addr

protected

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

◆ IP4Address() [1/4]

◆ IP4Address() [2/4]

◆ IP4Address() [3/4]

◆ IP4Address() [4/4]

Member Function Documentation

◆ addr()

◆ basePtr() [1/2]

◆ basePtr() [2/2]

◆ family()

◆ operator!=()

◆ operator==()

◆ port()

◆ setAddr()

◆ setFamily()

◆ setPort()

◆ size()

Member Data Documentation

◆ FAMILY

◆ m_addr