#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

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::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 48 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 57 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 56 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 50 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 51 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 53 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 59 of file SocketClient.h.

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

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

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

76 }

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

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)

Definition SocketClient.h:59

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

            : SocketClient(
                  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)...) {
        }

◆ SocketClient() [4/4]

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

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

inlineexplicit

Definition at line 103 of file SocketClient.h.

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

105 }

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

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

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

                                                                                                     {
            realConnect(onStatus, 0, 1);
        }

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

                                                                            {
            return 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 108 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) {
                        bool retry = (state & core::socket::State::NO_RETRY) == 0 &&
                                     (client.getConfig().getRetryTries() == 0 || tries < client.getConfig().getRetryTries());
                        state &= ~core::socket::State::NO_RETRY;
 
                        onStatus(socketAddress, state);
 
                        switch (state) {
                            case core::socket::State::OK:
                                [[fallthrough]];
                            case core::socket::State::DISABLED:
                                retry = false;
                                break;
                            case core::socket::State::ERROR:
                                retry = retry && client.getConfig().getRetry();
                                break;
                            case core::socket::State::FATAL:
                                retry = retry && client.getConfig().getRetry() && client.getConfig().getRetryOnFatal();
                                break;
                        }
 
                        if (retry) {
                            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);
            }
        }

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

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

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

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

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

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

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

◆ onConnected

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

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

private

Definition at line 234 of file SocketClient.h.

◆ onDisconnect

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

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

private

Definition at line 235 of file SocketClient.h.

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

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

core/socket/stream/SocketClient.h

Public Types

Public Member Functions

Private Types

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ SocketAddress

◆ SocketConnection

◆ SocketConnector

◆ SocketContextFactory

◆ Super

Constructor & Destructor Documentation

◆ SocketClient() [1/4]

◆ SocketClient() [2/4]

◆ SocketClient() [3/4]

◆ SocketClient() [4/4]

Member Function Documentation

◆ connect() [1/3]

◆ connect() [2/3]

◆ connect() [3/3]

◆ getSocketContextFactory()

◆ realConnect()

◆ setOnConnect()

◆ setOnConnected()

◆ setOnDisconnect()

Member Data Documentation

◆ onConnect

◆ onConnected

◆ onDisconnect

◆ socketContextFactory