#include <SocketConnection.h>

Inheritance diagram for core::socket::stream::SocketConnectionT< PhysicalSocketT, SocketReaderT, SocketWriterT >:

Collaboration diagram for core::socket::stream::SocketConnectionT< PhysicalSocketT, SocketReaderT, SocketWriterT >:

Public Member Functions
	SocketConnectionT ()=delete

int	getFd () const final

void	setTimeout (const utils::Timeval &timeout) final

const SocketAddress &	getLocalAddress () const final

const SocketAddress &	getRemoteAddress () const final

std::size_t	readFromPeer (char *chunk, std::size_t chunkLen) final

void	sendToPeer (const char *chunk, std::size_t chunkLen) final

bool	streamToPeer (core::pipe::Source *source) final

void	streamEof () final

void	shutdownRead () final

void	shutdownWrite (bool forceClose) final

void	close () final

void	sendToPeer (const std::string &data)

Public Member Functions inherited from core::socket::stream::SocketConnection
	SocketConnection (const std::string &instanceName, int fd, const std::string &configuredServer)

void	switchSocketContext (SocketContext *newSocketContext)

void	sendToPeer (const std::string &data)

void	sentToPeer (const std::vector< uint8_t > &data)

void	sentToPeer (const std::vector< char > &data)

const std::string &	getInstanceName () const

const std::string &	getConnectionName () const

const std::string &	getConfiguredServer () const

Protected Types
using	Super = core::socket::stream::SocketConnection

using	PhysicalSocket = PhysicalSocketT

using	SocketReader = SocketReaderT

using	SocketWriter = SocketWriterT

using	SocketAddress = typename PhysicalSocket::SocketAddress

Protected Member Functions
	SocketConnectionT (const std::string &instanceName, PhysicalSocket &&physicalSocket, const std::function< void()> &onDisconnect, const std::string &configuredServer, const SocketAddress &localAddress, const SocketAddress &remoteAddress, const utils::Timeval &readTimeout, const utils::Timeval &writeTimeout, std::size_t readBlockSize, std::size_t writeBlockSize, const utils::Timeval &terminateTimeout)

	~SocketConnectionT () override

void	doWriteShutdown (const std::function< void()> &onShutdown) override

void	onWriteError (int errnum)

void	onReadError (int errnum)

Protected Member Functions inherited from core::socket::stream::SocketConnection
virtual	~SocketConnection ()

void	setSocketContext (SocketContext *socketContext)

void	connectSocketContext (const std::shared_ptr< SocketContextFactory > &socketContextFactory)

void	disconnectCurrentSocketContext ()

Private Member Functions
void	onReceivedFromPeer (std::size_t available) final

bool	onSignal (int signum) final

void	readTimeout () final

void	writeTimeout () final

void	unobservedEvent () final

Private Attributes
PhysicalSocket	physicalSocket

std::function< void()>	onDisconnect

SocketAddress	localAddress {}

SocketAddress	remoteAddress {}

Additional Inherited Members
Protected Attributes inherited from core::socket::stream::SocketConnection
core::socket::stream::SocketContext *	socketContext = nullptr

core::socket::stream::SocketContext *	newSocketContext = nullptr

std::string	instanceName

std::string	connectionName

std::string	configuredServer

Detailed Description

template<typename PhysicalSocketT, typename SocketReaderT, typename SocketWriterT>
class core::socket::stream::SocketConnectionT< PhysicalSocketT, SocketReaderT, SocketWriterT >

Definition at line 107 of file SocketConnection.h.

Member Typedef Documentation

◆ PhysicalSocket

template<typename PhysicalSocketT , typename SocketReaderT , typename SocketWriterT >

using core::socket::stream::SocketConnectionT< PhysicalSocketT, SocketReaderT, SocketWriterT >::PhysicalSocket = PhysicalSocketT

protected

Definition at line 114 of file SocketConnection.h.

◆ SocketAddress

template<typename PhysicalSocketT , typename SocketReaderT , typename SocketWriterT >

using core::socket::stream::SocketConnectionT< PhysicalSocketT, SocketReaderT, SocketWriterT >::SocketAddress = typename PhysicalSocket::SocketAddress

protected

Definition at line 117 of file SocketConnection.h.

◆ SocketReader

template<typename PhysicalSocketT , typename SocketReaderT , typename SocketWriterT >

using core::socket::stream::SocketConnectionT< PhysicalSocketT, SocketReaderT, SocketWriterT >::SocketReader = SocketReaderT

protected

Definition at line 115 of file SocketConnection.h.

◆ SocketWriter

template<typename PhysicalSocketT , typename SocketReaderT , typename SocketWriterT >

using core::socket::stream::SocketConnectionT< PhysicalSocketT, SocketReaderT, SocketWriterT >::SocketWriter = SocketWriterT

protected

Definition at line 116 of file SocketConnection.h.

◆ Super

template<typename PhysicalSocketT , typename SocketReaderT , typename SocketWriterT >

using core::socket::stream::SocketConnectionT< PhysicalSocketT, SocketReaderT, SocketWriterT >::Super = core::socket::stream::SocketConnection

protected

Definition at line 112 of file SocketConnection.h.

Constructor & Destructor Documentation

◆ SocketConnectionT() [1/2]

template<typename PhysicalSocketT , typename SocketReaderT , typename SocketWriterT >

core::socket::stream::SocketConnectionT< PhysicalSocketT, SocketReaderT, SocketWriterT >::SocketConnectionT ( )

delete

◆ SocketConnectionT() [2/2]

template<typename PhysicalSocket , typename SocketReader , typename SocketWriter >

core::socket::stream::SocketConnectionT< PhysicalSocket, SocketReader, SocketWriter >::SocketConnectionT	(	const std::string &	instanceName,
		PhysicalSocket &&	physicalSocket,
		const std::function< void()> &	onDisconnect,
		const std::string &	configuredServer,
		const SocketAddress &	localAddress,
		const SocketAddress &	remoteAddress,
		const utils::Timeval &	readTimeout,
		const utils::Timeval &	writeTimeout,
		std::size_t	readBlockSize,
		std::size_t	writeBlockSize,
		const utils::Timeval &	terminateTimeout )

protected

Definition at line 37 of file SocketConnection.hpp.

        : SocketConnection(instanceName, physicalSocket.getFd(), configuredServer)
        , SocketReader(
              instanceName + " [" + std::to_string(physicalSocket.getFd()) + "]",
              [this](int errnum) {
                  {
                      const utils::PreserveErrno pe(errnum);
                      if (errno == 0) {
                          LOG(TRACE) << connectionName << " OnReadError: EOF received";
                      } else {
                          PLOG(TRACE) << connectionName << " OnReadError";
                      }
                  }
                  SocketReader::disable();
 
                  onReadError(errnum);
              },
              readTimeout,
              readBlockSize,
              terminateTimeout)
        , SocketWriter(
              instanceName + " [" + std::to_string(physicalSocket.getFd()) + "]",
              [this](int errnum) {
                  {
                      const utils::PreserveErrno pe(errnum);
                      PLOG(TRACE) << connectionName << " OnWriteError";
                  }
                  SocketWriter::disable();
 
                  onWriteError(errnum);
              },
              writeTimeout,
              writeBlockSize,
              terminateTimeout)
        , physicalSocket(std::move(physicalSocket))
        , onDisconnect(onDisconnect)
        , localAddress(localAddress)
        , remoteAddress(remoteAddress) {
        if (!SocketReader::enable(this->physicalSocket.getFd())) {
            delete this;
        } else if (!SocketWriter::enable(this->physicalSocket.getFd())) {
            delete this;
        } else {
            SocketWriter::suspend();
        }
    }

◆ ~SocketConnectionT()

template<typename PhysicalSocket , typename SocketReader , typename SocketWriter >

core::socket::stream::SocketConnectionT< PhysicalSocket, SocketReader, SocketWriter >::~SocketConnectionT ( )

overrideprotected

Definition at line 95 of file SocketConnection.hpp.

95 {

96 }

Member Function Documentation

◆ close()

template<typename PhysicalSocket , typename SocketReader , typename SocketWriter >

void core::socket::stream::SocketConnectionT< PhysicalSocket, SocketReader, SocketWriter >::close ( )

finalvirtual

Implements core::socket::stream::SocketConnection.

Definition at line 179 of file SocketConnection.hpp.

                                                                              {
        if (SocketWriter::isEnabled()) {
            SocketWriter::disable();
        }
        if (SocketReader::isEnabled()) {
            SocketReader::disable();
        }
    }

Referenced by core::socket::stream::SocketConnectionT< PhysicalSocketT, SocketReaderT, SocketWriterT >::onReceivedFromPeer(), core::socket::stream::SocketConnectionT< PhysicalSocketT, SocketReaderT, SocketWriterT >::readTimeout(), core::socket::stream::SocketConnectionT< PhysicalSocketT, SocketReaderT, SocketWriterT >::shutdownWrite(), and core::socket::stream::SocketConnectionT< PhysicalSocketT, SocketReaderT, SocketWriterT >::writeTimeout().

Here is the caller graph for this function:

◆ doWriteShutdown()

template<typename PhysicalSocket , typename SocketReader , typename SocketWriter >

void core::socket::stream::SocketConnectionT< PhysicalSocket, SocketReader, SocketWriter >::doWriteShutdown ( const std::function< void()> & onShutdown )

overrideprotected

Definition at line 189 of file SocketConnection.hpp.

                                                                                                                             {
        errno = 0;
 
        setTimeout(SocketWriter::terminateTimeout);
 
        LOG(TRACE) << connectionName << ": Shutdown (WR)";
 
        if (physicalSocket.shutdown(PhysicalSocket::SHUT::WR) == 0) {
            LOG(DEBUG) << connectionName << " Shutdown (WR): success";
        } else {
            PLOG(ERROR) << connectionName << " Shutdown (WR)";
        }
 
        onShutdown();
    }

References core::socket::stream::SocketConnectionT< PhysicalSocketT, SocketReaderT, SocketWriterT >::physicalSocket, and core::socket::stream::SocketConnectionT< PhysicalSocketT, SocketReaderT, SocketWriterT >::setTimeout().

Here is the call graph for this function:

◆ getFd()

template<typename PhysicalSocket , typename SocketReader , typename SocketWriter >

int core::socket::stream::SocketConnectionT< PhysicalSocket, SocketReader, SocketWriter >::getFd ( ) const

finalvirtual

Implements core::socket::stream::SocketConnection.

Definition at line 105 of file SocketConnection.hpp.

                                                                                   {
        return physicalSocket.getFd();
    }

References core::socket::stream::SocketConnectionT< PhysicalSocketT, SocketReaderT, SocketWriterT >::physicalSocket.

◆ getLocalAddress()

template<typename PhysicalSocket , typename SocketReader , typename SocketWriter >

const SocketConnectionT< PhysicalSocket, SocketReader, SocketWriter >::SocketAddress & core::socket::stream::SocketConnectionT< PhysicalSocket, SocketReader, SocketWriter >::getLocalAddress ( ) const

finalvirtual

Implements core::socket::stream::SocketConnection.

Definition at line 111 of file SocketConnection.hpp.

                                                                                         {
        return localAddress;
    }

References core::socket::stream::SocketConnectionT< PhysicalSocketT, SocketReaderT, SocketWriterT >::localAddress.

◆ getRemoteAddress()

template<typename PhysicalSocket , typename SocketReader , typename SocketWriter >

const SocketConnectionT< PhysicalSocket, SocketReader, SocketWriter >::SocketAddress & core::socket::stream::SocketConnectionT< PhysicalSocket, SocketReader, SocketWriter >::getRemoteAddress ( ) const

finalvirtual

Implements core::socket::stream::SocketConnection.

Definition at line 117 of file SocketConnection.hpp.

                                                                                          {
        return remoteAddress;
    }

References core::socket::stream::SocketConnectionT< PhysicalSocketT, SocketReaderT, SocketWriterT >::remoteAddress.

◆ onReadError()

template<typename PhysicalSocket , typename SocketReader , typename SocketWriter >

void core::socket::stream::SocketConnectionT< PhysicalSocket, SocketReader, SocketWriter >::onReadError ( int errnum )

protected

Definition at line 229 of file SocketConnection.hpp.

                                                                                              {
        socketContext->onReadError(errnum);
    }

◆ onReceivedFromPeer()

template<typename PhysicalSocket , typename SocketReader , typename SocketWriter >

void core::socket::stream::SocketConnectionT< PhysicalSocket, SocketReader, SocketWriter >::onReceivedFromPeer ( std::size_t available )

finalprivate

Definition at line 206 of file SocketConnection.hpp.

                                                                                                              {
        std::size_t consumed = socketContext->onReceivedFromPeer();
 
        if (available != 0 && consumed == 0) {
            LOG(TRACE) << connectionName << ": Data available: " << available << " but nothing read";
 
            close();
 
            delete newSocketContext; // delete of nullptr is valid since C++14!
            newSocketContext = nullptr;
        } else if (newSocketContext != nullptr) { // Perform a pending SocketContextSwitch
            disconnectCurrentSocketContext();
            setSocketContext(newSocketContext);
            newSocketContext = nullptr;
        }
    }

References core::socket::stream::SocketConnectionT< PhysicalSocketT, SocketReaderT, SocketWriterT >::close(), and core::socket::stream::SocketConnection::disconnectCurrentSocketContext().

Here is the call graph for this function:

◆ onSignal()

template<typename PhysicalSocket , typename SocketReader , typename SocketWriter >

bool core::socket::stream::SocketConnectionT< PhysicalSocket, SocketReader, SocketWriter >::onSignal ( int signum )

finalprivate

Definition at line 234 of file SocketConnection.hpp.

                                                                                           {
        switch (signum) {
            case SIGINT:
                [[fallthrough]];
            case SIGTERM:
                [[fallthrough]];
            case SIGABRT:
                [[fallthrough]];
            case SIGHUP:
                LOG(DEBUG) << connectionName << ": Shutting down due to signal '" << strsignal(signum) << "' (SIG"
                           << utils::system::sigabbrev_np(signum) << " [" << signum << "])";
                break;
            case SIGALRM:
                break;
        }
 
        return socketContext != nullptr ? socketContext->onSignal(signum) : true;
    }

◆ onWriteError()

template<typename PhysicalSocket , typename SocketReader , typename SocketWriter >

void core::socket::stream::SocketConnectionT< PhysicalSocket, SocketReader, SocketWriter >::onWriteError ( int errnum )

protected

Definition at line 224 of file SocketConnection.hpp.

                                                                                               {
        socketContext->onWriteError(errnum);
    }

◆ readFromPeer()

template<typename PhysicalSocket , typename SocketReader , typename SocketWriter >

std::size_t core::socket::stream::SocketConnectionT< PhysicalSocket, SocketReader, SocketWriter >::readFromPeer	(	char *	chunk,
		std::size_t	chunkLen )

finalvirtual

Implements core::socket::stream::SocketConnection.

Definition at line 122 of file SocketConnection.hpp.

                                                                                                                         {
        std::size_t ret = 0;
 
        if (newSocketContext == nullptr) {
            ret = SocketReader::readFromPeer(chunk, chunkLen);
        } else {
            LOG(TRACE) << connectionName << " ReadFromPeer: New SocketContext != nullptr: SocketContextSwitch still in progress";
        }
 
        return ret;
    }

◆ readTimeout()

template<typename PhysicalSocket , typename SocketReader , typename SocketWriter >

void core::socket::stream::SocketConnectionT< PhysicalSocket, SocketReader, SocketWriter >::readTimeout ( )

finalprivate

Definition at line 254 of file SocketConnection.hpp.

                                                                                    {
        LOG(WARNING) << connectionName << ": Read timeout";
        close();
    }

References core::socket::stream::SocketConnectionT< PhysicalSocketT, SocketReaderT, SocketWriterT >::close().

Here is the call graph for this function:

◆ sendToPeer() [1/2]

template<typename PhysicalSocket , typename SocketReader , typename SocketWriter >

void core::socket::stream::SocketConnectionT< PhysicalSocket, SocketReader, SocketWriter >::sendToPeer	(	const char *	chunk,
		std::size_t	chunkLen )

finalvirtual

Implements core::socket::stream::SocketConnection.

Definition at line 135 of file SocketConnection.hpp.

                                                                                                                        {
        SocketWriter::sendToPeer(chunk, chunkLen);
    }

◆ sendToPeer() [2/2]

template<typename PhysicalSocketT , typename SocketReaderT , typename SocketWriterT >

void core::socket::stream::SocketConnection::sendToPeer ( const std::string & data )

Definition at line 68 of file SocketConnection.cpp.

                                                           {
        sendToPeer(data.data(), data.size());
    }

◆ setTimeout()

template<typename PhysicalSocket , typename SocketReader , typename SocketWriter >

void core::socket::stream::SocketConnectionT< PhysicalSocket, SocketReader, SocketWriter >::setTimeout ( const utils::Timeval & timeout )

finalvirtual

Implements core::socket::stream::SocketConnection.

Definition at line 99 of file SocketConnection.hpp.

                                                                                                              {
        SocketReader::setTimeout(timeout);
        SocketWriter::setTimeout(timeout);
    }

Referenced by core::socket::stream::SocketConnectionT< PhysicalSocketT, SocketReaderT, SocketWriterT >::doWriteShutdown().

Here is the caller graph for this function:

◆ shutdownRead()

template<typename PhysicalSocket , typename SocketReader , typename SocketWriter >

void core::socket::stream::SocketConnectionT< PhysicalSocket, SocketReader, SocketWriter >::shutdownRead ( )

finalvirtual

Implements core::socket::stream::SocketConnection.

Definition at line 150 of file SocketConnection.hpp.

                                                                                     {
        LOG(TRACE) << connectionName << ": Shutdown (RD)";
 
        SocketReader::shutdownRead();
 
        if (physicalSocket.shutdown(PhysicalSocket::SHUT::RD) == 0) {
            LOG(DEBUG) << connectionName << " Shutdown (RD): success";
        } else {
            PLOG(ERROR) << connectionName << " Shutdown (RD)";
        }
    }

References core::socket::stream::SocketConnectionT< PhysicalSocketT, SocketReaderT, SocketWriterT >::physicalSocket.

◆ shutdownWrite()

template<typename PhysicalSocket , typename SocketReader , typename SocketWriter >

void core::socket::stream::SocketConnectionT< PhysicalSocket, SocketReader, SocketWriter >::shutdownWrite ( bool forceClose )

finalvirtual

Implements core::socket::stream::SocketConnection.

Definition at line 163 of file SocketConnection.hpp.

                                                                                                     {
        if (!SocketWriter::shutdownInProgress) {
            LOG(TRACE) << connectionName << ": Stop writing";
 
            SocketWriter::shutdownWrite([forceClose, this]() {
                if (SocketWriter::isEnabled()) {
                    SocketWriter::disable();
                }
                if (forceClose && SocketReader::isEnabled()) {
                    close();
                }
            });
        }
    }

References core::socket::stream::SocketConnectionT< PhysicalSocketT, SocketReaderT, SocketWriterT >::close().

Here is the call graph for this function:

◆ streamEof()

template<typename PhysicalSocket , typename SocketReader , typename SocketWriter >

void core::socket::stream::SocketConnectionT< PhysicalSocket, SocketReader, SocketWriter >::streamEof ( )

finalvirtual

Implements core::socket::stream::SocketConnection.

Definition at line 145 of file SocketConnection.hpp.

                                                                                  {
        SocketWriter::streamEof();
    }

◆ streamToPeer()

template<typename PhysicalSocket , typename SocketReader , typename SocketWriter >

bool core::socket::stream::SocketConnectionT< PhysicalSocket, SocketReader, SocketWriter >::streamToPeer ( core::pipe::Source * source )

finalvirtual

Implements core::socket::stream::SocketConnection.

Definition at line 140 of file SocketConnection.hpp.

                                                                                                           {
        return SocketWriter::streamToPeer(source);
    }

◆ unobservedEvent()

template<typename PhysicalSocket , typename SocketReader , typename SocketWriter >

void core::socket::stream::SocketConnectionT< PhysicalSocket, SocketReader, SocketWriter >::unobservedEvent ( )

finalprivate

Definition at line 266 of file SocketConnection.hpp.

                                                                                        {
        disconnectCurrentSocketContext();
 
        onDisconnect();
 
        delete this;
    }

References core::socket::stream::SocketConnection::disconnectCurrentSocketContext().

Here is the call graph for this function:

◆ writeTimeout()

template<typename PhysicalSocket , typename SocketReader , typename SocketWriter >

void core::socket::stream::SocketConnectionT< PhysicalSocket, SocketReader, SocketWriter >::writeTimeout ( )

finalprivate

Definition at line 260 of file SocketConnection.hpp.

                                                                                     {
        LOG(WARNING) << connectionName << ": Write timeout";
        close();
    }

References core::socket::stream::SocketConnectionT< PhysicalSocketT, SocketReaderT, SocketWriterT >::close().

Here is the call graph for this function:

Member Data Documentation

◆ localAddress

template<typename PhysicalSocketT , typename SocketReaderT , typename SocketWriterT >

SocketAddress core::socket::stream::SocketConnectionT< PhysicalSocketT, SocketReaderT, SocketWriterT >::localAddress {}

private

Definition at line 177 of file SocketConnection.h.

177{};

Referenced by core::socket::stream::SocketConnectionT< PhysicalSocketT, SocketReaderT, SocketWriterT >::getLocalAddress().

◆ onDisconnect

template<typename PhysicalSocketT , typename SocketReaderT , typename SocketWriterT >

std::function<void()> core::socket::stream::SocketConnectionT< PhysicalSocketT, SocketReaderT, SocketWriterT >::onDisconnect

private

Definition at line 175 of file SocketConnection.h.

◆ physicalSocket

template<typename PhysicalSocketT , typename SocketReaderT , typename SocketWriterT >

PhysicalSocket core::socket::stream::SocketConnectionT< PhysicalSocketT, SocketReaderT, SocketWriterT >::physicalSocket

private

Definition at line 173 of file SocketConnection.h.

Referenced by core::socket::stream::SocketConnectionT< PhysicalSocketT, SocketReaderT, SocketWriterT >::doWriteShutdown(), core::socket::stream::SocketConnectionT< PhysicalSocketT, SocketReaderT, SocketWriterT >::getFd(), and core::socket::stream::SocketConnectionT< PhysicalSocketT, SocketReaderT, SocketWriterT >::shutdownRead().

◆ remoteAddress

template<typename PhysicalSocketT , typename SocketReaderT , typename SocketWriterT >

SocketAddress core::socket::stream::SocketConnectionT< PhysicalSocketT, SocketReaderT, SocketWriterT >::remoteAddress {}

private

Definition at line 178 of file SocketConnection.h.

178{};

Referenced by core::socket::stream::SocketConnectionT< PhysicalSocketT, SocketReaderT, SocketWriterT >::getRemoteAddress().

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

core/socket/stream/SocketConnection.h
core/socket/stream/SocketConnection.hpp

Public Member Functions

Protected Types

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ PhysicalSocket

◆ SocketAddress

◆ SocketReader

◆ SocketWriter

◆ Super

Constructor & Destructor Documentation

◆ SocketConnectionT() [1/2]

◆ SocketConnectionT() [2/2]

◆ ~SocketConnectionT()

Member Function Documentation

◆ close()

◆ doWriteShutdown()

◆ getFd()

◆ getLocalAddress()

◆ getRemoteAddress()

◆ onReadError()

◆ onReceivedFromPeer()

◆ onSignal()

◆ onWriteError()

◆ readFromPeer()

◆ readTimeout()

◆ sendToPeer() [1/2]

◆ sendToPeer() [2/2]

◆ setTimeout()

◆ shutdownRead()

◆ shutdownWrite()

◆ streamEof()

◆ streamToPeer()

◆ unobservedEvent()

◆ writeTimeout()

Member Data Documentation

◆ localAddress

◆ onDisconnect

◆ physicalSocket

◆ remoteAddress