#include <ConfigSocketClient.h>

Inheritance diagram for net::config::stream::ConfigSocketClient< ConfigAddressLocalT, ConfigAddressRemoteT >:

Collaboration diagram for net::config::stream::ConfigSocketClient< ConfigAddressLocalT, ConfigAddressRemoteT >:

Public Types
using	Remote = ConfigAddressRemoteT<net::config::ConfigAddressRemote>
using	Local = ConfigAddressLocalT<net::config::ConfigAddressLocal>
using	Connection = net::config::ConfigConnection
using	Socket = net::config::ConfigPhysicalSocketClient

Protected Member Functions
	ConfigSocketClient (net::config::ConfigInstance *instance)
Protected Member Functions inherited from net::config::ConfigConnection
	ConfigConnection (ConfigInstance *instance)
	~ConfigConnection () override
Protected Member Functions inherited from utils::SubCommand
	SubCommand (SubCommand *parent, std::shared_ptr< utils::AppWithPtr > appWithPtr, const std::string &group, bool final)
template<typename ConcretSubCommand>
	SubCommand (SubCommand parent, ConcretSubCommand concretSubCommand, const std::string &group, bool final=true)
void	parse (int argc, char *argv[]) const
SubCommand *	description (const std::string &description)
SubCommand *	footer (const std::string &footer)
void	removeSubCommand ()
template<typename ValueTypeT>
CLI::Option *	setDefaultValue (CLI::Option *option, const ValueTypeT &value, bool clear=true) const
CLI::Option *	setConfigurable (CLI::Option *option, bool configurable) const
Protected Member Functions inherited from net::config::ConfigPhysicalSocketClient
	ConfigPhysicalSocketClient (ConfigInstance *instance)
	~ConfigPhysicalSocketClient () override
Protected Member Functions inherited from net::config::ConfigPhysicalSocket
template<typename ConcretConfigPhysicalSocketT>
	ConfigPhysicalSocket (ConfigInstance instance, ConcretConfigPhysicalSocketT section)
	~ConfigPhysicalSocket () override
CLI::Option *	addSocketOption (const std::string &name, int optLevel, int optName, const std::string &description, const std::string &typeName, const std::string &defaultValue, const CLI::Validator &validator)

Additional Inherited Members
Public Member Functions inherited from net::config::ConfigConnection
utils::Timeval	getReadTimeout () const
ConfigConnection &	setReadTimeout (const utils::Timeval &newReadTimeoutSet)
utils::Timeval	getWriteTimeout () const
ConfigConnection &	setWriteTimeout (const utils::Timeval &newWriteTimeoutSet)
std::size_t	getReadBlockSize () const
ConfigConnection &	setReadBlockSize (std::size_t newReadBlockSize)
std::size_t	getWriteBlockSize () const
ConfigConnection &	setWriteBlockSize (std::size_t newWriteBlockSize)
utils::Timeval	getTerminateTimeout () const
ConfigConnection &	setTerminateTimeout (const utils::Timeval &newTerminateTimeout)
Public Member Functions inherited from net::config::ConfigSection
template<typename T>
	ConfigSection (ConfigInstance instance, T sectionPtr, const std::string &group="Sections")
	~ConfigSection () override
	ConfigSection (const ConfigSection &)=delete
	ConfigSection (ConfigSection &&)=delete
ConfigSection &	operator= (const ConfigSection &)=delete
Public Member Functions inherited from utils::SubCommand
	SubCommand (const SubCommand &)=delete
	SubCommand (SubCommand &&)=delete
SubCommand &	operator= (const SubCommand &)=delete
SubCommand &	operator= (SubCommand &&)=delete
virtual	~SubCommand ()
std::string	getName () const
std::string	version () const
CLI::Option *	setConfig (const std::string &defaultConfigFile) const
CLI::Option *	setLogFile (const std::string &defaultLogFile) const
CLI::Option *	setVersionFlag (const std::string &version) const
bool	hasParent () const
SubCommand *	getParent () const
SubCommand *	allowExtras (bool allow=true)
SubCommand *	required (bool required=true, bool force=true)
SubCommand *	required (SubCommand *subCommand, bool required=true)
SubCommand *	required (CLI::Option *option, bool required=true)
bool	getRequired () const
SubCommand *	needs (SubCommand *subCommand, bool needs=true)
SubCommand *	disabled (SubCommand *subCommand, bool disabled=true)
SubCommand *	setRequireCallback (const std::function< void(void)> &callback)
SubCommand *	finalCallback (const std::function< void()> &finalCallback)
std::string	configToStr () const
std::string	help (const CLI::App *helpApp, const CLI::AppFormatMode &mode) const
template<typename NewSubCommand, typename... Args>
NewSubCommand *	newSubCommand (Args &&... args)
template<typename RequestedSubCommand>
RequestedSubCommand *	getSubCommand ()
template<typename RequestedSubCommand>
RequestedSubCommand *	getSubCommand () const
CLI::Option *	getOption (const std::string &name) const
CLI::Option *	addOption (const std::string &name, const std::string &description, const std::string &typeName, const CLI::Validator &validator) const
template<typename ValueTypeT>
CLI::Option *	addOption (const std::string &name, const std::string &description, const std::string &typeName, ValueTypeT defaultValue, const CLI::Validator &validator) const
template<typename ValueTypeT>
CLI::Option *	addOptionVariable (const std::string &name, ValueTypeT &variable, const std::string &description, const std::string &typeName, const CLI::Validator &additionalValidator) const
template<typename ValueTypeT>
CLI::Option *	addOptionVariable (const std::string &name, ValueTypeT &variable, const std::string &description, const std::string &typeName, ValueTypeT defaultValue, const CLI::Validator &additionalValidator) const
CLI::Option *	addOptionFunction (const std::string &name, const std::function< void(const std::string &)> &callback, const std::string &description, const std::string &typeName, const CLI::Validator &validator) const
template<typename ValueTypeT>
CLI::Option *	addOptionFunction (const std::string &name, const std::function< void(const std::string &)> &callback, const std::string &description, const std::string &typeName, ValueTypeT defaultValue, const CLI::Validator &validator) const
CLI::Option *	addFlag (const std::string &name, const std::string &description, const std::string &typeName, const CLI::Validator &validator) const
template<typename ValueTypeT>
CLI::Option *	addFlag (const std::string &name, const std::string &description, const std::string &typeName, ValueTypeT defaultValue, const CLI::Validator &validator) const
CLI::Option *	addFlagFunction (const std::string &name, const std::function< void()> &callback, const std::string &description, const std::string &typeName, const CLI::Validator &validator) const
CLI::Option *	addFlagFunction (const std::string &name, const std::function< void()> &callback, const std::string &description, const std::string &typeName, const std::string &defaultValue, const CLI::Validator &validator) const
Public Member Functions inherited from net::config::ConfigPhysicalSocketClient
ConfigPhysicalSocketClient &	setReconnect (bool reconnect=true)
bool	getReconnect () const
ConfigPhysicalSocketClient &	setReconnectTime (double time)
double	getReconnectTime () const
ConfigPhysicalSocketClient &	setConnectTimeout (const utils::Timeval &connectTimeout)
utils::Timeval	getConnectTimeout () const
Public Member Functions inherited from net::config::ConfigPhysicalSocket
const std::map< int, std::map< int, net::phy::PhysicalSocketOption > > &	getSocketOptions () const
ConfigPhysicalSocket &	addSocketOption (int optLevel, int optName, int optValue)
ConfigPhysicalSocket &	addSocketOption (int optLevel, int optName, const std::string &optValue)
ConfigPhysicalSocket &	addSocketOption (int optLevel, int optName, const std::vector< char > &optValue)
ConfigPhysicalSocket &	removeSocketOption (int optLevel, int optName)
ConfigPhysicalSocket &	setRetry (bool retry=true)
bool	getRetry () const
ConfigPhysicalSocket &	setRetryOnFatal (bool retry=true)
bool	getRetryOnFatal () const
ConfigPhysicalSocket &	setRetryTimeout (double sec)
double	getRetryTimeout () const
ConfigPhysicalSocket &	setRetryTries (unsigned int tries=0)
unsigned int	getRetryTries () const
ConfigPhysicalSocket &	setRetryBase (double base)
double	getRetryBase () const
ConfigPhysicalSocket &	setRetryLimit (unsigned int limit)
unsigned int	getRetryLimit () const
ConfigPhysicalSocket &	setRetryJitter (double percent)
double	getRetryJitter () const
template<typename ConcretConfigPhysicalSocket>
	ConfigPhysicalSocket (ConfigInstance instance, ConcretConfigPhysicalSocket section)
Static Public Attributes inherited from net::config::ConfigConnection
static constexpr std::string_view	NAME {"connection"}
static constexpr std::string_view	DESCRIPTION {"Configuration of established connections"}
Static Public Attributes inherited from net::config::ConfigPhysicalSocket
static constexpr std::string_view	NAME {"socket"}
static constexpr std::string_view	DESCRIPTION {"Configuration of socket behavior"}
Static Protected Member Functions inherited from utils::SubCommand
static CLI::App *	getHelpTriggerApp ()
static CLI::App *	getShowConfigTriggerApp ()
static CLI::App *	getCommandlineTriggerApp ()
Static Protected Attributes inherited from utils::SubCommand
static std::shared_ptr< CLI::Formatter >	sectionFormatter = makeSectionFormatter()
static std::map< std::string, std::string >	aliases
static CLI::App *	helpTriggerApp = nullptr
static CLI::App *	showConfigTriggerApp = nullptr
static CLI::App *	commandlineTriggerApp = nullptr

Detailed Description

template<template< template< typename SocketAddress > typename ConfigAddressTypeT > typename ConfigAddressLocalT, template< template< typename SocketAddress > typename ConfigAddressTypeT > typename ConfigAddressRemoteT = ConfigAddressLocalT>
class net::config::stream::ConfigSocketClient< ConfigAddressLocalT, ConfigAddressRemoteT >

Definition at line 58 of file ConfigSocketClient.h.

Member Typedef Documentation

◆ Connection

template<template< template< typename SocketAddress > typename ConfigAddressTypeT > typename ConfigAddressLocalT, template< template< typename SocketAddress > typename ConfigAddressTypeT > typename ConfigAddressRemoteT = ConfigAddressLocalT>

using net::config::stream::ConfigSocketClient< ConfigAddressLocalT, ConfigAddressRemoteT >::Connection = net::config::ConfigConnection

Definition at line 66 of file ConfigSocketClient.h.

◆ Local

template<template< template< typename SocketAddress > typename ConfigAddressTypeT > typename ConfigAddressLocalT, template< template< typename SocketAddress > typename ConfigAddressTypeT > typename ConfigAddressRemoteT = ConfigAddressLocalT>

using net::config::stream::ConfigSocketClient< ConfigAddressLocalT, ConfigAddressRemoteT >::Local = ConfigAddressLocalT<net::config::ConfigAddressLocal>

Definition at line 65 of file ConfigSocketClient.h.

◆ Remote

template<template< template< typename SocketAddress > typename ConfigAddressTypeT > typename ConfigAddressLocalT, template< template< typename SocketAddress > typename ConfigAddressTypeT > typename ConfigAddressRemoteT = ConfigAddressLocalT>

using net::config::stream::ConfigSocketClient< ConfigAddressLocalT, ConfigAddressRemoteT >::Remote = ConfigAddressRemoteT<net::config::ConfigAddressRemote>

Definition at line 64 of file ConfigSocketClient.h.

◆ Socket

template<template< template< typename SocketAddress > typename ConfigAddressTypeT > typename ConfigAddressLocalT, template< template< typename SocketAddress > typename ConfigAddressTypeT > typename ConfigAddressRemoteT = ConfigAddressLocalT>

using net::config::stream::ConfigSocketClient< ConfigAddressLocalT, ConfigAddressRemoteT >::Socket = net::config::ConfigPhysicalSocketClient

Definition at line 67 of file ConfigSocketClient.h.

Constructor & Destructor Documentation

◆ ConfigSocketClient()

template<template< template< typename SocketAddress > typename ConfigAddressType > typename ConfigAddressLocal, template< template< typename SocketAddress > typename ConfigAddressType > typename ConfigAddressRemote>

net::config::stream::ConfigSocketClient< ConfigAddressLocal, ConfigAddressRemote >::ConfigSocketClient ( net::config::ConfigInstance * instance )

explicitprotected

Definition at line 52 of file ConfigSocketClient.hpp.

        : ConfigAddressRemote<net::config::ConfigAddressRemote>(instance, "remote", "Remote side of connection")
        , ConfigAddressLocal<net::config::ConfigAddressLocal>(instance, "local", "Local side of connection")
        , net::config::ConfigConnection(instance)
        , net::config::ConfigPhysicalSocketClient(instance) {
    }

Referenced by net::in6::stream::config::ConfigSocketClient::ConfigSocketClient(), net::in::stream::config::ConfigSocketClient::ConfigSocketClient(), net::l2::stream::config::ConfigSocketClient::ConfigSocketClient(), net::rc::stream::config::ConfigSocketClient::ConfigSocketClient(), and net::un::stream::config::ConfigSocketClient::ConfigSocketClient().

Here is the caller graph for this function:

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

net/config/stream/ConfigSocketClient.h
net/config/stream/ConfigSocketClient.hpp

SNode.C

Public Types

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Connection

◆ Local

◆ Remote

◆ Socket

Constructor & Destructor Documentation

◆ ConfigSocketClient()