cosmos::AddressHints Class Reference

Hints specification for queries done with AddressInfoList. More...

#include <AddressHints.hxx>

Inheritance diagram for cosmos::AddressHints:

Public Types
enum class	Flag : int {   V4_MAPPED = AI_V4MAPPED , ALL = AI_ALL , ADDR_CONFIG = AI_ADDRCONFIG , NUMERIC_HOST = AI_NUMERICHOST ,   PASSIVE = AI_PASSIVE , NUMERIC_SERVICE = AI_NUMERICSERV , CANON_NAME = AI_CANONNAME , IDN = AI_IDN ,   CANON_IDN = AI_CANONIDN }
	Flags used to influence the result list. More...
using	Flags = BitMask<Flag>
	Collection of flags to influence resolve behaviour.

Public Member Functions
	AddressHints ()
	Create an empty AddressHints structure with default Flags.
void	setFamily (const SocketFamily family)
	Restrict the SocketFamily to resolve for.
void	setType (const SocketType type)
	Restrict the SocketType to resolve for.
void	setProtocol (const SocketProtocol protocol)
	Restrict the SocketProtocol to resolve for.
Flags	flags () const
	Return the currently set Flags.
void	setFlags (const Flags flags)
	Set new flags influencing the resolve behaviour.

Detailed Description

Hints specification for queries done with AddressInfoList.

This type is used with AddressInfoList to limit the range of AddressInfo results returned. Although the base structure for this is the same as for the AddressInfo type, the purposes of the two are very different when used as an input parameter compared to when used as an output parameter.

This structure here is only used for specifying a few fields and some flags, not for reading back any data. Therefore libcosmos uses two distinct types for this.

Definition at line 27 of file AddressHints.hxx.

Member Typedef Documentation

Flags

using cosmos::AddressHints::Flags = BitMask<Flag>

Collection of flags to influence resolve behaviour.

Definition at line 58 of file AddressHints.hxx.

Member Enumeration Documentation

Flag

enum class cosmos::AddressHints::Flag : int

strong

Flags used to influence the result list.

Enumerator
V4_MAPPED	If the query is for IPv6 and there are no matches then return IPv4-mapped IPv6 addresses.
ALL	If combined with V4_MAPPED, then return both IPv6 and IPv4-mapped IPv6 addresses.
ADDR_CONFIG	Only return a result for a SocketFamily if the system has a least one (IPv4/IPv6) address configured (not counting loopback devices).
NUMERIC_HOST	The node name must be a numerical network address, no name lookup is made.
PASSIVE	If no node name is provided then return an address suitable for listening on (wildcard address is returned).
NUMERIC_SERVICE	If service name is specified then it must be a numerical string, no resolve is performed.
CANON_NAME	Returns the official name of the host in the first AddressInfo result in the result list.
IDN	Convert the provided node name into IDN format, if necessary.
CANON_IDN	If combined with CANON_NAME then a possible IDN encoding will be converted to the current locale in results.

Definition at line 32 of file AddressHints.hxx.

                        : int {
                V4_MAPPED                = AI_V4MAPPED,
                ALL                      = AI_ALL,
                ADDR_CONFIG              = AI_ADDRCONFIG,
                NUMERIC_HOST             = AI_NUMERICHOST,
                PASSIVE                  = AI_PASSIVE,
                NUMERIC_SERVICE          = AI_NUMERICSERV,
                CANON_NAME               = AI_CANONNAME,
                IDN                      = AI_IDN,
                CANON_IDN                = AI_CANONIDN,
#if 0 /* these are marked as deprecated */
                IDN_ALLOW_UNASSIGNED     = AI_IDN_ALLOW_UNASSIGNED,
                IDN_USE_STD3_ASCII_RULES = AI_IDN_USE_STD3_ASCII_RULES
#endif
        };

Constructor & Destructor Documentation

AddressHints()

cosmos::AddressHints::AddressHints ( )

inline

Create an empty AddressHints structure with default Flags.

The default flags are Flag::V4_MAPPED and Flag::ADDR_CONFIG. This matches the default behaviour of getaddrinfo() when no hints are passed.

Definition at line 68 of file AddressHints.hxx.

                       {
                std::memset(this, 0, sizeof(*this));
                setFlags(Flags{Flag::V4_MAPPED, Flag::ADDR_CONFIG});
        }

Member Function Documentation

flags()

Flags cosmos::AddressHints::flags ( ) const

inline

Return the currently set Flags.

Definition at line 100 of file AddressHints.hxx.

                            {
                return Flags{ai_flags};
        }

setFamily()

void cosmos::AddressHints::setFamily ( const SocketFamily family )

inline

Restrict the SocketFamily to resolve for.

Use SocketFamily::UNSPEC to return all families (this is the default).

Definition at line 78 of file AddressHints.hxx.

                                                  {
                ai_family = to_integral(family);
        }

setFlags()

void cosmos::AddressHints::setFlags ( const Flags flags )

inline

Set new flags influencing the resolve behaviour.

Definition at line 105 of file AddressHints.hxx.

                                         {
                ai_flags = flags.raw();
        }

setProtocol()

void cosmos::AddressHints::setProtocol ( const SocketProtocol protocol )

inline

Restrict the SocketProtocol to resolve for.

Use SocketProtocol::DEFAULT to return all protocols (this is the default).

Definition at line 95 of file AddressHints.hxx.

                                                        {
                ai_protocol = to_integral(protocol);
        }

setType()

void cosmos::AddressHints::setType ( const SocketType type )

inline

Restrict the SocketType to resolve for.

Use SocketType::ANY to return all types (this is the default).

Definition at line 86 of file AddressHints.hxx.

                                            {
                ai_socktype = to_integral(type);
        }

---

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

• include/net/AddressHints.hxx