cosmos::AddressInfo Class Reference

A single name resolution result entry as found in AddressInfoList. More...

#include <AddressInfo.hxx>

Inheritance diagram for cosmos::AddressInfo:

Public Member Functions
SocketFamily	family () const
	Returns the family this address is for.
bool	isV4 () const
	Returns whether this is a IPv4 address.
bool	isV6 () const
	Returns whether this is a IPv6 address.
SocketType	type () const
	Returns the SocketType this address is for.
SocketProtocol	protocol () const
	Returns the protocol this address is for.
bool	hasCanonName () const
	Returns whether a canonical name result is available via canonName().
SysString	canonName () const
	Returns the canonical name, if available, or an empty string.
std::optional< IP4Address >	asIP4 () const
	Returns the IPv4 address stored in this entry, if applicable.
std::optional< IP6Address >	asIP6 () const
	Returns the IPv6 address stored in this entry, if applicable.

Protected Member Functions
bool	hasNext () const
	Returns whether another entry is available in the list.
const AddressInfo *	next () const
	Returns the next entry in the list.

Friends
struct	AddressInfoIterator

Detailed Description

A single name resolution result entry as found in AddressInfoList.

Definition at line 16 of file AddressInfo.hxx.

Member Function Documentation

asIP4()

std::optional< IP4Address > cosmos::AddressInfo::asIP4 ( ) const

inline

Returns the IPv4 address stored in this entry, if applicable.

Definition at line 55 of file AddressInfo.hxx.

                                              {
                if (!ai_addr || family() != SocketFamily::INET)
                        return std::nullopt;
 
                return IP4Address{*reinterpret_cast<sockaddr_in*>(ai_addr)};
        }

asIP6()

std::optional< IP6Address > cosmos::AddressInfo::asIP6 ( ) const

inline

Returns the IPv6 address stored in this entry, if applicable.

Definition at line 63 of file AddressInfo.hxx.

                                              {
                if (!ai_addr || family() != SocketFamily::INET6)
                        return std::nullopt;
 
                return IP6Address{*reinterpret_cast<sockaddr_in6*>(ai_addr)};
        }

canonName()

SysString cosmos::AddressInfo::canonName ( ) const

inline

Returns the canonical name, if available, or an empty string.

Definition at line 46 of file AddressInfo.hxx.

                                    {
                if (ai_canonname) {
                        return SysString{ai_canonname};
                } else {
                        return {};
                }
        }

family()

SocketFamily cosmos::AddressInfo::family ( ) const

inline

Returns the family this address is for.

Definition at line 21 of file AddressInfo.hxx.

                                    {
                return SocketFamily{ai_family};
        }

hasCanonName()

bool cosmos::AddressInfo::hasCanonName ( ) const

inline

Returns whether a canonical name result is available via canonName().

Definition at line 41 of file AddressInfo.hxx.

                                  {
                return ai_canonname != nullptr;
        }

hasNext()

bool cosmos::AddressInfo::hasNext ( ) const

inlineprotected

Returns whether another entry is available in the list.

Definition at line 75 of file AddressInfo.hxx.

                             {
                return ai_next != nullptr;
        }

isV4()

bool cosmos::AddressInfo::isV4 ( ) const

inline

Returns whether this is a IPv4 address.

Definition at line 26 of file AddressInfo.hxx.

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

isV6()

bool cosmos::AddressInfo::isV6 ( ) const

inline

Returns whether this is a IPv6 address.

Definition at line 28 of file AddressInfo.hxx.

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

next()

const AddressInfo * cosmos::AddressInfo::next ( ) const

inlineprotected

Returns the next entry in the list.

Definition at line 80 of file AddressInfo.hxx.

                                        {
                return reinterpret_cast<const AddressInfo*>(ai_next);
        }

protocol()

SocketProtocol cosmos::AddressInfo::protocol ( ) const

inline

Returns the protocol this address is for.

Definition at line 36 of file AddressInfo.hxx.

                                        {
                return SocketProtocol{ai_protocol};
        }

type()

SocketType cosmos::AddressInfo::type ( ) const

inline

Returns the SocketType this address is for.

Definition at line 31 of file AddressInfo.hxx.

                                {
                return SocketType{ai_socktype};
        }

Friends And Related Symbol Documentation

AddressInfoIterator

friend struct AddressInfoIterator

friend

Definition at line 72 of file AddressInfo.hxx.

---

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

• include/net/AddressInfo.hxx