core::socket::stream::SocketServer< SocketAcceptorT, SocketContextFactoryT, Args > Class Template Reference

#include <SocketServer.h>

Inheritance diagram for core::socket::stream::SocketServer< SocketAcceptorT, SocketContextFactoryT, Args >:

Collaboration diagram for core::socket::stream::SocketServer< SocketAcceptorT, SocketContextFactoryT, Args >:

Public Types
using	SocketConnection = typename SocketAcceptor::SocketConnection
using	SocketAddress = typename SocketAcceptor::SocketAddress
Public Types inherited from core::socket::Socket< SocketAcceptorT::Config >
using	Config = SocketAcceptorT::Config

Public Member Functions
	SocketServer (const std::string &name, const std::function< void(SocketConnection *)> &onConnect, const std::function< void(SocketConnection *)> &onConnected, const std::function< void(SocketConnection *)> &onDisconnect, Args &&... args)
	SocketServer (const std::function< void(SocketConnection *)> &onConnect, const std::function< void(SocketConnection *)> &onConnected, const std::function< void(SocketConnection *)> &onDisconnect, Args &&... args)
	SocketServer (const std::string &name, Args &&... args)
	SocketServer (Args &&... args)
void	listen (const std::function< void(const SocketAddress &, core::socket::State)> &onStatus) const
void	listen (const SocketAddress &localAddress, const std::function< void(const SocketAddress &, core::socket::State)> &onStatus) const
void	listen (const SocketAddress &localAddress, int backlog, const std::function< void(const SocketAddress &, core::socket::State)> &onStatus) const
std::function< void(SocketConnection *)>	setOnConnect (const std::function< void(SocketConnection *)> &onConnect)
std::function< void(SocketConnection *)>	setOnConnected (const std::function< void(SocketConnection *)> &onConnected)
std::function< void(SocketConnection *)>	setOnDisconnect (const std::function< void(SocketConnection *)> &onDisconnect)
std::shared_ptr< SocketContextFactory >	getSocketContextFactory ()
Public Member Functions inherited from core::socket::Socket< SocketAcceptorT::Config >
	Socket (const std::string &name)
	Socket (const Socket &)=default
	Socket (Socket &&) noexcept=delete
Socket &	operator= (const Socket &)=default
Socket &	operator= (Socket &&) noexcept=delete
virtual	~Socket ()
Config &	getConfig () const

Private Types
using	SocketAcceptor = SocketAcceptorT
using	SocketContextFactory = SocketContextFactoryT
using	Super = core::socket::Socket< typename SocketAcceptor::Config >

Private Member Functions
void	realListen (const std::function< void(const SocketAddress &, core::socket::State)> &onStatus, unsigned int tries, double retryTimeoutScale) const

Private Attributes
std::shared_ptr< SocketContextFactory >	socketContextFactory
std::function< void(SocketConnection *)>	onConnect
std::function< void(SocketConnection *)>	onConnected
std::function< void(SocketConnection *)>	onDisconnect
std::size_t	totalOk = 0
std::size_t	currentOk = 0
std::size_t	currentError = 0
std::size_t	currentFatal = 0

Additional Inherited Members
Protected Attributes inherited from core::socket::Socket< SocketAcceptorT::Config >
std::shared_ptr< Config >	config

Detailed Description

template<typename SocketAcceptorT, typename SocketContextFactoryT, typename... Args>
requires std::is_base_of_v<core::socket::stream::SocketContextFactory, SocketContextFactoryT>
class core::socket::stream::SocketServer< SocketAcceptorT, SocketContextFactoryT, Args >

Definition at line 66 of file SocketServer.h.

Member Typedef Documentation

SocketAcceptor

template<typename SocketAcceptorT , typename SocketContextFactoryT , typename... Args>

using core::socket::stream::SocketServer< SocketAcceptorT, SocketContextFactoryT, Args >::SocketAcceptor = SocketAcceptorT

private

Definition at line 68 of file SocketServer.h.

SocketAddress

template<typename SocketAcceptorT , typename SocketContextFactoryT , typename... Args>

using core::socket::stream::SocketServer< SocketAcceptorT, SocketContextFactoryT, Args >::SocketAddress = typename SocketAcceptor::SocketAddress

Definition at line 75 of file SocketServer.h.

SocketConnection

template<typename SocketAcceptorT , typename SocketContextFactoryT , typename... Args>

using core::socket::stream::SocketServer< SocketAcceptorT, SocketContextFactoryT, Args >::SocketConnection = typename SocketAcceptor::SocketConnection

Definition at line 74 of file SocketServer.h.

SocketContextFactory

template<typename SocketAcceptorT , typename SocketContextFactoryT , typename... Args>

using core::socket::stream::SocketServer< SocketAcceptorT, SocketContextFactoryT, Args >::SocketContextFactory = SocketContextFactoryT

private

Definition at line 69 of file SocketServer.h.

Super

template<typename SocketAcceptorT , typename SocketContextFactoryT , typename... Args>

using core::socket::stream::SocketServer< SocketAcceptorT, SocketContextFactoryT, Args >::Super = core::socket::Socket<typename SocketAcceptor::Config>

private

Definition at line 71 of file SocketServer.h.

Constructor & Destructor Documentation

SocketServer() [1/4]

template<typename SocketAcceptorT , typename SocketContextFactoryT , typename... Args>

core::socket::stream::SocketServer< SocketAcceptorT, SocketContextFactoryT, Args >::SocketServer ( const std::string &  name, const std::function< void(SocketConnection *)> &  onConnect, const std::function< void(SocketConnection *)> &  onConnected, const std::function< void(SocketConnection *)> &  onDisconnect, Args &&...  args  )

inline

Definition at line 77 of file SocketServer.h.

            : Super(name)
            , socketContextFactory(std::make_shared<SocketContextFactory>(std::forward<Args>(args)...))
            , onConnect(onConnect)
            , onConnected(onConnected)
            , onDisconnect(onDisconnect) {
        }

References core::socket::stream::SocketServer< SocketAcceptorT, SocketContextFactoryT, Args >::onConnect, core::socket::stream::SocketServer< SocketAcceptorT, SocketContextFactoryT, Args >::onConnected, core::socket::stream::SocketServer< SocketAcceptorT, SocketContextFactoryT, Args >::onDisconnect, and core::socket::stream::SocketServer< SocketAcceptorT, SocketContextFactoryT, Args >::socketContextFactory.

SocketServer() [2/4]

template<typename SocketAcceptorT , typename SocketContextFactoryT , typename... Args>

core::socket::stream::SocketServer< SocketAcceptorT, SocketContextFactoryT, Args >::SocketServer ( const std::function< void(SocketConnection *)> &  onConnect, const std::function< void(SocketConnection *)> &  onConnected, const std::function< void(SocketConnection *)> &  onDisconnect, Args &&...  args  )

inline

Definition at line 89 of file SocketServer.h.

            : SocketServer("", onConnect, onConnected, onDisconnect, std::forward<Args>(args)...) {
        }

SocketServer() [3/4]

template<typename SocketAcceptorT , typename SocketContextFactoryT , typename... Args>

core::socket::stream::SocketServer< SocketAcceptorT, SocketContextFactoryT, Args >::SocketServer ( const std::string &  name, Args &&...  args  )

inline

Definition at line 97 of file SocketServer.h.

            : SocketServer(
                  name,
                  [name](SocketConnection* socketConnection) { // onConnect
                      VLOG(2) << name << ": OnConnect";
 
                      VLOG(2) << "  Local: " << socketConnection->getLocalAddress().toString();
                      VLOG(2) << "   Peer: " << socketConnection->getRemoteAddress().toString();
                  },
                  [name](SocketConnection* socketConnection) { // onConnected
                      VLOG(2) << name << ": OnConnected";
 
                      VLOG(2) << "  Local: " << socketConnection->getLocalAddress().toString();
                      VLOG(2) << "   Peer: " << socketConnection->getRemoteAddress().toString();
                  },
                  [name](SocketConnection* socketConnection) { // onDisconnect
                      VLOG(2) << name << ": OnDisconnect";
 
                      VLOG(2) << "  Local: " << socketConnection->getLocalAddress().toString();
                      VLOG(2) << "   Peer: " << socketConnection->getRemoteAddress().toString();
                  },
                  std::forward<Args>(args)...) {
        }

SocketServer() [4/4]

template<typename SocketAcceptorT , typename SocketContextFactoryT , typename... Args>

core::socket::stream::SocketServer< SocketAcceptorT, SocketContextFactoryT, Args >::SocketServer ( Args &&...  args )

inlineexplicit

Definition at line 121 of file SocketServer.h.

            : SocketServer("", std::forward<Args>(args)...) {
        }

Member Function Documentation

getSocketContextFactory()

template<typename SocketAcceptorT , typename SocketContextFactoryT , typename... Args>

std::shared_ptr< SocketContextFactory > core::socket::stream::SocketServer< SocketAcceptorT, SocketContextFactoryT, Args >::getSocketContextFactory ( )

inline

Definition at line 237 of file SocketServer.h.

                                                                      {
            return socketContextFactory;
        }

References core::socket::stream::SocketServer< SocketAcceptorT, SocketContextFactoryT, Args >::socketContextFactory.

listen() [1/3]

template<typename SocketAcceptorT , typename SocketContextFactoryT , typename... Args>

void core::socket::stream::SocketServer< SocketAcceptorT, SocketContextFactoryT, Args >::listen ( const SocketAddress &  localAddress, const std::function< void(const SocketAddress &, core::socket::State)> &  onStatus  ) const

inline

Definition at line 198 of file SocketServer.h.

                                                                                                    {
            Super::config->Local::setSocketAddress(localAddress);
 
            listen(onStatus);
        }

listen() [2/3]

template<typename SocketAcceptorT , typename SocketContextFactoryT , typename... Args>

void core::socket::stream::SocketServer< SocketAcceptorT, SocketContextFactoryT, Args >::listen ( const SocketAddress &  localAddress, int  backlog, const std::function< void(const SocketAddress &, core::socket::State)> &  onStatus  ) const

inline

Definition at line 205 of file SocketServer.h.

                                                                                                    {
            Super::config->Local::setBacklog(backlog);
 
            listen(localAddress, onStatus);
        }

listen() [3/3]

template<typename SocketAcceptorT , typename SocketContextFactoryT , typename... Args>

void core::socket::stream::SocketServer< SocketAcceptorT, SocketContextFactoryT, Args >::listen ( const std::function< void(const SocketAddress &, core::socket::State)> &  onStatus ) const

inline

Definition at line 194 of file SocketServer.h.

                                                                                                    {
            realListen(onStatus, 0, 1);
        }

References core::socket::stream::SocketServer< SocketAcceptorT, SocketContextFactoryT, Args >::realListen().

Referenced by main().

Here is the call graph for this function:

Here is the caller graph for this function:

realListen()

template<typename SocketAcceptorT , typename SocketContextFactoryT , typename... Args>

void core::socket::stream::SocketServer< SocketAcceptorT, SocketContextFactoryT, Args >::realListen ( const std::function< void(const SocketAddress &, core::socket::State)> &  onStatus, unsigned int  tries, double  retryTimeoutScale  ) const

inlineprivate

Definition at line 126 of file SocketServer.h.

                                                        {
            if (core::SNodeC::state() == core::State::RUNNING || core::SNodeC::state() == core::State::INITIALIZED) {
                new SocketAcceptor(
                    socketContextFactory,
                    onConnect,
                    onConnected,
                    onDisconnect,
                    [server = *this, onStatus, tries, retryTimeoutScale](const SocketAddress& socketAddress,
                                                                         core::socket::State state) mutable {
                        const bool retry = (state & core::socket::State::NO_RETRY) == 0 &&
                                           (server.getConfig().getRetryTries() == 0 || tries < server.getConfig().getRetryTries());
 
                        state &= ~core::socket::State::NO_RETRY;
                        onStatus(socketAddress, state);
 
                        if (retry) {
                            switch (state) {
                                case core::socket::State::OK:
                                    server.currentOk++;
                                    [[fallthrough]];
                                case core::socket::State::DISABLED:
                                    break;
                                case core::socket::State::ERROR:
                                    server.currentError++;
                                    break;
                                case core::socket::State::FATAL:
                                    server.currentFatal++;
                                    break;
                            }
 
                            if ((server.currentError > 0 && server.getConfig().getRetry()) ||
                                (server.currentFatal > 0 && server.getConfig().getRetry() && server.getConfig().getRetryOnFatal())) {
                                if (server.totalOk < server.currentError + server.currentFatal) {
                                    server.totalOk += server.currentOk;
 
                                    double relativeRetryTimeout =
                                        server.getConfig().getRetryLimit() > 0
                                            ? std::min<double>(server.getConfig().getRetryTimeout() * retryTimeoutScale,
                                                               server.getConfig().getRetryLimit())
                                            : server.getConfig().getRetryTimeout() * retryTimeoutScale;
                                    relativeRetryTimeout -= utils::Random::getInRange(-server.getConfig().getRetryJitter(),
                                                                                      server.getConfig().getRetryJitter()) *
                                                            relativeRetryTimeout / 100.;
 
                                    LOG(INFO) << server.getConfig().getInstanceName() << ": OnStatus";
                                    LOG(INFO) << " retrying in " << relativeRetryTimeout << " seconds";
 
                                    core::timer::Timer::singleshotTimer(
                                        [server, onStatus, tries, retryTimeoutScale]() mutable {
                                            server.getConfig().Local::renew();
                                            server.currentOk = 0;
                                            server.currentError = 0;
                                            server.currentFatal = 0;
 
                                            server.realListen(onStatus, tries + 1, retryTimeoutScale * server.getConfig().getRetryBase());
                                        },
                                        relativeRetryTimeout);
                                }
                            }
                        }
                    },
                    Super::config);
            }
        }

References core::socket::State::DISABLED, core::socket::State::ERROR, core::socket::State::FATAL, utils::Random::getInRange(), core::INITIALIZED, core::socket::State::NO_RETRY, core::socket::State::OK, core::socket::stream::SocketServer< SocketAcceptorT, SocketContextFactoryT, Args >::onConnect, core::socket::stream::SocketServer< SocketAcceptorT, SocketContextFactoryT, Args >::onConnected, core::socket::stream::SocketServer< SocketAcceptorT, SocketContextFactoryT, Args >::onDisconnect, core::socket::State::operator&(), core::socket::State::operator&=(), core::socket::State::operator==(), core::RUNNING, core::timer::Timer::singleshotTimer(), core::socket::stream::SocketServer< SocketAcceptorT, SocketContextFactoryT, Args >::socketContextFactory, and core::SNodeC::state().

Referenced by core::socket::stream::SocketServer< SocketAcceptorT, SocketContextFactoryT, Args >::listen().

Here is the call graph for this function:

Here is the caller graph for this function:

setOnConnect()

template<typename SocketAcceptorT , typename SocketContextFactoryT , typename... Args>

std::function< void(SocketConnection *)> core::socket::stream::SocketServer< SocketAcceptorT, SocketContextFactoryT, Args >::setOnConnect ( const std::function< void(SocketConnection *)> &  onConnect )

inline

Definition at line 213 of file SocketServer.h.

                                                                                                                 {
            std::function<void(SocketConnection*)> oldOnConnect = this->onConnect;
 
            this->onConnect = onConnect;
 
            return oldOnConnect;
        }

References core::socket::stream::SocketServer< SocketAcceptorT, SocketContextFactoryT, Args >::onConnect.

setOnConnected()

template<typename SocketAcceptorT , typename SocketContextFactoryT , typename... Args>

std::function< void(SocketConnection *)> core::socket::stream::SocketServer< SocketAcceptorT, SocketContextFactoryT, Args >::setOnConnected ( const std::function< void(SocketConnection *)> &  onConnected )

inline

Definition at line 221 of file SocketServer.h.

                                                                                                                     {
            std::function<void(SocketConnection*)> oldOnConnected = this->onConnected;
 
            this->onConnected = onConnected;
 
            return oldOnConnected;
        }

References core::socket::stream::SocketServer< SocketAcceptorT, SocketContextFactoryT, Args >::onConnected.

setOnDisconnect()

template<typename SocketAcceptorT , typename SocketContextFactoryT , typename... Args>

std::function< void(SocketConnection *)> core::socket::stream::SocketServer< SocketAcceptorT, SocketContextFactoryT, Args >::setOnDisconnect ( const std::function< void(SocketConnection *)> &  onDisconnect )

inline

Definition at line 229 of file SocketServer.h.

                                                                                                                       {
            std::function<void(SocketConnection*)> oldOnDisconnect = this->onDisconnect;
 
            this->onDisconnect = onDisconnect;
 
            return oldOnDisconnect;
        }

References core::socket::stream::SocketServer< SocketAcceptorT, SocketContextFactoryT, Args >::onDisconnect.

Member Data Documentation

currentError

template<typename SocketAcceptorT , typename SocketContextFactoryT , typename... Args>

std::size_t core::socket::stream::SocketServer< SocketAcceptorT, SocketContextFactoryT, Args >::currentError = 0

private

Definition at line 250 of file SocketServer.h.

currentFatal

template<typename SocketAcceptorT , typename SocketContextFactoryT , typename... Args>

std::size_t core::socket::stream::SocketServer< SocketAcceptorT, SocketContextFactoryT, Args >::currentFatal = 0

private

Definition at line 251 of file SocketServer.h.

currentOk

template<typename SocketAcceptorT , typename SocketContextFactoryT , typename... Args>

std::size_t core::socket::stream::SocketServer< SocketAcceptorT, SocketContextFactoryT, Args >::currentOk = 0

private

Definition at line 249 of file SocketServer.h.

onConnect

template<typename SocketAcceptorT , typename SocketContextFactoryT , typename... Args>

std::function<void(SocketConnection*)> core::socket::stream::SocketServer< SocketAcceptorT, SocketContextFactoryT, Args >::onConnect

private

Definition at line 244 of file SocketServer.h.

Referenced by core::socket::stream::SocketServer< SocketAcceptorT, SocketContextFactoryT, Args >::realListen(), core::socket::stream::SocketServer< SocketAcceptorT, SocketContextFactoryT, Args >::setOnConnect(), and core::socket::stream::SocketServer< SocketAcceptorT, SocketContextFactoryT, Args >::SocketServer().

onConnected

template<typename SocketAcceptorT , typename SocketContextFactoryT , typename... Args>

std::function<void(SocketConnection*)> core::socket::stream::SocketServer< SocketAcceptorT, SocketContextFactoryT, Args >::onConnected

private

Definition at line 245 of file SocketServer.h.

Referenced by core::socket::stream::SocketServer< SocketAcceptorT, SocketContextFactoryT, Args >::realListen(), core::socket::stream::SocketServer< SocketAcceptorT, SocketContextFactoryT, Args >::setOnConnected(), and core::socket::stream::SocketServer< SocketAcceptorT, SocketContextFactoryT, Args >::SocketServer().

onDisconnect

template<typename SocketAcceptorT , typename SocketContextFactoryT , typename... Args>

std::function<void(SocketConnection*)> core::socket::stream::SocketServer< SocketAcceptorT, SocketContextFactoryT, Args >::onDisconnect

private

Definition at line 246 of file SocketServer.h.

Referenced by core::socket::stream::SocketServer< SocketAcceptorT, SocketContextFactoryT, Args >::realListen(), core::socket::stream::SocketServer< SocketAcceptorT, SocketContextFactoryT, Args >::setOnDisconnect(), and core::socket::stream::SocketServer< SocketAcceptorT, SocketContextFactoryT, Args >::SocketServer().

socketContextFactory

template<typename SocketAcceptorT , typename SocketContextFactoryT , typename... Args>

std::shared_ptr<SocketContextFactory> core::socket::stream::SocketServer< SocketAcceptorT, SocketContextFactoryT, Args >::socketContextFactory

private

Definition at line 242 of file SocketServer.h.

Referenced by core::socket::stream::SocketServer< SocketAcceptorT, SocketContextFactoryT, Args >::getSocketContextFactory(), core::socket::stream::SocketServer< SocketAcceptorT, SocketContextFactoryT, Args >::realListen(), and core::socket::stream::SocketServer< SocketAcceptorT, SocketContextFactoryT, Args >::SocketServer().

totalOk

template<typename SocketAcceptorT , typename SocketContextFactoryT , typename... Args>

std::size_t core::socket::stream::SocketServer< SocketAcceptorT, SocketContextFactoryT, Args >::totalOk = 0

private

Definition at line 248 of file SocketServer.h.

---

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

• core/socket/stream/SocketServer.h