#include <ConfigAddress.h>

Inheritance diagram for net::in6::config::ConfigAddress< ConfigAddressTypeT >:

Collaboration diagram for net::in6::config::ConfigAddress< ConfigAddressTypeT >:

Public Member Functions
SocketAddress	getSocketAddress (const SocketAddress::SockAddr &sockAddr, SocketAddress::SockLen sockAddrLen)

ConfigAddress &	setSocketAddress (const SocketAddress &socketAddress)

ConfigAddress &	setHost (const std::string &ipOrHostname)

std::string	getHost () const

ConfigAddress &	setPort (uint16_t port)

uint16_t	getPort () const

ConfigAddress &	setNumeric (bool numeric=true)

bool	getNumeric () const

ConfigAddress &	setNumericReverse (bool numeric=true)

bool	getNumericReverse () const

Protected Member Functions
	ConfigAddress (net::config::ConfigInstance *instance, const std::string &addressOptionName, const std::string &addressOptionDescription)

ConfigAddress &	setIpv4Mapped (bool ipv4Mapped=true)

bool	getIpv4Mapped () const

ConfigAddress &	setAiFlags (int aiFlags)

int	getAiFlags () const

ConfigAddress &	setAiSockType (int aiSocktype)

int	getAiSockType () const

ConfigAddress &	setAiProtocol (int aiProtocol)

int	getAiProtocol () const

ConfigAddress &	setHostRequired (bool required=true)

ConfigAddress &	setPortRequired (bool required=true)

Private Types
using	Super = ConfigAddressTypeT<SocketAddress>

Private Member Functions
SocketAddress *	init () final

Private Attributes
CLI::Option *	hostOpt = nullptr

CLI::Option *	portOpt = nullptr

CLI::Option *	numericOpt = nullptr

CLI::Option *	numericReverseOpt = nullptr

CLI::Option *	ipv4MappedOpt = nullptr

int	aiFlags = 0

int	aiSockType = 0

int	aiProtocol = 0

Detailed Description

template<template< typename SocketAddressT > typename ConfigAddressTypeT>
class net::in6::config::ConfigAddress< ConfigAddressTypeT >

Definition at line 68 of file ConfigAddress.h.

Member Typedef Documentation

◆ Super

template<template< typename SocketAddressT > typename ConfigAddressTypeT>

using net::in6::config::ConfigAddress< ConfigAddressTypeT >::Super = ConfigAddressTypeT<SocketAddress>

private

Definition at line 70 of file ConfigAddress.h.

Constructor & Destructor Documentation

◆ ConfigAddress()

template<template< typename SocketAddress > typename ConfigAddressType>

net::in6::config::ConfigAddress< ConfigAddressType >::ConfigAddress	(	net::config::ConfigInstance *	instance,
		const std::string &	addressOptionName,
		const std::string &	addressOptionDescription )

explicitprotected

Definition at line 87 of file ConfigAddress.cpp.

        : Super(instance, addressOptionName, addressOptionDescription) {
        hostOpt = Super::addOption( //
            "--host",
            "Host name or IPv6 address",
            "hostname|IPv6",
            "::",
            CLI::TypeValidator<std::string>());
        portOpt = Super::addOption( //
            "--port",
            "Port number",
            "port",
            0,
            CLI::Range(std::numeric_limits<uint16_t>::min(), std::numeric_limits<uint16_t>::max()));
        numericOpt = Super::addFlag( //
            "--numeric",
            "Suppress host name lookup",
            "bool",
            XSTR(IPV6_NUMERIC),
            CLI::IsMember({"true", "false"}));
        numericReverseOpt = Super::addFlag( //
            "--numeric-reverse",
            "Suppress reverse host name lookup",
            "bool",
            XSTR(IPV6_NUMERIC_REVERSE),
            CLI::IsMember({"true", "false"}));
        ipv4MappedOpt = Super::addFlag( //
            "--ipv4-mapped",
            "Resolve IPv4-mapped IPv6 addresses also",
            "bool",
            XSTR(IPV4_MAPPED),
            CLI::IsMember({"true", "false"}));
    }

Member Function Documentation

◆ getAiFlags()

template<template< typename SocketAddress > typename ConfigAddressType>

int net::in6::config::ConfigAddress< ConfigAddressType >::getAiFlags ( ) const

protected

Definition at line 249 of file ConfigAddress.cpp.

                                                           {
        return aiFlags;
    }

◆ getAiProtocol()

template<template< typename SocketAddress > typename ConfigAddressType>

int net::in6::config::ConfigAddress< ConfigAddressType >::getAiProtocol ( ) const

protected

Definition at line 273 of file ConfigAddress.cpp.

                                                              {
        return aiProtocol;
    }

◆ getAiSockType()

template<template< typename SocketAddress > typename ConfigAddressType>

int net::in6::config::ConfigAddress< ConfigAddressType >::getAiSockType ( ) const

protected

Definition at line 261 of file ConfigAddress.cpp.

                                                              {
        return aiSockType;
    }

◆ getHost()

template<template< typename SocketAddress > typename ConfigAddressType>

std::string net::in6::config::ConfigAddress< ConfigAddressType >::getHost ( ) const

Definition at line 179 of file ConfigAddress.cpp.

                                                              {
        return hostOpt->as<std::string>();
    }

◆ getIpv4Mapped()

template<template< typename SocketAddress > typename ConfigAddressType>

bool net::in6::config::ConfigAddress< ConfigAddressType >::getIpv4Mapped ( ) const

protected

Definition at line 237 of file ConfigAddress.cpp.

                                                               {
        return ipv4MappedOpt->as<bool>();
    }

◆ getNumeric()

template<template< typename SocketAddress > typename ConfigAddressType>

bool net::in6::config::ConfigAddress< ConfigAddressType >::getNumeric ( ) const

Definition at line 212 of file ConfigAddress.cpp.

                                                            {
        return numericOpt->as<bool>();
    }

◆ getNumericReverse()

template<template< typename SocketAddressT > typename ConfigAddressTypeT>

bool net::in6::config::ConfigAddress< ConfigAddressTypeT >::getNumericReverse ( ) const

◆ getPort()

template<template< typename SocketAddress > typename ConfigAddressType>

uint16_t net::in6::config::ConfigAddress< ConfigAddressType >::getPort ( ) const

Definition at line 196 of file ConfigAddress.cpp.

                                                             {
        return portOpt->as<uint16_t>();
    }

◆ getSocketAddress()

template<template< typename SocketAddress > typename ConfigAddressType>

SocketAddress net::in6::config::ConfigAddress< ConfigAddressType >::getSocketAddress	(	const SocketAddress::SockAddr &	sockAddr,
		SocketAddress::SockLen	sockAddrLen )

Definition at line 142 of file ConfigAddress.cpp.

                                                                                                       {
        SocketAddress socketAddress;
        try {
            socketAddress = SocketAddress(sockAddr, sockAddrLen, numericReverseOpt->as<bool>());
        } catch ([[maybe_unused]] const SocketAddress::BadSocketAddress& badSocketAddress) {
            try {
                socketAddress = Super::getSocketAddress(sockAddr, sockAddrLen);
            } catch ([[maybe_unused]] const SocketAddress::BadSocketAddress& badSocketAddress) { // cppcheck-suppress shadowVariable
                throw;
            }
        }
 
        return socketAddress;
    }

◆ init()

template<template< typename SocketAddress > typename ConfigAddressType>

SocketAddress * net::in6::config::ConfigAddress< ConfigAddressType >::init ( )

finalprivate

Definition at line 124 of file ConfigAddress.cpp.

                                                          {
        SocketAddress* socketAddress = new SocketAddress(hostOpt->as<std::string>(), portOpt->as<uint16_t>());
 
        try {
            socketAddress->init({.aiFlags = (aiFlags & ~AI_NUMERICHOST) | (numericOpt->as<bool>() ? AI_NUMERICHOST : 0),
                                 .aiSockType = aiSockType,
                                 .aiProtocol = aiProtocol});
        } catch (const core::socket::SocketAddress::BadSocketAddress&) {
            delete socketAddress;
            socketAddress = nullptr;
 
            throw;
        }
 
        return socketAddress;
    }

◆ setAiFlags()

template<template< typename SocketAddress > typename ConfigAddressType>

ConfigAddress< ConfigAddressType > & net::in6::config::ConfigAddress< ConfigAddressType >::setAiFlags ( int aiFlags )

protected

Definition at line 242 of file ConfigAddress.cpp.

                                                                                              {
        this->aiFlags = aiFlags;
 
        return *this;
    }

◆ setAiProtocol()

template<template< typename SocketAddress > typename ConfigAddressType>

ConfigAddress< ConfigAddressType > & net::in6::config::ConfigAddress< ConfigAddressType >::setAiProtocol ( int aiProtocol )

protected

Definition at line 266 of file ConfigAddress.cpp.

                                                                                                    {
        this->aiProtocol = aiProtocol;
 
        return *this;
    }

◆ setAiSockType()

template<template< typename SocketAddress > typename ConfigAddressType>

ConfigAddress< ConfigAddressType > & net::in6::config::ConfigAddress< ConfigAddressType >::setAiSockType ( int aiSocktype )

protected

Definition at line 254 of file ConfigAddress.cpp.

                                                                                                    {
        this->aiSockType = aiSockType;
 
        return *this;
    }

◆ setHost()

template<template< typename SocketAddress > typename ConfigAddressType>

ConfigAddress< ConfigAddressType > & net::in6::config::ConfigAddress< ConfigAddressType >::setHost ( const std::string & ipOrHostname )

Definition at line 167 of file ConfigAddress.cpp.

                                                                                                             {
        const utils::PreserveErrno preserveErrno;
 
        hostOpt //
            ->default_val(ipOrHostname)
            ->clear();
        Super::required(hostOpt, false);
 
        return *this;
    }

◆ setHostRequired()

template<template< typename SocketAddress > typename ConfigAddressType>

ConfigAddress< ConfigAddressType > & net::in6::config::ConfigAddress< ConfigAddressType >::setHostRequired ( bool required = true )

protected

Definition at line 278 of file ConfigAddress.cpp.

                                                                                                     {
        Super::required(hostOpt, required);
 
        return *this;
    }

◆ setIpv4Mapped()

template<template< typename SocketAddress > typename ConfigAddressType>

ConfigAddress< ConfigAddressType > & net::in6::config::ConfigAddress< ConfigAddressType >::setIpv4Mapped ( bool ipv4Mapped = true )

protected

Definition at line 226 of file ConfigAddress.cpp.

                                                                                                     {
        const utils::PreserveErrno preserveErrno;
 
        ipv4MappedOpt //
            ->default_val(ipv4Mapped)
            ->clear();
 
        return *this;
    }

◆ setNumeric()

template<template< typename SocketAddress > typename ConfigAddressType>

ConfigAddress< ConfigAddressType > & net::in6::config::ConfigAddress< ConfigAddressType >::setNumeric ( bool numeric = true )

Definition at line 201 of file ConfigAddress.cpp.

                                                                                               {
        const utils::PreserveErrno preserveErrno;
 
        numericOpt //
            ->default_str(numeric ? "true" : "false")
            ->clear();
 
        return *this;
    }

◆ setNumericReverse()

template<template< typename SocketAddress > typename ConfigAddressType>

ConfigAddress< ConfigAddressType > & net::in6::config::ConfigAddress< ConfigAddressType >::setNumericReverse ( bool numeric = true )

Definition at line 217 of file ConfigAddress.cpp.

                                                                                                      {
        numericReverseOpt //
            ->default_str(numeric ? "true" : "false")
            ->clear();
 
        return *this;
    }

◆ setPort()

template<template< typename SocketAddress > typename ConfigAddressType>

ConfigAddress< ConfigAddressType > & net::in6::config::ConfigAddress< ConfigAddressType >::setPort ( uint16_t port )

Definition at line 184 of file ConfigAddress.cpp.

                                                                                             {
        const utils::PreserveErrno preserveErrno;
 
        portOpt //
            ->default_val(port)
            ->clear();
        Super::required(portOpt, false);
 
        return *this;
    }

◆ setPortRequired()

template<template< typename SocketAddress > typename ConfigAddressType>

ConfigAddress< ConfigAddressType > & net::in6::config::ConfigAddress< ConfigAddressType >::setPortRequired ( bool required = true )

protected

Definition at line 285 of file ConfigAddress.cpp.

                                                                                                     {
        Super::required(portOpt, required);
 
        return *this;
    }

◆ setSocketAddress()

template<template< typename SocketAddress > typename ConfigAddressType>

ConfigAddress< ConfigAddressType > & net::in6::config::ConfigAddress< ConfigAddressType >::setSocketAddress ( const SocketAddress & socketAddress )

Definition at line 159 of file ConfigAddress.cpp.

                                                                                                                           {
        setHost(socketAddress.getHost());
        setPort(socketAddress.getPort());
 
        return *this;
    }

Member Data Documentation

◆ aiFlags

template<template< typename SocketAddressT > typename ConfigAddressTypeT>

int net::in6::config::ConfigAddress< ConfigAddressTypeT >::aiFlags = 0

private

Definition at line 121 of file ConfigAddress.h.

◆ aiProtocol

template<template< typename SocketAddressT > typename ConfigAddressTypeT>

int net::in6::config::ConfigAddress< ConfigAddressTypeT >::aiProtocol = 0

private

Definition at line 123 of file ConfigAddress.h.

◆ aiSockType

template<template< typename SocketAddressT > typename ConfigAddressTypeT>

int net::in6::config::ConfigAddress< ConfigAddressTypeT >::aiSockType = 0

private

Definition at line 122 of file ConfigAddress.h.

◆ hostOpt

template<template< typename SocketAddressT > typename ConfigAddressTypeT>

CLI::Option* net::in6::config::ConfigAddress< ConfigAddressTypeT >::hostOpt = nullptr

private

Definition at line 115 of file ConfigAddress.h.

◆ ipv4MappedOpt

template<template< typename SocketAddressT > typename ConfigAddressTypeT>

CLI::Option* net::in6::config::ConfigAddress< ConfigAddressTypeT >::ipv4MappedOpt = nullptr

private

Definition at line 119 of file ConfigAddress.h.

◆ numericOpt

template<template< typename SocketAddressT > typename ConfigAddressTypeT>

CLI::Option* net::in6::config::ConfigAddress< ConfigAddressTypeT >::numericOpt = nullptr

private

Definition at line 117 of file ConfigAddress.h.

◆ numericReverseOpt

template<template< typename SocketAddressT > typename ConfigAddressTypeT>

CLI::Option* net::in6::config::ConfigAddress< ConfigAddressTypeT >::numericReverseOpt = nullptr

private

Definition at line 118 of file ConfigAddress.h.

◆ portOpt

template<template< typename SocketAddressT > typename ConfigAddressTypeT>

CLI::Option* net::in6::config::ConfigAddress< ConfigAddressTypeT >::portOpt = nullptr

private

Definition at line 116 of file ConfigAddress.h.

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

net/in6/config/ConfigAddress.h
net/in6/config/ConfigAddress.cpp

Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ Super

Constructor & Destructor Documentation

◆ ConfigAddress()

Member Function Documentation

◆ getAiFlags()

◆ getAiProtocol()

◆ getAiSockType()

◆ getHost()

◆ getIpv4Mapped()

◆ getNumeric()

◆ getNumericReverse()

◆ getPort()

◆ getSocketAddress()

◆ init()

◆ setAiFlags()

◆ setAiProtocol()

◆ setAiSockType()

◆ setHost()

◆ setHostRequired()

◆ setIpv4Mapped()

◆ setNumeric()

◆ setNumericReverse()

◆ setPort()

◆ setPortRequired()

◆ setSocketAddress()

Member Data Documentation

◆ aiFlags

◆ aiProtocol

◆ aiSockType

◆ hostOpt

◆ ipv4MappedOpt

◆ numericOpt

◆ numericReverseOpt

◆ portOpt