net::un::stream::legacy::config::ConfigSocketServer Class Reference

#include <ConfigSocketServer.h>

Inheritance diagram for net::un::stream::legacy::config::ConfigSocketServer:

Collaboration diagram for net::un::stream::legacy::config::ConfigSocketServer:

Public Member Functions
	ConfigSocketServer (const std::string &name)
	~ConfigSocketServer () override
Public Member Functions inherited from net::config::ConfigInstance
	ConfigInstance (ConfigInstance &)=delete
	ConfigInstance (ConfigInstance &&)=delete
ConfigInstance &	operator= (ConfigInstance &)=delete
ConfigInstance &	operator= (ConfigInstance &&)=delete
const std::string &	getInstanceName () const
ConfigInstance &	setInstanceName (const std::string &instanceName)
bool	getDisabled () const
ConfigInstance &	setDisabled (bool disabled=true)
ConfigInstance &	configurable (bool configurable)
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::un::config::ConfigAddress< net::config::ConfigAddressLocal >
ConfigAddress &	setSocketAddress (const SocketAddress &socketAddress)
ConfigAddress &	setSunPath (const std::string &sunPath)
std::string	getSunPath () const
void	configurable (bool configurable=true) final
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 net::config::ConfigAddress< net::un::SocketAddress >
net::un::SocketAddress	getSocketAddress (const typename net::un::SocketAddress::SockAddr &sockAddr, typename net::un::SocketAddress::SockLen sockAddrLen)
void	renew ()
Public Member Functions inherited from net::config::ConfigAddressBase< net::un::SocketAddress >
net::un::SocketAddress	getSocketAddress (const typename net::un::SocketAddress::SockAddr &sockAddr, typename net::un::SocketAddress::SockLen sockAddrLen)
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::ConfigPhysicalSocketServer
ConfigPhysicalSocketServer &	setBacklog (int newBacklog)
int	getBacklog () const
ConfigPhysicalSocketServer &	setAcceptsPerTick (int acceptsPerTickSet)
int	getAcceptsPerTick () const
ConfigPhysicalSocketServer &	setAcceptTimeout (const utils::Timeval &acceptTimeout)
utils::Timeval	getAcceptTimeout () 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)

Additional Inherited Members
Public Types inherited from net::config::stream::legacy::ConfigSocketServer< net::un::stream::config::ConfigSocketServer >
using	Instance
using	Legacy
Public Types inherited from net::config::ConfigInstance
enum class	Role { SERVER , CLIENT }
using	Instance = ConfigInstance
Public Types inherited from net::config::stream::ConfigSocketServer< net::un::config::ConfigAddress, net::un::config::ConfigAddressReverse >
using	Local
using	Remote
using	Connection
using	Socket
Static Public Member Functions inherited from net::config::ConfigInstance
static CLI::App *	getHelpTriggerApp ()
static CLI::App *	getShowConfigTriggerApp ()
static CLI::App *	getCommandlineTriggerApp ()
Static Public Attributes inherited from net::config::ConfigAddressLocal< net::un::SocketAddress >
static constexpr std::string_view	NAME
static constexpr std::string_view	DESCRIPTION
Static Public Attributes inherited from net::config::ConfigAddressReverse< net::un::SocketAddress >
static constexpr std::string_view	NAME
static constexpr std::string_view	DESCRIPTION
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 Public Attributes inherited from net::config::ConfigLegacy
static constexpr std::string_view	NAME {"legacy"}
static constexpr std::string_view	DESCRIPTION {"Configuration of legacy behavior"}
Protected Member Functions inherited from net::config::stream::legacy::ConfigSocketServer< net::un::stream::config::ConfigSocketServer >
	ConfigSocketServer (const std::string &name)
Protected Member Functions inherited from net::config::ConfigInstance
	ConfigInstance (const std::string &instanceName, Role role)
	~ConfigInstance () 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::un::stream::config::ConfigSocketServer
	ConfigSocketServer (net::config::ConfigInstance *instance)
	~ConfigSocketServer () override
Protected Member Functions inherited from net::config::stream::ConfigSocketServer< net::un::config::ConfigAddress, net::un::config::ConfigAddressReverse >
	ConfigSocketServer (net::config::ConfigInstance *instance)
Protected Member Functions inherited from net::un::config::ConfigAddress< net::config::ConfigAddressLocal >
	ConfigAddress (net::config::ConfigInstance *instance, const std::string &addressOptionName, const std::string &addressOptionDescription)
ConfigAddress &	sunPathRequired (bool required=true)
Protected Member Functions inherited from net::config::ConfigAddress< net::un::SocketAddress >
	ConfigAddress (ConfigInstance *instance, const std::string &addressOptionName, const std::string &addressOptionDescription)
	~ConfigAddress () override
Protected Member Functions inherited from net::config::ConfigAddressBase< net::un::SocketAddress >
	ConfigAddressBase (ConfigInstance *instance, const std::string &addressOptionName="", const std::string &addressOptionDescription="")
virtual	~ConfigAddressBase ()=default
Protected Member Functions inherited from net::un::config::ConfigAddressReverse< net::config::ConfigAddressReverse >
	ConfigAddressReverse (net::config::ConfigInstance *instance, const std::string &addressOptionName, const std::string &addressOptionDescription)
Protected Member Functions inherited from net::config::ConfigConnection
	ConfigConnection (ConfigInstance *instance)
	~ConfigConnection () override
Protected Member Functions inherited from net::config::ConfigPhysicalSocketServer
	ConfigPhysicalSocketServer (ConfigInstance *instance)
	~ConfigPhysicalSocketServer () 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)
Protected Member Functions inherited from net::config::ConfigLegacy
	ConfigLegacy (ConfigInstance *instance)
	~ConfigLegacy () override
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

Definition at line 56 of file ConfigSocketServer.h.

Constructor & Destructor Documentation

ConfigSocketServer()

net::un::stream::legacy::config::ConfigSocketServer::ConfigSocketServer ( const std::string & name )

explicit

Definition at line 52 of file ConfigSocketServer.cpp.

        : net::config::stream::legacy::ConfigSocketServer<net::un::stream::config::ConfigSocketServer>(name) {
    }

References net::config::stream::legacy::ConfigSocketServer< ConfigSocketServerBaseT >::ConfigSocketServer().

Here is the call graph for this function:

~ConfigSocketServer()

net::un::stream::legacy::config::ConfigSocketServer::~ConfigSocketServer ( )

override

Definition at line 56 of file ConfigSocketServer.cpp.

                                            {
    }

---

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

• net/un/stream/legacy/config/ConfigSocketServer.h
• net/un/stream/legacy/config/ConfigSocketServer.cpp