#include <SocketConnector.h>

Inheritance diagram for core::socket::stream::SocketConnector< PhysicalSocketClientT, ConfigT, SocketConnectionT >:

Collaboration diagram for core::socket::stream::SocketConnector< PhysicalSocketClientT, ConfigT, SocketConnectionT >:

Public Member Functions
	SocketConnector (const std::function< void(SocketConnection )> &onConnect, const std::function< void(SocketConnection )> &onConnected, const std::function< void(SocketConnection )> &onDisconnect, const std::function< void(core::eventreceiver::ConnectEventReceiver )> &onInitState, const std::function< void(const SocketAddress &, core::socket::State)> &onStatus, const std::shared_ptr< Config > &config)
	SocketConnector (const SocketConnector &socketConnector)
	~SocketConnector () override
virtual void	init ()

Protected Types
using	Config = ConfigT
using	SocketAddress = typename PhysicalClientSocket::SocketAddress
using	SocketConnection = SocketConnectionT<PhysicalClientSocket, Config>

Protected Member Functions
virtual void	useNextSocketAddress ()=0
void	destruct () final
Protected Member Functions inherited from core::eventreceiver::ConnectEventReceiver
	ConnectEventReceiver (const std::string &name, const utils::Timeval &timeout)
void	stopConnect ()
Protected Member Functions inherited from core::DescriptorEventReceiver
	DescriptorEventReceiver (const std::string &name, DescriptorEventPublisher &descriptorEventPublisher, const utils::Timeval &timeout=TIMEOUT::DISABLE)
bool	enable (int fd)
void	disable ()
void	suspend ()
void	resume ()
void	setTimeout (const utils::Timeval &timeout)
utils::Timeval	getTimeout (const utils::Timeval &currentTime) const
void	checkTimeout (const utils::Timeval &currentTime)
int	getRegisteredFd () const
bool	isEnabled () const
bool	isSuspended () const
Protected Member Functions inherited from core::Observer
void	observed ()
void	unObserved ()
	Observer ()=default
	Observer (Observer &)=delete
	Observer (Observer &&)=delete
virtual	~Observer ()
Protected Member Functions inherited from core::EventReceiver
virtual	~EventReceiver ()=default
	EventReceiver (const std::string &name)
	EventReceiver (EventReceiver &)=delete
	EventReceiver (EventReceiver &&)=delete
EventReceiver &	operator= (EventReceiver &)=delete
EventReceiver &	operator= (EventReceiver &&)=delete
void	span ()
void	relax ()
const std::string &	getName () const

Protected Attributes
std::function< void(SocketConnection *)>	onConnect
std::function< void(SocketConnection *)>	onConnected
std::function< void(SocketConnection *)>	onDisconnect
std::function< void(core::eventreceiver::ConnectEventReceiver *)>	onInitState
std::function< void(const SocketAddress &, core::socket::State)>	onStatus
std::shared_ptr< Config >	config = nullptr

Private Types
using	PhysicalClientSocket = PhysicalSocketClientT

Private Member Functions
void	connectEvent () final
void	unobservedEvent () final
void	connectTimeout () final

Private Attributes
PhysicalClientSocket	physicalClientSocket
SocketAddress	remoteAddress

Detailed Description

template<typename PhysicalSocketClientT, typename ConfigT, template< typename PhysicalSocketClient, typename Config > typename SocketConnectionT>
class core::socket::stream::SocketConnector< PhysicalSocketClientT, ConfigT, SocketConnectionT >

Definition at line 64 of file SocketConnector.h.

Member Typedef Documentation

◆ Config

template<typename PhysicalSocketClientT, typename ConfigT, template< typename PhysicalSocketClient, typename Config > typename SocketConnectionT>

using core::socket::stream::SocketConnector< PhysicalSocketClientT, ConfigT, SocketConnectionT >::Config = ConfigT

protected

Definition at line 69 of file SocketConnector.h.

◆ PhysicalClientSocket

template<typename PhysicalSocketClientT, typename ConfigT, template< typename PhysicalSocketClient, typename Config > typename SocketConnectionT>

using core::socket::stream::SocketConnector< PhysicalSocketClientT, ConfigT, SocketConnectionT >::PhysicalClientSocket = PhysicalSocketClientT

private

Definition at line 66 of file SocketConnector.h.

◆ SocketAddress

template<typename PhysicalSocketClientT, typename ConfigT, template< typename PhysicalSocketClient, typename Config > typename SocketConnectionT>

using core::socket::stream::SocketConnector< PhysicalSocketClientT, ConfigT, SocketConnectionT >::SocketAddress = typename PhysicalClientSocket::SocketAddress

protected

Definition at line 70 of file SocketConnector.h.

◆ SocketConnection

template<typename PhysicalSocketClientT, typename ConfigT, template< typename PhysicalSocketClient, typename Config > typename SocketConnectionT>

using core::socket::stream::SocketConnector< PhysicalSocketClientT, ConfigT, SocketConnectionT >::SocketConnection = SocketConnectionT<PhysicalClientSocket, Config>

protected

Definition at line 71 of file SocketConnector.h.

Constructor & Destructor Documentation

◆ SocketConnector() [1/2]

template<typename PhysicalSocketClient, typename Config, template< typename ConfigT, typename PhysicalSocketClientT > typename SocketConnection>

core::socket::stream::SocketConnector< PhysicalSocketClient, Config, SocketConnection >::SocketConnector	(	const std::function< void(SocketConnection *)> &	onConnect,
		const std::function< void(SocketConnection *)> &	onConnected,
		const std::function< void(SocketConnection *)> &	onDisconnect,
		const std::function< void(core::eventreceiver::ConnectEventReceiver *)> &	onInitState,
		const std::function< void(const SocketAddress &, core::socket::State)> &	onStatus,
		const std::shared_ptr< Config > &	config )

Definition at line 61 of file SocketConnector.hpp.

        : core::eventreceiver::ConnectEventReceiver(config->getInstanceName() + " SocketConnector", 0)
        , onConnect(onConnect)
        , onConnected(onConnected)
        , onDisconnect(onDisconnect)
        , onInitState(onInitState)
        , onStatus(onStatus)
        , config(config) {
    }

References config, onConnect, onConnected, onDisconnect, onInitState, and onStatus.

◆ SocketConnector() [2/2]

template<typename PhysicalSocketServer, typename Config, template< typename ConfigT, typename PhysicalSocketServerT > typename SocketConnection>

core::socket::stream::SocketConnector< PhysicalSocketServer, Config, SocketConnection >::SocketConnector ( const SocketConnector< PhysicalSocketClientT, ConfigT, SocketConnectionT > & socketConnector )

Definition at line 80 of file SocketConnector.hpp.

        : core::eventreceiver::ConnectEventReceiver(socketConnector.config->getInstanceName() + " SocketConnector", 0)
        , onConnect(socketConnector.onConnect)
        , onConnected(socketConnector.onConnected)
        , onDisconnect(socketConnector.onDisconnect)
        , onInitState(socketConnector.onInitState)
        , onStatus(socketConnector.onStatus)
        , config(socketConnector.config) {
    }

References config, onConnect, onConnected, onDisconnect, onInitState, and onStatus.

◆ ~SocketConnector()

template<typename PhysicalSocketClient, typename Config, template< typename ConfigT, typename PhysicalSocketClientT > typename SocketConnection>

core::socket::stream::SocketConnector< PhysicalSocketClient, Config, SocketConnection >::~SocketConnector ( )

override

Definition at line 93 of file SocketConnector.hpp.

93 {

94 }

Member Function Documentation

◆ connectEvent()

template<typename PhysicalSocketClient, typename Config, template< typename ConfigT, typename PhysicalSocketClientT > typename SocketConnection>

void core::socket::stream::SocketConnector< PhysicalSocketClient, Config, SocketConnection >::connectEvent ( )

finalprivatevirtual

Implements core::eventreceiver::ConnectEventReceiver.

Definition at line 236 of file SocketConnector.hpp.

                                                                                       {
        int cErrno = 0;
 
        if (isEnabled() && physicalClientSocket.getSockError(cErrno) == 0) { //  == 0->return valid : < 0->getsockopt failed
            const utils::PreserveErrno pe(cErrno);                           // errno = cErrno
 
            if (errno == 0) {
                SocketConnection* socketConnection = new SocketConnection(std::move(physicalClientSocket), onDisconnect, config);
 
                LOG(DEBUG) << config->getInstanceName() << " connect " << remoteAddress.toString() << ": success";
                LOG(DEBUG) << "  " << socketConnection->getLocalAddress().toString() << " -> "
                           << socketConnection->getRemoteAddress().toString();
 
                onStatus(remoteAddress, core::socket::STATE_OK);
 
                onConnect(socketConnection);
                onConnected(socketConnection);
 
                disable();
            } else if (PhysicalClientSocket::connectInProgress(errno)) {
                LOG(DEBUG) << config->getInstanceName() << " connect " << remoteAddress.toString() << ": in progress:";
            } else {
                SocketAddress currentRemoteAddress = remoteAddress;
 
                core::socket::State state = core::socket::STATE_OK;
 
                switch (errno) {
                    case EADDRINUSE:
                    case EADDRNOTAVAIL:
                    case ECONNREFUSED:
                    case ENETUNREACH:
                    case ENOENT:
                    case EHOSTDOWN:
                        state = core::socket::STATE_ERROR;
                        break;
                    default:
                        state = core::socket::STATE_FATAL;
                        break;
                }
 
                if (remoteAddress.useNext()) {
                    PLOG(DEBUG) << config->getInstanceName() << " connect '" << remoteAddress.toString();
 
                    onStatus(currentRemoteAddress, (state | core::socket::State::NO_RETRY));
 
                    LOG(DEBUG) << config->getInstanceName()
                               << " using next SocketAddress: " << config->Remote::getSocketAddress().toString();
 
                    useNextSocketAddress();
 
                    disable();
                } else {
                    PLOG(DEBUG) << config->getInstanceName() << " connect " << remoteAddress.toString();
 
                    onStatus(currentRemoteAddress, state);
 
                    disable();
                }
            }
        } else {
            PLOG(DEBUG) << config->getInstanceName() << " getsockopt syscall error: '" << remoteAddress.toString() << "'";
 
            onStatus(remoteAddress, core::socket::STATE_FATAL);
            disable();
        }
    }

References config, core::DescriptorEventReceiver::disable(), core::DescriptorEventReceiver::isEnabled(), core::socket::State::NO_RETRY, onConnect, onConnected, onDisconnect, onStatus, core::socket::State::operator|(), physicalClientSocket, utils::PreserveErrno::PreserveErrno(), remoteAddress, and useNextSocketAddress().

Here is the call graph for this function:

◆ connectTimeout()

template<typename PhysicalSocketClient, typename Config, template< typename ConfigT, typename PhysicalSocketClientT > typename SocketConnection>

void core::socket::stream::SocketConnector< PhysicalSocketClient, Config, SocketConnection >::connectTimeout ( )

finalprivatevirtual

Reimplemented from core::eventreceiver::ConnectEventReceiver.

Definition at line 313 of file SocketConnector.hpp.

                                                                                         {
        LOG(TRACE) << config->getInstanceName() << " connect timeout " << remoteAddress.toString();
 
        SocketAddress currentRemoteAddress = remoteAddress;
        if (remoteAddress.useNext()) {
            LOG(DEBUG) << config->getInstanceName() << " using next SocketAddress: '" << config->Remote::getSocketAddress().toString()
                       << "'";
 
            useNextSocketAddress();
        } else {
            LOG(DEBUG) << config->getInstanceName() << " connect timeout '" << remoteAddress.toString() << "'";
            errno = ETIMEDOUT;
 
            onStatus(currentRemoteAddress, core::socket::STATE_ERROR);
        }
 
        core::eventreceiver::ConnectEventReceiver::connectTimeout();
    }

References config, core::eventreceiver::ConnectEventReceiver::connectTimeout(), onStatus, remoteAddress, and useNextSocketAddress().

Here is the call graph for this function:

◆ destruct()

template<typename PhysicalSocketClient, typename Config, template< typename ConfigT, typename PhysicalSocketClientT > typename SocketConnection>

void core::socket::stream::SocketConnector< PhysicalSocketClient, Config, SocketConnection >::destruct ( )

finalprotectedvirtual

Reimplemented from core::EventReceiver.

Definition at line 335 of file SocketConnector.hpp.

                                                                                   {
        if (!config->getDisabled()) {
            onInitState(this);
        }
 
        delete this;
    }

References config, and onInitState.

Referenced by init(), and unobservedEvent().

Here is the caller graph for this function:

◆ init()

template<typename PhysicalSocketClient, typename Config, template< typename ConfigT, typename PhysicalSocketClientT > typename SocketConnection>

void core::socket::stream::SocketConnector< PhysicalSocketClient, Config, SocketConnection >::init ( )

virtual

Reimplemented in core::socket::stream::tls::SocketConnector< PhysicalSocketClientT, ConfigT >.

Definition at line 99 of file SocketConnector.hpp.

                                                                               {
        if (!config->getDisabled()) {
            try {
                core::socket::State state = core::socket::STATE_OK;
 
                LOG(DEBUG) << config->getInstanceName() << " Connect: starting";
 
                SocketAddress bindAddress = config->Local::getSocketAddress();
 
                try {
                    remoteAddress = config->Remote::getSocketAddress();
 
                    if (physicalClientSocket.open(config->getSocketOptions(), PhysicalClientSocket::Flags::NONBLOCK) < 0) {
                        PLOG(DEBUG) << config->getInstanceName() << " open " << bindAddress.toString();
 
                        switch (errno) {
                            case EMFILE:
                            case ENFILE:
                            case ENOBUFS:
                            case ENOMEM:
                                state = core::socket::STATE_ERROR;
                                break;
                            default:
                                state = core::socket::STATE_FATAL;
                                break;
                        }
 
                        onStatus(bindAddress, state);
                    } else {
                        LOG(TRACE) << config->getInstanceName() << " open " << bindAddress.toString() << ": success";
 
                        if (physicalClientSocket.bind(bindAddress) < 0) {
                            PLOG(DEBUG) << config->getInstanceName() << " bind " << bindAddress.toString();
 
                            switch (errno) {
                                case EADDRINUSE:
                                    state = core::socket::STATE_ERROR;
                                    break;
                                default:
                                    state = core::socket::STATE_FATAL;
                                    break;
                            }
 
                            onStatus(bindAddress, state);
                        } else {
                            LOG(TRACE) << config->getInstanceName() << " bind " << bindAddress.toString() << ": success";
 
                            if (physicalClientSocket.connect(remoteAddress) < 0 && !PhysicalClientSocket::connectInProgress(errno)) {
                                PLOG(DEBUG) << config->getInstanceName() << " connect " << remoteAddress.toString();
                                switch (errno) {
                                    case EADDRINUSE:
                                    case EADDRNOTAVAIL:
                                    case ECONNREFUSED:
                                    case ENETUNREACH:
                                    case ENOENT:
                                    case EHOSTDOWN:
                                        state = core::socket::STATE_ERROR;
                                        break;
                                    default:
                                        state = core::socket::STATE_FATAL;
                                        break;
                                }
 
                                SocketAddress currentRemoteAddress = remoteAddress;
                                if (remoteAddress.useNext()) {
                                    onStatus(currentRemoteAddress, state | core::socket::State::NO_RETRY);
 
                                    LOG(INFO) << config->getInstanceName() << ": Using next SocketAddress: " << remoteAddress.toString();
 
                                    useNextSocketAddress();
                                } else {
                                    onStatus(currentRemoteAddress, state);
                                }
                            } else {
                                LOG(TRACE) << config->getInstanceName() << " connect " << remoteAddress.toString() << ": success";
 
                                if (PhysicalClientSocket::connectInProgress(errno)) {
                                    if (enable(physicalClientSocket.getFd())) {
                                        LOG(DEBUG)
                                            << config->getInstanceName() << " enable " << remoteAddress.toString(false) << ": success";
                                    } else {
                                        LOG(ERROR) << config->getInstanceName() << " enable " << remoteAddress.toString()
                                                   << ": failed. No valid descriptor created";
 
                                        state = core::socket::STATE(core::socket::STATE_FATAL, ECANCELED, "SocketConnector not enabled");
 
                                        onStatus(remoteAddress, state);
                                    }
                                } else {
                                    SocketConnection* socketConnection =
                                        new SocketConnection(std::move(physicalClientSocket), onDisconnect, config);
 
                                    LOG(DEBUG) << config->getInstanceName() << " connect " << remoteAddress.toString() << ": success";
                                    LOG(DEBUG) << "  " << socketConnection->getLocalAddress().toString() << " -> "
                                               << socketConnection->getRemoteAddress().toString();
 
                                    onStatus(remoteAddress, state);
 
                                    onConnect(socketConnection);
                                    onConnected(socketConnection);
                                }
                            }
                        }
                    }
                } catch (const typename SocketAddress::BadSocketAddress& badSocketAddress) {
                    core::socket::State state =
                        core::socket::STATE(badSocketAddress.getState(), badSocketAddress.getErrnum(), badSocketAddress.what());
 
                    LOG(ERROR) << state.what();
 
                    onStatus({}, state);
                }
            } catch (const typename SocketAddress::BadSocketAddress& badSocketAddress) {
                core::socket::State state =
                    core::socket::STATE(badSocketAddress.getState(), badSocketAddress.getErrnum(), badSocketAddress.what());
 
                LOG(ERROR) << state.what();
 
                onStatus({}, state);
            }
        } else {
            LOG(DEBUG) << config->getInstanceName() << ": disabled";
 
            onStatus({}, core::socket::STATE_DISABLED);
        }
 
        if (isEnabled()) {
            onInitState(this);
            core::eventreceiver::ConnectEventReceiver::setTimeout(config->getConnectTimeout());
        } else {
            destruct();
        }
    }

References config, destruct(), core::DescriptorEventReceiver::enable(), core::DescriptorEventReceiver::isEnabled(), core::socket::State::NO_RETRY, onConnect, onConnected, onDisconnect, onInitState, onStatus, core::socket::State::operator|(), physicalClientSocket, remoteAddress, core::DescriptorEventReceiver::setTimeout(), useNextSocketAddress(), and core::socket::State::what().

Here is the call graph for this function:

◆ unobservedEvent()

template<typename PhysicalSocketClient, typename Config, template< typename ConfigT, typename PhysicalSocketClientT > typename SocketConnection>

void core::socket::stream::SocketConnector< PhysicalSocketClient, Config, SocketConnection >::unobservedEvent ( )

finalprivatevirtual

Implements core::Observer.

Definition at line 306 of file SocketConnector.hpp.

                                                                                          {
        destruct();
    }

References destruct().

Here is the call graph for this function:

◆ useNextSocketAddress()

template<typename PhysicalSocketClientT, typename ConfigT, template< typename PhysicalSocketClient, typename Config > typename SocketConnectionT>

virtual void core::socket::stream::SocketConnector< PhysicalSocketClientT, ConfigT, SocketConnectionT >::useNextSocketAddress ( )

protectedpure virtual

Implemented in core::socket::stream::legacy::SocketConnector< PhysicalClientSocketT, ConfigT >, and core::socket::stream::tls::SocketConnector< PhysicalSocketClientT, ConfigT >.

Referenced by connectEvent(), connectTimeout(), and init().

Here is the caller graph for this function:

Member Data Documentation

◆ config

template<typename PhysicalSocketClientT, typename ConfigT, template< typename PhysicalSocketClient, typename Config > typename SocketConnectionT>

std::shared_ptr<Config> core::socket::stream::SocketConnector< PhysicalSocketClientT, ConfigT, SocketConnectionT >::config = nullptr

protected

Definition at line 111 of file SocketConnector.h.

Referenced by connectEvent(), connectTimeout(), destruct(), init(), SocketConnector(), and SocketConnector().

◆ onConnect

template<typename PhysicalSocketClientT, typename ConfigT, template< typename PhysicalSocketClient, typename Config > typename SocketConnectionT>

std::function<void(SocketConnection*)> core::socket::stream::SocketConnector< PhysicalSocketClientT, ConfigT, SocketConnectionT >::onConnect

protected

Definition at line 104 of file SocketConnector.h.

Referenced by connectEvent(), init(), SocketConnector(), and SocketConnector().

◆ onConnected

template<typename PhysicalSocketClientT, typename ConfigT, template< typename PhysicalSocketClient, typename Config > typename SocketConnectionT>

std::function<void(SocketConnection*)> core::socket::stream::SocketConnector< PhysicalSocketClientT, ConfigT, SocketConnectionT >::onConnected

protected

Definition at line 105 of file SocketConnector.h.

Referenced by connectEvent(), init(), SocketConnector(), and SocketConnector().

◆ onDisconnect

template<typename PhysicalSocketClientT, typename ConfigT, template< typename PhysicalSocketClient, typename Config > typename SocketConnectionT>

std::function<void(SocketConnection*)> core::socket::stream::SocketConnector< PhysicalSocketClientT, ConfigT, SocketConnectionT >::onDisconnect

protected

Definition at line 106 of file SocketConnector.h.

Referenced by connectEvent(), init(), SocketConnector(), and SocketConnector().

◆ onInitState

template<typename PhysicalSocketClientT, typename ConfigT, template< typename PhysicalSocketClient, typename Config > typename SocketConnectionT>

std::function<void(core::eventreceiver::ConnectEventReceiver*)> core::socket::stream::SocketConnector< PhysicalSocketClientT, ConfigT, SocketConnectionT >::onInitState

protected

Definition at line 107 of file SocketConnector.h.

Referenced by destruct(), init(), SocketConnector(), and SocketConnector().

◆ onStatus

template<typename PhysicalSocketClientT, typename ConfigT, template< typename PhysicalSocketClient, typename Config > typename SocketConnectionT>

std::function<void(const SocketAddress&, core::socket::State)> core::socket::stream::SocketConnector< PhysicalSocketClientT, ConfigT, SocketConnectionT >::onStatus

protected

Definition at line 109 of file SocketConnector.h.

Referenced by connectEvent(), connectTimeout(), init(), SocketConnector(), and SocketConnector().

◆ physicalClientSocket

template<typename PhysicalSocketClientT, typename ConfigT, template< typename PhysicalSocketClient, typename Config > typename SocketConnectionT>

PhysicalClientSocket core::socket::stream::SocketConnector< PhysicalSocketClientT, ConfigT, SocketConnectionT >::physicalClientSocket

private

Definition at line 100 of file SocketConnector.h.

Referenced by connectEvent(), and init().

◆ remoteAddress

template<typename PhysicalSocketClientT, typename ConfigT, template< typename PhysicalSocketClient, typename Config > typename SocketConnectionT>

SocketAddress core::socket::stream::SocketConnector< PhysicalSocketClientT, ConfigT, SocketConnectionT >::remoteAddress

private

Definition at line 101 of file SocketConnector.h.

Referenced by connectEvent(), connectTimeout(), and init().

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

core/socket/stream/SocketConnector.h
core/socket/stream/SocketConnector.hpp

SNode.C

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ Config

◆ PhysicalClientSocket

◆ SocketAddress

◆ SocketConnection

Constructor & Destructor Documentation

◆ SocketConnector() [1/2]

◆ SocketConnector() [2/2]

◆ ~SocketConnector()

Member Function Documentation

◆ connectEvent()

◆ connectTimeout()

◆ destruct()

◆ init()

◆ unobservedEvent()

◆ useNextSocketAddress()

Member Data Documentation

◆ config

◆ onConnect

◆ onConnected

◆ onDisconnect

◆ onInitState

◆ onStatus

◆ physicalClientSocket

◆ remoteAddress