#include <SocketAcceptor.h>

Inheritance diagram for core::socket::stream::SocketAcceptor< PhysicalSocketServerT, ConfigT, SocketConnectionT >:

Collaboration diagram for core::socket::stream::SocketAcceptor< PhysicalSocketServerT, ConfigT, SocketConnectionT >:

Public Member Functions
	SocketAcceptor (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)

	SocketAcceptor (const SocketAcceptor &socketAcceptor)

	~SocketAcceptor () override

Protected Types
using	Config = ConfigT

using	SocketAddress = typename PhysicalServerSocket::SocketAddress

using	SocketConnection = SocketConnectionT< PhysicalServerSocket >

Protected Member Functions
virtual void	useNextSocketAddress ()=0

virtual void	init ()

void	destruct () final

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

virtual void	acceptTimeout ()

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 = nullptr

std::shared_ptr< Config >	config

Private Types
using	PhysicalServerSocket = PhysicalSocketServerT

Private Member Functions
void	acceptEvent () final

void	unobservedEvent () final

Private Attributes
PhysicalServerSocket	physicalServerSocket

SocketAddress	localAddress

Detailed Description

template<typename PhysicalSocketServerT, typename ConfigT, template< typename PhysicalSocketServer > typename SocketConnectionT>
class core::socket::stream::SocketAcceptor< PhysicalSocketServerT, ConfigT, SocketConnectionT >

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

Definition at line 67 of file SocketAcceptor.h.

Member Typedef Documentation

◆ Config

template<typename PhysicalSocketServerT , typename ConfigT , template< typename PhysicalSocketServer > typename SocketConnectionT>

using core::socket::stream::SocketAcceptor< PhysicalSocketServerT, ConfigT, SocketConnectionT >::Config = ConfigT

protected

Definition at line 72 of file SocketAcceptor.h.

◆ PhysicalServerSocket

template<typename PhysicalSocketServerT , typename ConfigT , template< typename PhysicalSocketServer > typename SocketConnectionT>

using core::socket::stream::SocketAcceptor< PhysicalSocketServerT, ConfigT, SocketConnectionT >::PhysicalServerSocket = PhysicalSocketServerT

private

Definition at line 69 of file SocketAcceptor.h.

◆ SocketAddress

template<typename PhysicalSocketServerT , typename ConfigT , template< typename PhysicalSocketServer > typename SocketConnectionT>

using core::socket::stream::SocketAcceptor< PhysicalSocketServerT, ConfigT, SocketConnectionT >::SocketAddress = typename PhysicalServerSocket::SocketAddress

protected

Definition at line 73 of file SocketAcceptor.h.

◆ SocketConnection

template<typename PhysicalSocketServerT , typename ConfigT , template< typename PhysicalSocketServer > typename SocketConnectionT>

using core::socket::stream::SocketAcceptor< PhysicalSocketServerT, ConfigT, SocketConnectionT >::SocketConnection = SocketConnectionT<PhysicalServerSocket>

protected

Definition at line 74 of file SocketAcceptor.h.

Constructor & Destructor Documentation

◆ SocketAcceptor() [1/2]

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

core::socket::stream::SocketAcceptor< PhysicalSocketServer, Config, SocketConnection >::SocketAcceptor	(	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 105 of file SocketAcceptor.hpp.

        : core::eventreceiver::AcceptEventReceiver(config->getInstanceName() + " SocketAcceptor", 0)
        , socketContextFactory(socketContextFactory)
        , onConnect(onConnect)
        , onConnected(onConnected)
        , onDisconnect(onDisconnect)
        , onStatus(onStatus)
        , config(config) {
        atNextTick([this]() {
            if (core::eventLoopState() == core::State::RUNNING) {
                init();
            } else {
                destruct();
            }
        });
    }

Here is the call graph for this function:

◆ SocketAcceptor() [2/2]

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

core::socket::stream::SocketAcceptor< PhysicalSocketServer, Config, SocketConnection >::SocketAcceptor ( const SocketAcceptor< PhysicalSocketServerT, ConfigT, SocketConnectionT > & socketAcceptor )

Definition at line 129 of file SocketAcceptor.hpp.

        : core::eventreceiver::AcceptEventReceiver(socketAcceptor.config->getInstanceName() + " SocketAcceptor", 0)
        , socketContextFactory(socketAcceptor.socketContextFactory)
        , onConnect(socketAcceptor.onConnect)
        , onConnected(socketAcceptor.onConnected)
        , onDisconnect(socketAcceptor.onDisconnect)
        , onStatus(socketAcceptor.onStatus)
        , config(socketAcceptor.config) {
        atNextTick([this]() {
            if (core::eventLoopState() == core::State::RUNNING) {
                init();
            } else {
                destruct();
            }
        });
    }

Here is the call graph for this function:

◆ ~SocketAcceptor()

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

core::socket::stream::SocketAcceptor< PhysicalSocketServer, Config, SocketConnection >::~SocketAcceptor ( )

override

Definition at line 147 of file SocketAcceptor.hpp.

147 {

148 }

Member Function Documentation

◆ acceptEvent()

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

void core::socket::stream::SocketAcceptor< PhysicalSocketServer, Config, SocketConnection >::acceptEvent ( )

finalprivatevirtual

Implements core::eventreceiver::AcceptEventReceiver.

Definition at line 242 of file SocketAcceptor.hpp.

                                                                                     {
        int acceptsPerTick = config->getAcceptsPerTick();
 
        do {
            PhysicalServerSocket connectedPhysicalSocket(physicalServerSocket.accept4(PhysicalServerSocket::Flags::NONBLOCK),
                                                         physicalServerSocket.getBindAddress());
            if (connectedPhysicalSocket.isValid()) {
                LOG(DEBUG) << "[" << connectedPhysicalSocket.getFd() << " ]" << config->getInstanceName() << ": accept success: '"
                           << connectedPhysicalSocket.getBindAddress().toString() << "'";
 
                SocketConnection* socketConnection =
                    new SocketConnection(config->getInstanceName(),
                                         std::move(connectedPhysicalSocket),
                                         onDisconnect,
                                         localAddress.toString(false),
                                         getLocalSocketAddress<SocketAddress>(connectedPhysicalSocket, config),
                                         getRemoteSocketAddress<SocketAddress>(connectedPhysicalSocket, config),
                                         config->getReadTimeout(),
                                         config->getWriteTimeout(),
                                         config->getReadBlockSize(),
                                         config->getWriteBlockSize(),
                                         config->getTerminateTimeout());
 
                onConnect(socketConnection);
                onConnected(socketConnection);
            } else if (errno != EINTR && errno != EAGAIN && errno != EWOULDBLOCK) {
                PLOG(WARNING) << config->getInstanceName() << " accept failed: '" << physicalServerSocket.getBindAddress().toString()
                              << "'";
            }
        } while (--acceptsPerTick > 0);
    }

References core::socket::stream::SocketAcceptor< PhysicalSocketServerT, ConfigT, SocketConnectionT >::config, core::socket::stream::SocketAcceptor< PhysicalSocketServerT, ConfigT, SocketConnectionT >::localAddress, core::socket::stream::SocketAcceptor< PhysicalSocketServerT, ConfigT, SocketConnectionT >::onConnect, core::socket::stream::SocketAcceptor< PhysicalSocketServerT, ConfigT, SocketConnectionT >::onConnected, core::socket::stream::SocketAcceptor< PhysicalSocketServerT, ConfigT, SocketConnectionT >::onDisconnect, and core::socket::stream::SocketAcceptor< PhysicalSocketServerT, ConfigT, SocketConnectionT >::physicalServerSocket.

◆ destruct()

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

void core::socket::stream::SocketAcceptor< PhysicalSocketServer, Config, SocketConnection >::destruct ( )

finalprotectedvirtual

Reimplemented from core::EventReceiver.

Definition at line 280 of file SocketAcceptor.hpp.

                                                                                  {
        delete this;
    }

Referenced by core::socket::stream::SocketAcceptor< PhysicalSocketServerT, ConfigT, SocketConnectionT >::init(), core::socket::stream::SocketAcceptor< PhysicalSocketServerT, ConfigT, SocketConnectionT >::SocketAcceptor(), core::socket::stream::SocketAcceptor< PhysicalSocketServerT, ConfigT, SocketConnectionT >::SocketAcceptor(), and core::socket::stream::SocketAcceptor< PhysicalSocketServerT, ConfigT, SocketConnectionT >::unobservedEvent().

Here is the caller graph for this function:

◆ init()

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

void core::socket::stream::SocketAcceptor< PhysicalSocketServer, Config, SocketConnection >::init ( )

protectedvirtual

Reimplemented in core::socket::stream::tls::SocketAcceptor< PhysicalSocketServerT, ConfigT >.

Definition at line 151 of file SocketAcceptor.hpp.

                                                                              {
        if (!config->getDisabled()) {
            try {
                LOG(TRACE) << config->getInstanceName() << " Starting";
 
                localAddress = config->Local::getSocketAddress();
 
                core::socket::State state = core::socket::STATE_OK;
 
                if (physicalServerSocket.open(config->getSocketOptions(), PhysicalServerSocket::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;
                    }
                } else if (physicalServerSocket.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;
                    }
                } else if (physicalServerSocket.listen(config->getBacklog()) < 0) {
                    switch (errno) {
                        case EADDRINUSE:
                            PLOG(DEBUG) << config->getInstanceName() << " listen: '" << localAddress.toString() << "'";
 
                            state = core::socket::STATE_ERROR;
                            break;
                        default:
                            PLOG(DEBUG) << config->getInstanceName() << " listen: '" << localAddress.toString() << "'";
 
                            state = core::socket::STATE_FATAL;
                            break;
                    }
                } else {
                    if (enable(physicalServerSocket.getFd())) {
                        LOG(DEBUG) << config->getInstanceName() << " enabled: '" << localAddress.toString() << "' success";
                    } else {
                        LOG(DEBUG) << config->getInstanceName() << " enabled: '" << localAddress.toString() << "' failed";
 
                        state = core::socket::STATE(core::socket::STATE_FATAL, ECANCELED, "SocketAcceptor not enabled");
                    }
                }
 
                SocketAddress currentLocalAddress = localAddress;
                if (localAddress.useNext()) {
                    onStatus(currentLocalAddress, (state | core::socket::State::NO_RETRY));
 
                    LOG(DEBUG) << config->getInstanceName() << " using next SocketAddress: '"
                               << config->Local::getSocketAddress().toString() << "'";
 
                    useNextSocketAddress();
                } else {
                    onStatus(currentLocalAddress, state);
                }
            } 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::AcceptEventReceiver::setTimeout(config->getAcceptTimeout());
        } else {
            destruct();
        }
    }

References core::socket::stream::SocketAcceptor< PhysicalSocketServerT, ConfigT, SocketConnectionT >::config, core::socket::stream::SocketAcceptor< PhysicalSocketServerT, ConfigT, SocketConnectionT >::destruct(), core::DescriptorEventReceiver::enable(), core::DescriptorEventReceiver::isEnabled(), core::socket::stream::SocketAcceptor< PhysicalSocketServerT, ConfigT, SocketConnectionT >::localAddress, core::socket::State::NO_RETRY, core::socket::stream::SocketAcceptor< PhysicalSocketServerT, ConfigT, SocketConnectionT >::onStatus, core::socket::State::operator|(), core::socket::stream::SocketAcceptor< PhysicalSocketServerT, ConfigT, SocketConnectionT >::physicalServerSocket, core::DescriptorEventReceiver::setTimeout(), and core::socket::stream::SocketAcceptor< PhysicalSocketServerT, ConfigT, SocketConnectionT >::useNextSocketAddress().

Referenced by core::socket::stream::SocketAcceptor< PhysicalSocketServerT, ConfigT, SocketConnectionT >::SocketAcceptor(), and core::socket::stream::SocketAcceptor< PhysicalSocketServerT, ConfigT, SocketConnectionT >::SocketAcceptor().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ unobservedEvent()

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

void core::socket::stream::SocketAcceptor< PhysicalSocketServer, Config, SocketConnection >::unobservedEvent ( )

finalprivatevirtual

Implements core::Observer.

Definition at line 275 of file SocketAcceptor.hpp.

                                                                                         {
        destruct();
    }

References core::socket::stream::SocketAcceptor< PhysicalSocketServerT, ConfigT, SocketConnectionT >::destruct().

Here is the call graph for this function:

◆ useNextSocketAddress()

template<typename PhysicalSocketServerT , typename ConfigT , template< typename PhysicalSocketServer > typename SocketConnectionT>

virtual void core::socket::stream::SocketAcceptor< PhysicalSocketServerT, ConfigT, SocketConnectionT >::useNextSocketAddress ( )

protectedpure virtual

Implemented in core::socket::stream::legacy::SocketAcceptor< PhysicalServerSocketT, ConfigT >, and core::socket::stream::tls::SocketAcceptor< PhysicalSocketServerT, ConfigT >.

Referenced by core::socket::stream::SocketAcceptor< PhysicalSocketServerT, ConfigT, SocketConnectionT >::init().

Here is the caller graph for this function:

Member Data Documentation

◆ config

template<typename PhysicalSocketServerT , typename ConfigT , template< typename PhysicalSocketServer > typename SocketConnectionT>

std::shared_ptr<Config> core::socket::stream::SocketAcceptor< PhysicalSocketServerT, ConfigT, SocketConnectionT >::config

protected

Definition at line 114 of file SocketAcceptor.h.

Referenced by core::socket::stream::SocketAcceptor< PhysicalSocketServerT, ConfigT, SocketConnectionT >::acceptEvent(), core::socket::stream::SocketAcceptor< PhysicalSocketServerT, ConfigT, SocketConnectionT >::init(), core::socket::stream::SocketAcceptor< PhysicalSocketServerT, ConfigT, SocketConnectionT >::SocketAcceptor(), and core::socket::stream::SocketAcceptor< PhysicalSocketServerT, ConfigT, SocketConnectionT >::SocketAcceptor().

◆ localAddress

template<typename PhysicalSocketServerT , typename ConfigT , template< typename PhysicalSocketServer > typename SocketConnectionT>

SocketAddress core::socket::stream::SocketAcceptor< PhysicalSocketServerT, ConfigT, SocketConnectionT >::localAddress

private

Definition at line 103 of file SocketAcceptor.h.

Referenced by core::socket::stream::SocketAcceptor< PhysicalSocketServerT, ConfigT, SocketConnectionT >::acceptEvent(), and core::socket::stream::SocketAcceptor< PhysicalSocketServerT, ConfigT, SocketConnectionT >::init().

◆ onConnect

template<typename PhysicalSocketServerT , typename ConfigT , template< typename PhysicalSocketServer > typename SocketConnectionT>

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

protected

Definition at line 108 of file SocketAcceptor.h.

Referenced by core::socket::stream::SocketAcceptor< PhysicalSocketServerT, ConfigT, SocketConnectionT >::acceptEvent(), core::socket::stream::SocketAcceptor< PhysicalSocketServerT, ConfigT, SocketConnectionT >::SocketAcceptor(), and core::socket::stream::SocketAcceptor< PhysicalSocketServerT, ConfigT, SocketConnectionT >::SocketAcceptor().

◆ onConnected

template<typename PhysicalSocketServerT , typename ConfigT , template< typename PhysicalSocketServer > typename SocketConnectionT>

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

protected

Definition at line 109 of file SocketAcceptor.h.

Referenced by core::socket::stream::SocketAcceptor< PhysicalSocketServerT, ConfigT, SocketConnectionT >::acceptEvent(), core::socket::stream::SocketAcceptor< PhysicalSocketServerT, ConfigT, SocketConnectionT >::SocketAcceptor(), and core::socket::stream::SocketAcceptor< PhysicalSocketServerT, ConfigT, SocketConnectionT >::SocketAcceptor().

◆ onDisconnect

template<typename PhysicalSocketServerT , typename ConfigT , template< typename PhysicalSocketServer > typename SocketConnectionT>

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

protected

Definition at line 110 of file SocketAcceptor.h.

Referenced by core::socket::stream::SocketAcceptor< PhysicalSocketServerT, ConfigT, SocketConnectionT >::acceptEvent(), core::socket::stream::SocketAcceptor< PhysicalSocketServerT, ConfigT, SocketConnectionT >::SocketAcceptor(), and core::socket::stream::SocketAcceptor< PhysicalSocketServerT, ConfigT, SocketConnectionT >::SocketAcceptor().

◆ onStatus

template<typename PhysicalSocketServerT , typename ConfigT , template< typename PhysicalSocketServer > typename SocketConnectionT>

std::function<void(const SocketAddress&, core::socket::State)> core::socket::stream::SocketAcceptor< PhysicalSocketServerT, ConfigT, SocketConnectionT >::onStatus = nullptr

protected

Definition at line 112 of file SocketAcceptor.h.

Referenced by core::socket::stream::SocketAcceptor< PhysicalSocketServerT, ConfigT, SocketConnectionT >::init(), core::socket::stream::SocketAcceptor< PhysicalSocketServerT, ConfigT, SocketConnectionT >::SocketAcceptor(), and core::socket::stream::SocketAcceptor< PhysicalSocketServerT, ConfigT, SocketConnectionT >::SocketAcceptor().

◆ physicalServerSocket

template<typename PhysicalSocketServerT , typename ConfigT , template< typename PhysicalSocketServer > typename SocketConnectionT>

PhysicalServerSocket core::socket::stream::SocketAcceptor< PhysicalSocketServerT, ConfigT, SocketConnectionT >::physicalServerSocket

private

Definition at line 102 of file SocketAcceptor.h.

Referenced by core::socket::stream::SocketAcceptor< PhysicalSocketServerT, ConfigT, SocketConnectionT >::acceptEvent(), and core::socket::stream::SocketAcceptor< PhysicalSocketServerT, ConfigT, SocketConnectionT >::init().

◆ socketContextFactory

template<typename PhysicalSocketServerT , typename ConfigT , template< typename PhysicalSocketServer > typename SocketConnectionT>

std::shared_ptr<core::socket::stream::SocketContextFactory> core::socket::stream::SocketAcceptor< PhysicalSocketServerT, ConfigT, SocketConnectionT >::socketContextFactory = nullptr

protected

Definition at line 106 of file SocketAcceptor.h.

Referenced by core::socket::stream::SocketAcceptor< PhysicalSocketServerT, ConfigT, SocketConnectionT >::SocketAcceptor(), and core::socket::stream::SocketAcceptor< PhysicalSocketServerT, ConfigT, SocketConnectionT >::SocketAcceptor().

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

core/socket/stream/SocketAcceptor.h
core/socket/stream/SocketAcceptor.hpp

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ Config

◆ PhysicalServerSocket

◆ SocketAddress

◆ SocketConnection

Constructor & Destructor Documentation

◆ SocketAcceptor() [1/2]

◆ SocketAcceptor() [2/2]

◆ ~SocketAcceptor()

Member Function Documentation

◆ acceptEvent()

◆ destruct()

◆ init()

◆ unobservedEvent()

◆ useNextSocketAddress()

Member Data Documentation

◆ config

◆ localAddress

◆ onConnect

◆ onConnected

◆ onDisconnect

◆ onStatus

◆ physicalServerSocket

◆ socketContextFactory