#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::function< void(SocketConnection )> &onConnect, const std::function< void(SocketConnection )> &onConnected, const std::function< void(SocketConnection )> &onDisconnect, const std::function< void(core::eventreceiver::AcceptEventReceiver )> &onInitState, const std::function< void(const SocketAddress &, core::socket::State)> &onStatus, const std::shared_ptr< Config > &config)
	SocketAcceptor (const SocketAcceptor &socketAcceptor)
	~SocketAcceptor () override
virtual void	init ()

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

Protected Member Functions
virtual void	useNextSocketAddress ()=0
void	destruct () final
Protected Member Functions inherited from core::eventreceiver::AcceptEventReceiver
	AcceptEventReceiver (const std::string &name, const utils::Timeval &timeout)
virtual void	acceptTimeout ()
void	stopListen ()
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::AcceptEventReceiver *)>	onInitState
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	bindAddress

Detailed Description

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

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

Definition at line 69 of file SocketAcceptor.h.

Member Typedef Documentation

◆ Config

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

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

protected

Definition at line 74 of file SocketAcceptor.h.

◆ PhysicalServerSocket

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

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

private

Definition at line 71 of file SocketAcceptor.h.

◆ SocketAddress

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

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

protected

Definition at line 75 of file SocketAcceptor.h.

◆ SocketConnection

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

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

protected

Definition at line 76 of file SocketAcceptor.h.

Constructor & Destructor Documentation

◆ SocketAcceptor() [1/2]

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

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

Definition at line 61 of file SocketAcceptor.hpp.

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

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

◆ SocketAcceptor() [2/2]

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

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

Definition at line 80 of file SocketAcceptor.hpp.

        : core::eventreceiver::AcceptEventReceiver(socketAcceptor.config->getInstanceName() + " SocketAcceptor", 0)
        , onConnect(socketAcceptor.onConnect)
        , onConnected(socketAcceptor.onConnected)
        , onDisconnect(socketAcceptor.onDisconnect)
        , onInitState(socketAcceptor.onInitState)
        , onStatus(socketAcceptor.onStatus)
        , config(socketAcceptor.config) {
    }

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

◆ ~SocketAcceptor()

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

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

override

Definition at line 93 of file SocketAcceptor.hpp.

93 {

94 }

Member Function Documentation

◆ acceptEvent()

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

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

finalprivatevirtual

Implements core::eventreceiver::AcceptEventReceiver.

Definition at line 203 of file SocketAcceptor.hpp.

                                                                                     {
        if (isEnabled()) {
            int acceptsPerTick = config->getAcceptsPerTick();
 
            do {
                PhysicalServerSocket connectedPhysicalSocket(physicalServerSocket.accept4(PhysicalServerSocket::Flags::NONBLOCK),
                                                             bindAddress);
 
                if (connectedPhysicalSocket.isValid()) {
                    SocketConnection* socketConnection = new SocketConnection(std::move(connectedPhysicalSocket), onDisconnect, config);
 
                    LOG(DEBUG) << config->getInstanceName() << " accept " << bindAddress.toString() << ": success";
                    LOG(DEBUG) << "  " << socketConnection->getRemoteAddress().toString() << " -> "
                               << socketConnection->getLocalAddress().toString();
 
                    onConnect(socketConnection);
                    onConnected(socketConnection);
                } else if (errno != EINTR && errno != EAGAIN && errno != EWOULDBLOCK) {
                    PLOG(WARNING) << config->getInstanceName() << " accept " << bindAddress.toString();
                }
            } while (--acceptsPerTick > 0);
        }
    }

References bindAddress, config, logger::DEBUG, core::DescriptorEventReceiver::isEnabled(), logger::LogMessage::LogMessage(), onConnect, onConnected, onDisconnect, physicalServerSocket, and logger::WARNING.

Here is the call graph for this function:

◆ destruct()

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

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

finalprotectedvirtual

Reimplemented from core::EventReceiver.

Definition at line 237 of file SocketAcceptor.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 PhysicalSocketServer, typename Config, template< typename ConfigT, typename PhysicalSocketServerT > typename SocketConnection>

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

virtual

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

Definition at line 99 of file SocketAcceptor.hpp.

                                                                              {
        if (!config->getDisabled()) {
            try {
                core::socket::State state = core::socket::STATE_OK;
 
                LOG(DEBUG) << config->getInstanceName() << " Listen: starting";
 
                bindAddress = config->Local::getSocketAddress();
 
                if (physicalServerSocket.open(config->getSocketOptions(), PhysicalServerSocket::Flags::NONBLOCK) < 0) {
                    PLOG(ERROR) << 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;
                    }
                } else {
                    LOG(DEBUG) << config->getInstanceName() << " open " << bindAddress.toString() << ": success";
 
                    if (physicalServerSocket.bind(bindAddress) < 0) {
                        PLOG(ERROR) << config->getInstanceName() << " bind " << bindAddress.toString();
 
                        switch (errno) {
                            case EADDRINUSE:
 
                                state = core::socket::STATE_ERROR;
                                break;
                            default:
 
                                state = core::socket::STATE_FATAL;
                                break;
                        }
                    } else {
                        LOG(DEBUG) << config->getInstanceName() << " bind " << bindAddress.toString() << ": success";
 
                        if (physicalServerSocket.listen(config->getBacklog()) < 0) {
                            PLOG(ERROR) << config->getInstanceName() << " listen " << bindAddress.toString();
 
                            switch (errno) {
                                case EADDRINUSE:
                                    state = core::socket::STATE_ERROR;
                                    break;
                                default:
                                    state = core::socket::STATE_FATAL;
                                    break;
                            }
                        } else {
                            LOG(DEBUG) << config->getInstanceName() << " listen " << bindAddress.toString() << ": success";
 
                            if (enable(physicalServerSocket.getFd())) {
                                LOG(DEBUG) << config->getInstanceName() << " enable " << bindAddress.toString() << ": success";
                            } else {
                                LOG(ERROR) << config->getInstanceName() << " enable " << bindAddress.toString()
                                           << ": failed. No valid descriptor created";
 
                                state = core::socket::STATE(core::socket::STATE_FATAL, ECANCELED, "SocketAcceptor not enabled");
                            }
                        }
                    }
                }
 
                SocketAddress currentLocalAddress = bindAddress;
                if (bindAddress.useNext()) {
                    onStatus(currentLocalAddress, (state | core::socket::State::NO_RETRY));
 
                    LOG(INFO) << config->getInstanceName()
                              << ": Using next SocketAddress: " << config->Local::getSocketAddress().toString();
 
                    useNextSocketAddress();
                } else {
                    onStatus(currentLocalAddress, 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::AcceptEventReceiver::setTimeout(config->getAcceptTimeout());
        } else {
            destruct();
        }
    }

References bindAddress, config, logger::DEBUG, destruct(), core::DescriptorEventReceiver::enable(), logger::ERROR, logger::INFO, core::DescriptorEventReceiver::isEnabled(), logger::LogMessage::LogMessage(), core::socket::State::NO_RETRY, onInitState, onStatus, core::socket::State::operator|(), physicalServerSocket, core::DescriptorEventReceiver::setTimeout(), useNextSocketAddress(), and core::socket::State::what().

Here is the call graph for this function:

◆ unobservedEvent()

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

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

finalprivatevirtual

Implements core::Observer.

Definition at line 230 of file SocketAcceptor.hpp.

                                                                                         {
        destruct();
    }

References destruct().

Here is the call graph for this function:

◆ useNextSocketAddress()

template<typename PhysicalSocketServerT, typename ConfigT, template< typename PhysicalSocketServer, typename Config > 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 init().

Here is the caller graph for this function:

Member Data Documentation

◆ bindAddress

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

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

private

Definition at line 105 of file SocketAcceptor.h.

Referenced by acceptEvent(), and init().

◆ config

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

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

protected

Definition at line 115 of file SocketAcceptor.h.

Referenced by acceptEvent(), destruct(), init(), SocketAcceptor(), and SocketAcceptor().

◆ onConnect

template<typename PhysicalSocketServerT, typename ConfigT, template< typename PhysicalSocketServer, typename Config > 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 acceptEvent(), SocketAcceptor(), and SocketAcceptor().

◆ onConnected

template<typename PhysicalSocketServerT, typename ConfigT, template< typename PhysicalSocketServer, typename Config > 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 acceptEvent(), SocketAcceptor(), and SocketAcceptor().

◆ onDisconnect

template<typename PhysicalSocketServerT, typename ConfigT, template< typename PhysicalSocketServer, typename Config > 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 acceptEvent(), SocketAcceptor(), and SocketAcceptor().

◆ onInitState

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

std::function<void(core::eventreceiver::AcceptEventReceiver*)> core::socket::stream::SocketAcceptor< PhysicalSocketServerT, ConfigT, SocketConnectionT >::onInitState

protected

Definition at line 111 of file SocketAcceptor.h.

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

◆ onStatus

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

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

protected

Definition at line 113 of file SocketAcceptor.h.

Referenced by init(), SocketAcceptor(), and SocketAcceptor().

◆ physicalServerSocket

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

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

private

Definition at line 104 of file SocketAcceptor.h.

Referenced by acceptEvent(), and init().

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

core/socket/stream/SocketAcceptor.h
core/socket/stream/SocketAcceptor.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

◆ PhysicalServerSocket

◆ SocketAddress

◆ SocketConnection

Constructor & Destructor Documentation

◆ SocketAcceptor() [1/2]

◆ SocketAcceptor() [2/2]

◆ ~SocketAcceptor()

Member Function Documentation

◆ acceptEvent()

◆ destruct()

◆ init()

◆ unobservedEvent()

◆ useNextSocketAddress()

Member Data Documentation

◆ bindAddress

◆ config

◆ onConnect

◆ onConnected

◆ onDisconnect

◆ onInitState

◆ onStatus

◆ physicalServerSocket