core::socket::stream::SocketClient< SocketConnectorT, SocketContextFactoryT, Args > Class Template Reference

#include <SocketClient.h>

Inheritance diagram for core::socket::stream::SocketClient< SocketConnectorT, SocketContextFactoryT, Args >:

Collaboration diagram for core::socket::stream::SocketClient< SocketConnectorT, SocketContextFactoryT, Args >:

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

Public Member Functions
	SocketClient (const std::string &name, const std::function< void(SocketConnection *)> &onConnect, const std::function< void(SocketConnection *)> &onConnected, const std::function< void(SocketConnection *)> &onDisconnect, Args &&... args)
	SocketClient (const std::function< void(SocketConnection *)> &onConnect, const std::function< void(SocketConnection *)> &onConnected, const std::function< void(SocketConnection *)> &onDisconnect, Args &&... args)
	SocketClient (const std::string &name, Args &&... args)
	SocketClient (Args &&... args)
void	connect (const std::function< void(const SocketAddress &, core::socket::State)> &onStatus) const
void	connect (const SocketAddress &remoteAddress, const std::function< void(const SocketAddress &, core::socket::State)> &onStatus) const
void	connect (const SocketAddress &remoteAddress, const SocketAddress &localAddress, 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 () const
Public Member Functions inherited from core::socket::Socket< SocketConnectorT::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	SocketConnector = SocketConnectorT
using	SocketContextFactory = SocketContextFactoryT
using	Super = core::socket::Socket< typename SocketConnector::Config >

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

Private Attributes
const std::shared_ptr< SocketContextFactory >	socketContextFactory
std::function< void(SocketConnection *)>	onConnect
std::function< void(SocketConnection *)>	onConnected
std::function< void(SocketConnection *)>	onDisconnect

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

Detailed Description

template<typename SocketConnectorT, typename SocketContextFactoryT, typename... Args>
requires std::is_base_of_v<core::eventreceiver::ConnectEventReceiver, SocketConnectorT> && std::is_base_of_v<core::socket::stream::SocketContextFactory, SocketContextFactoryT>
class core::socket::stream::SocketClient< SocketConnectorT, SocketContextFactoryT, Args >

Sequence diagram showing how a connect to a peer is performed.

Definition at line 73 of file SocketClient.h.

Member Typedef Documentation

SocketAddress

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

using core::socket::stream::SocketClient< SocketConnectorT, SocketContextFactoryT, Args >::SocketAddress = typename SocketConnector::SocketAddress

Definition at line 82 of file SocketClient.h.

SocketConnection

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

using core::socket::stream::SocketClient< SocketConnectorT, SocketContextFactoryT, Args >::SocketConnection = typename SocketConnector::SocketConnection

Definition at line 81 of file SocketClient.h.

SocketConnector

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

using core::socket::stream::SocketClient< SocketConnectorT, SocketContextFactoryT, Args >::SocketConnector = SocketConnectorT

private

Definition at line 75 of file SocketClient.h.

SocketContextFactory

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

using core::socket::stream::SocketClient< SocketConnectorT, SocketContextFactoryT, Args >::SocketContextFactory = SocketContextFactoryT

private

Definition at line 76 of file SocketClient.h.

Super

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

using core::socket::stream::SocketClient< SocketConnectorT, SocketContextFactoryT, Args >::Super = core::socket::Socket<typename SocketConnector::Config>

private

Definition at line 78 of file SocketClient.h.

Constructor & Destructor Documentation

SocketClient() [1/4]

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

core::socket::stream::SocketClient< SocketConnectorT, SocketContextFactoryT, Args >::SocketClient ( 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 84 of file SocketClient.h.

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

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

SocketClient() [2/4]

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

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

inline

Definition at line 96 of file SocketClient.h.

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

SocketClient() [3/4]

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

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

inline

Definition at line 104 of file SocketClient.h.

            : SocketClient(
                  name,
                  [](SocketConnection* socketConnection) { // onConnect
                      VLOG(2) << socketConnection->getConnectionName() << ": OnConnect";
 
                      VLOG(2) << "  Local: " << socketConnection->getLocalAddress().toString();
                      VLOG(2) << "   Peer: " << socketConnection->getRemoteAddress().toString();
                  },
                  [](SocketConnection* socketConnection) { // onConnected
                      VLOG(2) << socketConnection->getConnectionName() << ": OnConnected";
 
                      VLOG(2) << "  Local: " << socketConnection->getLocalAddress().toString();
                      VLOG(2) << "   Peer: " << socketConnection->getRemoteAddress().toString();
                  },
                  [](SocketConnection* socketConnection) { // onDisconnect
                      VLOG(2) << socketConnection->getConnectionName() << ": OnDisconnect";
 
                      VLOG(2) << "            Local: " << socketConnection->getLocalAddress().toString();
                      VLOG(2) << "             Peer: " << socketConnection->getRemoteAddress().toString();
 
                      VLOG(2) << "     Online Since: " << socketConnection->getOnlineSince();
                      VLOG(2) << "  Online Duration: " << socketConnection->getOnlineDuration();
 
                      VLOG(2) << "     Total Queued: " << socketConnection->getTotalQueued();
                      VLOG(2) << "       Total Sent: " << socketConnection->getTotalSent();
                      VLOG(2) << "      Write Delta: " << socketConnection->getTotalQueued() - socketConnection->getTotalSent();
                      VLOG(2) << "       Total Read: " << socketConnection->getTotalRead();
                      VLOG(2) << "  Total Processed: " << socketConnection->getTotalProcessed();
                      VLOG(2) << "       Read Delta: " << socketConnection->getTotalRead() - socketConnection->getTotalProcessed();
 
                  },
                  std::forward<Args>(args)...) {
        }

SocketClient() [4/4]

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

core::socket::stream::SocketClient< SocketConnectorT, SocketContextFactoryT, Args >::SocketClient ( Args &&...  args )

inlineexplicit

Definition at line 139 of file SocketClient.h.

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

Member Function Documentation

connect() [1/3]

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

void core::socket::stream::SocketClient< SocketConnectorT, SocketContextFactoryT, Args >::connect ( const SocketAddress &  remoteAddress, const SocketAddress &  localAddress, const std::function< void(const SocketAddress &, core::socket::State)> &  onStatus  ) const

inline

Definition at line 219 of file SocketClient.h.

                                                                                                     {
            Super::config->Local::setSocketAddress(localAddress);
 
            connect(remoteAddress, onStatus);
        }

connect() [2/3]

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

void core::socket::stream::SocketClient< SocketConnectorT, SocketContextFactoryT, Args >::connect ( const SocketAddress &  remoteAddress, const std::function< void(const SocketAddress &, core::socket::State)> &  onStatus  ) const

inline

Definition at line 212 of file SocketClient.h.

                                                                                                     {
            Super::config->Remote::setSocketAddress(remoteAddress);
 
            connect(onStatus);
        }

Referenced by tls::getClient(), legacy::getLegacyClient(), and main().

Here is the caller graph for this function:

connect() [3/3]

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

void core::socket::stream::SocketClient< SocketConnectorT, SocketContextFactoryT, Args >::connect ( const std::function< void(const SocketAddress &, core::socket::State)> &  onStatus ) const

inline

Definition at line 208 of file SocketClient.h.

                                                                                                     {
            realConnect(onStatus, 0, 1);
        }

References core::socket::stream::SocketClient< SocketConnectorT, SocketContextFactoryT, Args >::realConnect().

Referenced by main().

Here is the call graph for this function:

Here is the caller graph for this function:

getSocketContextFactory()

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

std::shared_ptr< SocketContextFactory > core::socket::stream::SocketClient< SocketConnectorT, SocketContextFactoryT, Args >::getSocketContextFactory ( ) const

inline

Definition at line 251 of file SocketClient.h.

                                                                            {
            return socketContextFactory;
        }

References core::socket::stream::SocketClient< SocketConnectorT, SocketContextFactoryT, Args >::socketContextFactory.

realConnect()

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

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

inlineprivate

Definition at line 144 of file SocketClient.h.

                                                         {
            if (core::SNodeC::state() == core::State::RUNNING || core::SNodeC::state() == core::State::INITIALIZED) {
                new SocketConnector(
                    socketContextFactory,
                    onConnect,
                    onConnected,
                    [client = *this, onStatus](SocketConnection* socketConnection) {
                        client.onDisconnect(socketConnection);
 
                        if (client.getConfig().getReconnect() && core::eventLoopState() == core::State::RUNNING) {
                            double relativeReconnectTimeout = client.getConfig().getReconnectTime();
 
                            LOG(INFO) << client.getConfig().getInstanceName() << ": OnStatus";
                            LOG(INFO) << "  reconnecting in " << relativeReconnectTimeout << " seconds";
 
                            core::timer::Timer::singleshotTimer(
                                [client, onStatus]() {
                                    client.getConfig().Local::renew();
                                    client.getConfig().Remote::renew();
 
                                    client.realConnect(onStatus, 0, 1);
                                },
                                relativeReconnectTimeout);
                        }
                    },
                    [client = *this, onStatus, tries, retryTimeoutScale](const SocketAddress& socketAddress,
                                                                         core::socket::State state) mutable {
                        const bool retryFlag = (state & core::socket::State::NO_RETRY) == 0;
                        state &= ~core::socket::State::NO_RETRY;
                        onStatus(socketAddress, state);
 
                        if (retryFlag && client.getConfig().getRetry() // Shall we potentially retry? In case are the ...
                            && (client.getConfig().getRetryTries() == 0 ||
                                tries < client.getConfig().getRetryTries()) // ... limits not reached and has an ...
                            && (state == core::socket::State::ERROR ||
                                (state == core::socket::State::FATAL && client.getConfig().getRetryOnFatal()))) { // error occurred?
                            double relativeRetryTimeout = client.getConfig().getRetryLimit() > 0
                                                              ? std::min<double>(client.getConfig().getRetryTimeout() * retryTimeoutScale,
                                                                                 client.getConfig().getRetryLimit())
                                                              : client.getConfig().getRetryTimeout() * retryTimeoutScale;
                            relativeRetryTimeout -=
                                utils::Random::getInRange(-client.getConfig().getRetryJitter(), client.getConfig().getRetryJitter()) *
                                relativeRetryTimeout / 100.;
 
                            LOG(INFO) << client.getConfig().getInstanceName() << ": OnStatus";
                            LOG(INFO) << "  retrying in " << relativeRetryTimeout << " seconds";
 
                            core::timer::Timer::singleshotTimer(
                                [client, onStatus, tries, retryTimeoutScale]() mutable {
                                    client.getConfig().Local::renew();
                                    client.getConfig().Remote::renew();
 
                                    client.realConnect(onStatus, tries + 1, retryTimeoutScale * client.getConfig().getRetryBase());
                                },
                                relativeRetryTimeout);
                        }
                    },
                    Super::config);
            }
        }

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

Referenced by core::socket::stream::SocketClient< SocketConnectorT, SocketContextFactoryT, Args >::connect().

Here is the call graph for this function:

Here is the caller graph for this function:

setOnConnect()

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

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

inline

Definition at line 227 of file SocketClient.h.

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

References core::socket::stream::SocketClient< SocketConnectorT, SocketContextFactoryT, Args >::onConnect.

setOnConnected()

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

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

inline

Definition at line 235 of file SocketClient.h.

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

References core::socket::stream::SocketClient< SocketConnectorT, SocketContextFactoryT, Args >::onConnected.

setOnDisconnect()

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

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

inline

Definition at line 243 of file SocketClient.h.

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

References core::socket::stream::SocketClient< SocketConnectorT, SocketContextFactoryT, Args >::onDisconnect.

Member Data Documentation

onConnect

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

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

private

Definition at line 258 of file SocketClient.h.

Referenced by core::socket::stream::SocketClient< SocketConnectorT, SocketContextFactoryT, Args >::realConnect(), core::socket::stream::SocketClient< SocketConnectorT, SocketContextFactoryT, Args >::setOnConnect(), and core::socket::stream::SocketClient< SocketConnectorT, SocketContextFactoryT, Args >::SocketClient().

onConnected

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

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

private

Definition at line 259 of file SocketClient.h.

Referenced by core::socket::stream::SocketClient< SocketConnectorT, SocketContextFactoryT, Args >::realConnect(), core::socket::stream::SocketClient< SocketConnectorT, SocketContextFactoryT, Args >::setOnConnected(), and core::socket::stream::SocketClient< SocketConnectorT, SocketContextFactoryT, Args >::SocketClient().

onDisconnect

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

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

private

Definition at line 260 of file SocketClient.h.

Referenced by core::socket::stream::SocketClient< SocketConnectorT, SocketContextFactoryT, Args >::setOnDisconnect(), and core::socket::stream::SocketClient< SocketConnectorT, SocketContextFactoryT, Args >::SocketClient().

socketContextFactory

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

const std::shared_ptr<SocketContextFactory> core::socket::stream::SocketClient< SocketConnectorT, SocketContextFactoryT, Args >::socketContextFactory

private

Definition at line 256 of file SocketClient.h.

Referenced by core::socket::stream::SocketClient< SocketConnectorT, SocketContextFactoryT, Args >::getSocketContextFactory(), core::socket::stream::SocketClient< SocketConnectorT, SocketContextFactoryT, Args >::realConnect(), and core::socket::stream::SocketClient< SocketConnectorT, SocketContextFactoryT, Args >::SocketClient().

---

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

• core/socket/stream/SocketClient.h