#include <SocketClient.h>

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

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

Classes
struct	Context

Public Types
using	SocketConnection = typename SocketConnector::SocketConnection
using	SocketAddress = typename SocketConnector::SocketAddress
using	Config = typename SocketConnector::Config
Public Types inherited from core::socket::Socket< SocketConnectorT::Config >
using	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)
const SocketClient &	connect (const std::function< void(const SocketAddress &, core::socket::State)> &onStatus) const
const SocketClient &	connect (const SocketAddress &remoteAddress, const std::function< void(const SocketAddress &, core::socket::State)> &onStatus) const
const SocketClient &	connect (const SocketAddress &remoteAddress, const SocketAddress &localAddress, const std::function< void(const SocketAddress &, core::socket::State)> &onStatus) const
std::function< void(SocketConnection *)> &	getOnConnect ()
const SocketClient &	setOnConnect (const std::function< void(SocketConnection *)> &onConnect, bool initialize=false) const
std::function< void(SocketConnection *)> &	getOnConnected () const
const SocketClient &	setOnConnected (const std::function< void(SocketConnection *)> &onConnected, bool initialize=false) const
std::function< void(SocketConnection *)> &	getOnDisconnect () const
const SocketClient &	setOnDisconnect (const std::function< void(SocketConnection *)> &onDisconnect, bool initialize=false) const
ClientFlowController *	getFlowController () const
std::shared_ptr< SocketContextFactory >	getSocketContextFactory () const
Public Member Functions inherited from core::socket::Socket< SocketConnectorT::Config >
	Socket (const std::string &name)
virtual	~Socket ()
Config *	getConfig () const

Private Types
using	SocketConnector = SocketConnectorT
using	SocketContextFactory = SocketContextFactoryT
using	Super = core::socket::Socket<typename SocketConnector::Config>

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

Private Attributes
std::shared_ptr< Context >	sharedContext

Additional Inherited Members
Protected Member Functions inherited from core::socket::Socket< SocketConnectorT::Config >
Socket &	operator= (const Socket &)=default
Protected Attributes inherited from core::socket::Socket< SocketConnectorT::Config >
const 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

◆ Config

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

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

Definition at line 83 of file SocketClient.h.

◆ 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/5]

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

core::socket::stream::SocketClient< SocketConnectorT, SocketContextFactoryT, Args >::SocketClient	(	const std::shared_ptr< Config > &	config,
		const std::shared_ptr< Context > &	sharedContext )

inlineprivate

Definition at line 108 of file SocketClient.h.

            : Super(config)
            , sharedContext(sharedContext) {
        }

◆ SocketClient() [2/5]

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 114 of file SocketClient.h.

            : Super(name)
            , sharedContext(std::make_shared<Context>(
                  this->config.get(),
                  std::make_shared<SocketContextFactory>(std::forward<Args>(args)...),
                  [onConnect](SocketConnection* socketConnection) { // onConnect
                      LOG(DEBUG) << socketConnection->getConnectionName() << ": OnConnect";
 
                      LOG(DEBUG) << "  Local: " << socketConnection->getLocalAddress().toString();
                      LOG(DEBUG) << "   Peer: " << socketConnection->getRemoteAddress().toString();
 
                      if (onConnect) {
                          onConnect(socketConnection);
                      }
                  },
                  [onConnected](SocketConnection* socketConnection) { // onConnected
                      LOG(DEBUG) << socketConnection->getConnectionName() << ": OnConnected";
 
                      LOG(DEBUG) << "  Local: " << socketConnection->getLocalAddress().toString();
                      LOG(DEBUG) << "   Peer: " << socketConnection->getRemoteAddress().toString();
 
                      if (onConnected) {
                          onConnected(socketConnection);
                      }
                  },
                  [onDisconnect](SocketConnection* socketConnection) { // onDisconnect
                      LOG(DEBUG) << socketConnection->getConnectionName() << ": OnDisconnect";
 
                      LOG(DEBUG) << "            Local: " << socketConnection->getLocalAddress().toString();
                      LOG(DEBUG) << "             Peer: " << socketConnection->getRemoteAddress().toString();
 
                      LOG(DEBUG) << "     Online Since: " << socketConnection->getOnlineSince();
                      LOG(DEBUG) << "  Online Duration: " << socketConnection->getOnlineDuration();
 
                      LOG(DEBUG) << "     Total Queued: " << socketConnection->getTotalQueued();
                      LOG(DEBUG) << "       Total Sent: " << socketConnection->getTotalSent();
                      LOG(DEBUG) << "      Write Delta: " << socketConnection->getTotalQueued() - socketConnection->getTotalSent();
                      LOG(DEBUG) << "       Total Read: " << socketConnection->getTotalRead();
                      LOG(DEBUG) << "  Total Processed: " << socketConnection->getTotalProcessed();
                      LOG(DEBUG) << "       Read Delta: " << socketConnection->getTotalRead() - socketConnection->getTotalProcessed();
 
                      if (onDisconnect) {
                          onDisconnect(socketConnection);
                      }
                  })) {
        }

◆ SocketClient() [3/5]

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 165 of file SocketClient.h.

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

170 }

core::socket::stream::SocketClient::SocketClient

SocketClient(const std::shared_ptr< Config > &config, const std::shared_ptr< Context > &sharedContext)

Definition SocketClient.h:108

◆ SocketClient() [4/5]

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 172 of file SocketClient.h.

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

174 }

◆ SocketClient() [5/5]

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

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

inlineexplicit

Definition at line 176 of file SocketClient.h.

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

178 }

Member Function Documentation

◆ connect() [1/3]

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

const SocketClient & 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 286 of file SocketClient.h.

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

◆ connect() [2/3]

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

const SocketClient & 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 279 of file SocketClient.h.

                                                                                                                    {
            Super::config->Remote::setSocketAddress(remoteAddress);
 
            return 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>

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

inline

Definition at line 275 of file SocketClient.h.

                                                                                                                    {
            return realConnect(onStatus, 0, 1);
        }

Referenced by main().

Here is the caller graph for this function:

◆ getFlowController()

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

ClientFlowController * core::socket::stream::SocketClient< SocketConnectorT, SocketContextFactoryT, Args >::getFlowController ( ) const

inline

Definition at line 337 of file SocketClient.h.

                                                        {
            return &sharedContext->flowController;
        }

◆ getOnConnect()

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

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

inline

Definition at line 294 of file SocketClient.h.

                                                             {
            return sharedContext->onConnect;
        }

◆ getOnConnected()

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

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

inline

Definition at line 308 of file SocketClient.h.

                                                                     {
            return sharedContext->onConnected;
        }

◆ getOnDisconnect()

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

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

inline

Definition at line 322 of file SocketClient.h.

                                                                      {
            return sharedContext->onDisconnect;
        }

◆ 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 341 of file SocketClient.h.

                                                                            {
            return sharedContext->socketContextFactory;
        }

◆ realConnect()

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

const SocketClient & 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 181 of file SocketClient.h.

                                                                        {
            sharedContext->flowController.startFlow(
                [config = this->config, sharedContext = this->sharedContext, onStatus, tries, retryTimeoutScale] {
                    if (config->Instance::getParent() != nullptr || !config->Instance::getRequired()) {
                        LOG(DEBUG) << config->getInstanceName() << ": Initiating connect";
 
                        if (core::SNodeC::state() == core::State::RUNNING || core::SNodeC::state() == core::State::INITIALIZED) {
                            new SocketConnector(
                                sharedContext->socketContextFactory,
                                sharedContext->onConnect,
                                sharedContext->onConnected,
                                [config, sharedContext, onStatus](SocketConnection* socketConnection) {
                                    sharedContext->onDisconnect(socketConnection);
 
                                    if (config->getReconnect() && sharedContext->flowController.isReconnectEnabled() &&
                                        core::eventLoopState() == core::State::RUNNING) {
                                        double relativeReconnectTimeout = config->getReconnectTime();
 
                                        LOG(INFO)
                                            << config->getInstanceName() << ": Reconnect in " << relativeReconnectTimeout << " seconds";
 
                                        sharedContext->flowController.armReconnectTimer(
                                            relativeReconnectTimeout, [config, sharedContext, /*generation,*/ onStatus]() {
                                                if (!sharedContext->flowController.isReconnectEnabled()) {
                                                    return;
                                                }
                                                if (config->getReconnect()) {
                                                    sharedContext->flowController.reportFlowReconnect();
                                                    SocketClient(config, sharedContext).realConnect(onStatus, 0, config->getRetryBase());
                                                } else {
                                                    LOG(INFO) << config->getInstanceName() << ": Reconnect disabled during wait";
                                                }
                                            });
                                    }
                                },
                                [sharedContext](core::eventreceiver::ConnectEventReceiver* connectEventReceiver) {
                                    sharedContext->flowController.observeConnectEventReceiver(connectEventReceiver);
                                },
                                [config, sharedContext, onStatus, tries, retryTimeoutScale](const SocketAddress& socketAddress,
                                                                                            core::socket::State state) {
                                    const bool retryFlag = (state & core::socket::State::NO_RETRY) == 0;
                                    state &= ~core::socket::State::NO_RETRY;
                                    onStatus(socketAddress, state);
 
                                    if (retryFlag && config->getRetry() // Shall we potentially retry? In case are the ...
                                        && sharedContext->flowController.isRetryEnabled() &&
                                        (config->getRetryTries() == 0 ||
                                         tries < config->getRetryTries()) // ... limits not reached and has an ...
                                        && (state == core::socket::State::ERROR ||
                                            (state == core::socket::State::FATAL && config->getRetryOnFatal()))) { // error occurred?
                                        double relativeRetryTimeout =
                                            config->getRetryLimit() > 0
                                                ? std::min<double>(config->getRetryTimeout() * retryTimeoutScale, config->getRetryLimit())
                                                : config->getRetryTimeout() * retryTimeoutScale;
                                        relativeRetryTimeout -=
                                            utils::Random::getInRange(-config->getRetryJitter(), config->getRetryJitter()) *
                                            relativeRetryTimeout / 100.;
 
                                        LOG(INFO)
                                            << config->getInstanceName() << ": Retry connect in " << relativeRetryTimeout << " seconds";
 
                                        sharedContext->flowController.armRetryTimer(
                                            relativeRetryTimeout,
                                            [config,
                                             sharedContext,
                                             /*generation,*/ onStatus,
                                             tries,
                                             retryTimeoutScale]() {
                                                if (!sharedContext->flowController.isRetryEnabled()) {
                                                    return;
                                                }
                                                if (config->getRetry()) {
                                                    sharedContext->flowController.reportFlowRetry();
                                                    SocketClient(config, sharedContext)
                                                        .realConnect(onStatus, tries + 1, retryTimeoutScale * config->getRetryBase());
                                                } else {
                                                    LOG(INFO) << config->getInstanceName() << ": Retry connect disabled during wait";
                                                }
                                            });
                                    }
                                },
                                config);
                        }
                    } else {
                        LOG(FATAL) << config->getInstanceName() << " required";
                    }
                });
 
            return *this;
        }

Referenced by core::socket::stream::SocketClient< SocketConnectorT< net::in6::phy::stream::PhysicalSocketClient, ConfigSocketClientT >, SocketContextFactoryT, Args... >::connect(), and core::socket::stream::SocketClient< SocketConnectorT< net::in6::phy::stream::PhysicalSocketClient, ConfigSocketClientT >, SocketContextFactoryT, Args... >::realConnect().

Here is the caller graph for this function:

◆ setOnConnect()

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

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

inline

Definition at line 298 of file SocketClient.h.

                                                                                                                               {
            sharedContext->onConnect =
                initialize ? onConnect : [oldOnConnect = sharedContext->onConnect, onConnect](SocketConnection* socketConnection) {
                    oldOnConnect(socketConnection);
                    onConnect(socketConnection);
                };
 
            return *this;
        }

◆ setOnConnected()

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

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

inline

Definition at line 312 of file SocketClient.h.

                                                                                                                                   {
            sharedContext->onConnected =
                initialize ? onConnected : [oldOnConnected = sharedContext->onConnected, onConnected](SocketConnection* socketConnection) {
                    oldOnConnected(socketConnection);
                    onConnected(socketConnection);
                };
 
            return *this;
        }

◆ setOnDisconnect()

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

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

inline

Definition at line 326 of file SocketClient.h.

                                                                                                                                     {
            sharedContext->onDisconnect =
                initialize ? onDisconnect
                           : [oldOnDisconnect = sharedContext->onDisconnect, onDisconnect](SocketConnection* socketConnection) {
                                 oldOnDisconnect(socketConnection);
                                 onDisconnect(socketConnection);
                             };
 
            return *this;
        }

Member Data Documentation

◆ sharedContext

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

std::shared_ptr<Context> core::socket::stream::SocketClient< SocketConnectorT, SocketContextFactoryT, Args >::sharedContext

private

Definition at line 346 of file SocketClient.h.

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

core/socket/stream/SocketClient.h

SNode.C

Classes

Public Types

Public Member Functions

Private Types

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Config

◆ SocketAddress

◆ SocketConnection

◆ SocketConnector

◆ SocketContextFactory

◆ Super

Constructor & Destructor Documentation

◆ SocketClient() [1/5]

◆ SocketClient() [2/5]

◆ SocketClient() [3/5]

◆ SocketClient() [4/5]

◆ SocketClient() [5/5]

Member Function Documentation

◆ connect() [1/3]

◆ connect() [2/3]

◆ connect() [3/3]

◆ getFlowController()

◆ getOnConnect()

◆ getOnConnected()

◆ getOnDisconnect()

◆ getSocketContextFactory()

◆ realConnect()

◆ setOnConnect()

◆ setOnConnected()

◆ setOnDisconnect()

Member Data Documentation

◆ sharedContext