#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::shared_ptr< core::socket::stream::SocketContextFactory > &socketContextFactory, const std::function< void(SocketConnection )> &onConnect, const std::function< void(SocketConnection )> &onConnected, const std::function< void(SocketConnection *)> &onDisconnect, const std::function< void(const SocketAddress &, core::socket::State)> &onStatus, const std::shared_ptr< Config > &config)

	SocketConnector (const SocketConnector &socketConnector)

	~SocketConnector () override

Protected Types
using	Config = ConfigT

using	SocketAddress = typename PhysicalClientSocket::SocketAddress

using	SocketConnection = SocketConnectionT<PhysicalClientSocket>

Protected Member Functions
virtual void	useNextSocketAddress ()=0

virtual void	init ()

void	destruct () final

Protected Member Functions inherited from core::eventreceiver::ConnectEventReceiver
	ConnectEventReceiver (const std::string &name, const utils::Timeval &timeout)

Protected Member Functions inherited from core::DescriptorEventReceiver
bool	enable (int fd)

void	disable ()

void	suspend ()

void	resume ()

	DescriptorEventReceiver (const std::string &name, DescriptorEventPublisher &descriptorEventPublisher, const utils::Timeval &timeout=TIMEOUT::DISABLE)

int	getRegisteredFd () const

bool	isEnabled () const

bool	isSuspended () const

void	setTimeout (const utils::Timeval &timeout)

utils::Timeval	getTimeout (const utils::Timeval &currentTime) const

void	checkTimeout (const utils::Timeval &currentTime)

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::shared_ptr< core::socket::stream::SocketContextFactory >	socketContextFactory = nullptr

std::function< void(SocketConnection *)>	onConnect

std::function< void(SocketConnection *)>	onConnected

std::function< void(SocketConnection *)>	onDisconnect

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 SocketConnectionT>
class core::socket::stream::SocketConnector< PhysicalSocketClientT, ConfigT, SocketConnectionT >

Definition at line 40 of file SocketConnector.h.

Member Typedef Documentation

◆ Config

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

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

protected

Definition at line 45 of file SocketConnector.h.

◆ PhysicalClientSocket

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

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

private

Definition at line 42 of file SocketConnector.h.

◆ SocketAddress

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

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

protected

Definition at line 46 of file SocketConnector.h.

◆ SocketConnection

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

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

protected

Definition at line 47 of file SocketConnector.h.

Constructor & Destructor Documentation

◆ SocketConnector() [1/2]

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

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

Definition at line 83 of file SocketConnector.hpp.

        : core::eventreceiver::ConnectEventReceiver(config->getInstanceName() + " SocketConnector", 0)
        , socketContextFactory(socketContextFactory)
        , onConnect(onConnect)
        , onConnected(onConnected)
        , onDisconnect(onDisconnect)
        , onStatus(onStatus)
        , config(config) {
        atNextTick([this]() {
            init();
        });
    }

◆ SocketConnector() [2/2]

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

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

Definition at line 103 of file SocketConnector.hpp.

        : core::eventreceiver::ConnectEventReceiver(socketConnector.config->getInstanceName() + " SocketConnector", 0)
        , socketContextFactory(socketConnector.socketContextFactory)
        , onConnect(socketConnector.onConnect)
        , onConnected(socketConnector.onConnected)
        , onDisconnect(socketConnector.onDisconnect)
        , onStatus(socketConnector.onStatus)
        , config(socketConnector.config) {
        atNextTick([this]() {
            init();
        });
    }

◆ ~SocketConnector()

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

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

override

Definition at line 117 of file SocketConnector.hpp.

117 {

118 }

Member Function Documentation

◆ connectEvent()

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

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

finalprivatevirtual

Implements core::eventreceiver::ConnectEventReceiver.

Definition at line 250 of file SocketConnector.hpp.

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

◆ connectTimeout()

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

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

finalprivatevirtual

Reimplemented from core::eventreceiver::ConnectEventReceiver.

Definition at line 348 of file SocketConnector.hpp.

                                                                                         {
        LOG(TRACE) << config->getInstanceName() << " connect timeout " << remoteAddress.toString();
 
        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(remoteAddress, core::socket::STATE_ERROR);
        }
 
        core::eventreceiver::ConnectEventReceiver::connectTimeout();
    }

◆ destruct()

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

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

finalprotectedvirtual

Reimplemented from core::EventReceiver.

Definition at line 367 of file SocketConnector.hpp.

                                                                                   {
        delete this;
    }

◆ init()

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

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

protectedvirtual

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

Definition at line 121 of file SocketConnector.hpp.

                                                                               {
        if (!config->getDisabled() && core::eventLoopState() == core::State::RUNNING) {
            try {
                LOG(TRACE) << config->getInstanceName() << " Starting";
 
                remoteAddress = config->Remote::getSocketAddress();
                SocketAddress localAddress = config->Local::getSocketAddress();
 
                try {
                    core::socket::State state = core::socket::STATE_OK;
 
                    if (physicalClientSocket.open(config->getSocketOptions(), PhysicalClientSocket::Flags::NONBLOCK) < 0) {
                        switch (errno) {
                            case EMFILE:
                            case ENFILE:
                            case ENOBUFS:
                            case ENOMEM:
                                PLOG(DEBUG) << config->getInstanceName() << " open: '" << localAddress.toString() << "'";
 
                                state = core::socket::STATE_ERROR;
                                break;
                            default:
                                PLOG(DEBUG) << config->getInstanceName() << " open: '" << localAddress.toString() << "'";
 
                                state = core::socket::STATE_FATAL;
                                break;
                        }
 
                        onStatus(remoteAddress, state);
                    } else if (physicalClientSocket.bind(localAddress) < 0) {
                        switch (errno) {
                            case EADDRINUSE:
                                PLOG(DEBUG) << config->getInstanceName() << " bind: '" << localAddress.toString() << "'";
 
                                state = core::socket::STATE_ERROR;
                                break;
                            default:
                                PLOG(DEBUG) << config->getInstanceName() << " bind: '" << localAddress.toString() << "'";
 
                                state = core::socket::STATE_FATAL;
                                break;
                        }
 
                        onStatus(remoteAddress, state);
                    } else if (physicalClientSocket.connect(remoteAddress) < 0 && !PhysicalClientSocket::connectInProgress(errno)) {
                        switch (errno) {
                            case EADDRINUSE:
                            case EADDRNOTAVAIL:
                            case ECONNREFUSED:
                            case ENETUNREACH:
                            case ENOENT:
                            case EHOSTDOWN:
                                PLOG(DEBUG) << config->getInstanceName() << " connect: '" << remoteAddress.toString() << "'";
 
                                state = core::socket::STATE_ERROR;
                                break;
                            default:
                                PLOG(DEBUG) << config->getInstanceName() << " connect: '" << remoteAddress.toString() << "'";
 
                                state = core::socket::STATE_FATAL;
                                break;
                        }
 
                        if (remoteAddress.useNext()) {
                            onStatus(remoteAddress, state | core::socket::State::NO_RETRY);
 
                            LOG(DEBUG) << config->getInstanceName() << " using next SocketAddress: '"
                                       << config->Remote::getSocketAddress().toString() << "'";
 
                            useNextSocketAddress();
                        } else {
                            onStatus(remoteAddress, state);
                        }
                    } else if (PhysicalClientSocket::connectInProgress(errno)) {
                        if (enable(physicalClientSocket.getFd())) {
                            LOG(DEBUG) << config->getInstanceName() << " connect in progress: '" << remoteAddress.toString() << "'";
                        } else {
                            LOG(DEBUG) << config->getInstanceName() << " not enabled: '" << remoteAddress.toString() << "'";
 
                            state = core::socket::STATE(core::socket::STATE_FATAL, ECANCELED, "SocketConnector not enabled");
 
                            onStatus(remoteAddress, state);
                        }
                    } else {
                        LOG(DEBUG) << config->getInstanceName() << " [" << physicalClientSocket.getFd() << "] connect success: '"
                                   << remoteAddress.toString() << "'";
 
                        onStatus(remoteAddress, core::socket::STATE_OK);
 
                        SocketConnection* socketConnection =
                            new SocketConnection(config->getInstanceName(),
                                                 std::move(physicalClientSocket),
                                                 onDisconnect,
                                                 remoteAddress.toString(false),
                                                 getLocalSocketAddress<SocketAddress>(physicalClientSocket, config),
                                                 getRemoteSocketAddress<SocketAddress>(physicalClientSocket, config),
                                                 config->getReadTimeout(),
                                                 config->getWriteTimeout(),
                                                 config->getReadBlockSize(),
                                                 config->getWriteBlockSize(),
                                                 config->getTerminateTimeout());
 
                        onConnect(socketConnection);
                        onConnected(socketConnection);
                    }
                } catch (const typename SocketAddress::BadSocketAddress& badSocketAddress) {
                    LOG(DEBUG) << config->getInstanceName() << " " << badSocketAddress.what();
 
                    onStatus({}, core::socket::STATE(badSocketAddress.getState(), badSocketAddress.getErrnum(), badSocketAddress.what()));
                }
            } catch (const typename SocketAddress::BadSocketAddress& badSocketAddress) {
                LOG(DEBUG) << config->getInstanceName() << " " << badSocketAddress.what();
 
                onStatus({}, core::socket::STATE(badSocketAddress.getState(), badSocketAddress.getErrnum(), badSocketAddress.what()));
            }
        } else {
            LOG(DEBUG) << config->getInstanceName() << " disabled";
 
            onStatus({}, core::socket::STATE_DISABLED);
        }
 
        if (isEnabled()) {
            core::eventreceiver::ConnectEventReceiver::setTimeout(config->getConnectTimeout());
        } else {
            destruct();
        }
    }

◆ unobservedEvent()

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

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

finalprivatevirtual

Implements core::Observer.

Definition at line 343 of file SocketConnector.hpp.

                                                                                          {
        destruct();
    }

◆ useNextSocketAddress()

template<typename PhysicalSocketClientT , typename ConfigT , template< typename PhysicalSocketClient > 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 >.

Member Data Documentation

◆ config

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

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

protected

Definition at line 88 of file SocketConnector.h.

◆ onConnect

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

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

protected

Definition at line 82 of file SocketConnector.h.

◆ onConnected

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

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

protected

Definition at line 83 of file SocketConnector.h.

◆ onDisconnect

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

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

protected

Definition at line 84 of file SocketConnector.h.

◆ onStatus

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

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

protected

Definition at line 86 of file SocketConnector.h.

◆ physicalClientSocket

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

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

private

Definition at line 76 of file SocketConnector.h.

◆ remoteAddress

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

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

private

Definition at line 77 of file SocketConnector.h.

◆ socketContextFactory

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

std::shared_ptr<core::socket::stream::SocketContextFactory> core::socket::stream::SocketConnector< PhysicalSocketClientT, ConfigT, SocketConnectionT >::socketContextFactory = nullptr

protected

Definition at line 80 of file SocketConnector.h.

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

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

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

◆ onStatus

◆ physicalClientSocket

◆ remoteAddress

◆ socketContextFactory