net::rc::stream::config::ConfigSocketServer Class Reference

#include <ConfigSocketServer.h>

Inheritance diagram for net::rc::stream::config::ConfigSocketServer:

Collaboration diagram for net::rc::stream::config::ConfigSocketServer:

Protected Member Functions
	ConfigSocketServer (net::config::ConfigInstance *instance)
	~ConfigSocketServer () override
Protected Member Functions inherited from net::config::stream::ConfigSocketServer< net::rc::config::ConfigAddress, net::rc::config::ConfigAddressReverse >
	ConfigSocketServer (net::config::ConfigInstance *instance)
Protected Member Functions inherited from net::rc::config::ConfigAddress< net::config::ConfigAddressLocal >
	ConfigAddress (net::config::ConfigInstance *instance, const std::string &addressOptionName, const std::string &addressOptionDescription)
ConfigAddress &	setBtAddressRequired (bool required=true)
ConfigAddress &	setChannelRequired (bool required=true)
Protected Member Functions inherited from net::config::ConfigAddress< net::rc::SocketAddress >
	ConfigAddress (ConfigInstance *instance, const std::string &addressOptionName, const std::string &addressOptionDescription)
	~ConfigAddress () override
Protected Member Functions inherited from net::config::ConfigAddressBase< net::rc::SocketAddress >
	ConfigAddressBase (ConfigInstance *instance, const std::string &addressOptionName="", const std::string &addressOptionDescription="")
virtual	~ConfigAddressBase ()=default
Protected Member Functions inherited from net::config::ConfigSection
	ConfigSection (ConfigInstance *instance, const std::string &name, const std::string &description)
	ConfigSection (const ConfigSection &)=delete
	ConfigSection (ConfigSection &&)=delete
ConfigSection &	operator= (const ConfigSection &)=delete
ConfigSection &	operator= (ConfigSection &&)=delete
CLI::Option *	addOption (const std::string &name, const std::string &description)
CLI::Option *	addOption (const std::string &name, const std::string &description, const std::string &typeName)
CLI::Option *	addOption (const std::string &name, const std::string &description, const std::string &typeName, const CLI::Validator &additionalValidator)
template<typename ValueTypeT >
CLI::Option *	addOption (const std::string &name, const std::string &description, const std::string &typeName, ValueTypeT defaultValue)
template<typename ValueTypeT >
CLI::Option *	addOption (const std::string &name, const std::string &description, const std::string &typeName, ValueTypeT defaultValue, const CLI::Validator &additionalValidator)
CLI::Option *	addFlag (const std::string &name, const std::string &description, const std::string &typeName)
CLI::Option *	addFlag (const std::string &name, const std::string &description, const std::string &typeName, const CLI::Validator &additionalValidator)
template<typename ValueTypeT >
CLI::Option *	addFlag (const std::string &name, const std::string &description, const std::string &typeName, ValueTypeT defaultValue)
template<typename ValueTypeT >
CLI::Option *	addFlag (const std::string &name, const std::string &description, const std::string &typeName, ValueTypeT defaultValue, const CLI::Validator &additionalValidator)
CLI::Option *	addFlagFunction (const std::string &name, const std::function< void()> &callback, const std::string &description, const std::string &typeName, const std::string &defaultValue)
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)
void	required (CLI::Option *opt, bool req=true)
bool	required () const
template<typename ValueType >
CLI::Option *	addOption (const std::string &name, const std::string &description, const std::string &typeName, ValueType defaultValue)
template<typename ValueType >
CLI::Option *	addOption (const std::string &name, const std::string &description, const std::string &typeName, ValueType defaultValue, const CLI::Validator &additionalValidator)
template<typename ValueType >
CLI::Option *	addFlag (const std::string &name, const std::string &description, const std::string &typeName, ValueType defaultValue)
template<typename ValueType >
CLI::Option *	addFlag (const std::string &name, const std::string &description, const std::string &typeName, ValueType defaultValue, const CLI::Validator &additionalValidator)
Protected Member Functions inherited from net::config::ConfigConnection
	ConfigConnection (ConfigInstance *instance)
Protected Member Functions inherited from net::config::ConfigPhysicalSocketServer
	ConfigPhysicalSocketServer (ConfigInstance *instance)
Protected Member Functions inherited from net::config::ConfigPhysicalSocket
	ConfigPhysicalSocket (ConfigInstance *instance)
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 Types inherited from net::config::stream::ConfigSocketServer< net::rc::config::ConfigAddress, net::rc::config::ConfigAddressReverse >
using	Local
using	Remote
Public Types inherited from net::config::ConfigConnection
using	Connection = ConfigConnection
Public Types inherited from net::config::ConfigPhysicalSocketServer
using	Socket = ConfigPhysicalSocketServer
Public Member Functions inherited from net::rc::config::ConfigAddress< net::config::ConfigAddressLocal >
ConfigAddress &	setSocketAddress (const SocketAddress &socketAddress)
ConfigAddress &	setBtAddress (const std::string &btAddress)
std::string	getBtAddress () const
ConfigAddress &	setChannel (uint8_t channel)
uint8_t	getChannel () const
Public Member Functions inherited from net::config::ConfigAddress< net::rc::SocketAddress >
SocketAddress &	getSocketAddress ()
net::rc::SocketAddress	getSocketAddress (const typename net::rc::SocketAddress::SockAddr &sockAddr, typename net::rc::SocketAddress::SockLen sockAddrLen)
void	renew ()
Public Member Functions inherited from net::config::ConfigAddressBase< net::rc::SocketAddress >
net::rc::SocketAddress	getSocketAddress (const typename net::rc::SocketAddress::SockAddr &sockAddr, typename net::rc::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, const net::phy::PhysicalSocketOption > &	getSocketOptions ()
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 optName)
ConfigPhysicalSocket &	setReuseAddress (bool reuseAddress=true)
bool	getReuseAddress () const
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
Protected Attributes inherited from net::rc::config::ConfigAddress< net::config::ConfigAddressLocal >
CLI::Option *	btAddressOpt
CLI::Option *	channelOpt
Protected Attributes inherited from net::config::ConfigSection
CLI::App *	section = nullptr

Detailed Description

Definition at line 36 of file ConfigSocketServer.h.

Constructor & Destructor Documentation

ConfigSocketServer()

net::rc::stream::config::ConfigSocketServer::ConfigSocketServer ( net::config::ConfigInstance * instance )

explicitprotected

Definition at line 51 of file ConfigSocketServer.cpp.

        : net::config::stream::ConfigSocketServer<net::rc::config::ConfigAddress, net::rc::config::ConfigAddressReverse>(instance) {
        net::rc::config::ConfigAddress<net::config::ConfigAddressLocal>::setChannelRequired();
 
        net::rc::config::ConfigAddress<net::config::ConfigAddressLocal>::channelOpt //
            ->check(CLI::Range(1, 30));
    }

~ConfigSocketServer()

net::rc::stream::config::ConfigSocketServer::~ConfigSocketServer ( )

overrideprotected

Definition at line 59 of file ConfigSocketServer.cpp.

                                            {
    }

---

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

• net/rc/stream/config/ConfigSocketServer.h
• net/rc/stream/config/ConfigSocketServer.cpp