SNode.C
Loading...
Searching...
No Matches
net::config::stream::legacy::ConfigSocketClient< ConfigSocketClientBaseT > Class Template Reference

#include <ConfigSocketClient.h>

Inheritance diagram for net::config::stream::legacy::ConfigSocketClient< ConfigSocketClientBaseT >:
Collaboration diagram for net::config::stream::legacy::ConfigSocketClient< ConfigSocketClientBaseT >:

Public Types

using Instance = net::config::ConfigInstance
using Legacy = net::config::ConfigLegacy
Public Types inherited from net::config::ConfigInstance
enum class  Role { SERVER , CLIENT }
using Instance = ConfigInstance

Protected Member Functions

 ConfigSocketClient (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)
SubCommand * description (const std::string &description)
SubCommand * footer (const std::string &footer)
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::ConfigLegacy
 ConfigLegacy (ConfigInstance *instance)
 ~ConfigLegacy () override

Additional Inherited Members

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
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
void parse (int argc, char *argv[])
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 ()
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)
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, 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, 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)
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)
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
Static Public Member Functions inherited from utils::SubCommand
static CLI::App * getHelpTriggerApp ()
static CLI::App * getShowConfigTriggerApp ()
static CLI::App * getCommandlineTriggerApp ()
Static Public Attributes inherited from utils::SubCommand
static std::shared_ptr< CLI::Formatter > sectionFormatter = makeSectionFormatter()
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"}
Static Protected Attributes inherited from utils::SubCommand
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<typename ConfigSocketClientBaseT>
class net::config::stream::legacy::ConfigSocketClient< ConfigSocketClientBaseT >

Definition at line 55 of file ConfigSocketClient.h.

Member Typedef Documentation

◆ Instance

template<typename ConfigSocketClientBaseT>
using net::config::stream::legacy::ConfigSocketClient< ConfigSocketClientBaseT >::Instance = net::config::ConfigInstance

Definition at line 60 of file ConfigSocketClient.h.

◆ Legacy

template<typename ConfigSocketClientBaseT>
using net::config::stream::legacy::ConfigSocketClient< ConfigSocketClientBaseT >::Legacy = net::config::ConfigLegacy

Definition at line 61 of file ConfigSocketClient.h.

Constructor & Destructor Documentation

◆ ConfigSocketClient()

template<typename ConfigSocketClientBase>
net::config::stream::legacy::ConfigSocketClient< ConfigSocketClientBase >::ConfigSocketClient ( const std::string & name)
explicitprotected

Definition at line 51 of file ConfigSocketClient.hpp.

52 : net::config::ConfigInstance(name, net::config::ConfigInstance::Role::CLIENT)
53 , ConfigSocketClientBase(this)
54 , net::config::ConfigLegacy(this) {
55 }

References net::config::ConfigInstance::CLIENT.

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

Here is the caller graph for this function:
The documentation for this class was generated from the following files: