#include <SocketReader.h>

Inheritance diagram for core::socket::stream::SocketReader:

Collaboration diagram for core::socket::stream::SocketReader:

Public Member Functions
	SocketReader ()=delete
Public Member Functions inherited from core::DescriptorEventReceiver
	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)
Public Member Functions inherited from core::EventReceiver
	EventReceiver (const std::string &name)
	EventReceiver (EventReceiver &)=delete
	EventReceiver (EventReceiver &&)=delete
EventReceiver &	operator= (EventReceiver &)=delete
EventReceiver &	operator= (EventReceiver &&)=delete
virtual void	destruct ()
void	span ()
void	relax ()
const std::string &	getName () const

Protected Member Functions
	SocketReader (const std::string &instanceName, const std::function< void(int)> &onStatus, const utils::Timeval &timeout, std::size_t blockSize, const utils::Timeval &terminateTimeout)
std::size_t	getTotalRead () const
std::size_t	getTotalProcessed () const
virtual ssize_t	read (char *chunk, std::size_t chunkLen)
void	setBlockSize (std::size_t readBlockSize)
std::size_t	readFromPeer (char *chunk, std::size_t chunkLen)
void	shutdownRead ()
Protected Member Functions inherited from core::eventreceiver::ReadEventReceiver
	ReadEventReceiver (const std::string &name, const utils::Timeval &timeout)
virtual void	readTimeout ()
Protected Member Functions inherited from core::DescriptorEventReceiver
bool	enable (int fd)
void	disable ()
void	suspend ()
void	resume ()
Protected Member Functions inherited from core::Observer
void	observed ()
void	unObserved ()
virtual void	unobservedEvent ()=0
	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
virtual void	destruct ()
void	span ()
void	relax ()
const std::string &	getName () const

Protected Attributes
utils::Timeval	terminateTimeout

Private Member Functions
virtual void	onReceivedFromPeer (std::size_t available)=0
void	readEvent () final
std::size_t	doRead ()
void	signalEvent (int sigNum) final

Private Attributes
std::function< void(int)>	onStatus
std::vector< char >	readBuffer
std::size_t	blockSize = 0
std::size_t	totalRead = 0
std::size_t	totalProcessed = 0
std::size_t	size = 0
std::size_t	cursor = 0
bool	shutdownInProgress = false

Additional Inherited Members
Static Public Member Functions inherited from core::EventReceiver
static void	atNextTick (const std::function< void(void)> &callBack)
Static Protected Member Functions inherited from core::EventReceiver
static void	atNextTick (const std::function< void(void)> &callBack)

Detailed Description

Definition at line 61 of file SocketReader.h.

Constructor & Destructor Documentation

◆ SocketReader() [1/2]

core::socket::stream::SocketReader::SocketReader ( )

delete

◆ SocketReader() [2/2]

core::socket::stream::SocketReader::SocketReader	(	const std::string &	instanceName,
		const std::function< void(int)> &	onStatus,
		const utils::Timeval &	timeout,
		std::size_t	blockSize,
		const utils::Timeval &	terminateTimeout )

explicitprotected

Definition at line 55 of file SocketReader.cpp.

        : core::eventreceiver::ReadEventReceiver(instanceName, timeout)
        , onStatus(onStatus)
        , terminateTimeout(terminateTimeout) {
        setBlockSize(blockSize);
    }

References onStatus, core::eventreceiver::ReadEventReceiver::ReadEventReceiver(), setBlockSize(), terminateTimeout, and utils::Timeval::Timeval().

Here is the call graph for this function:

Member Function Documentation

◆ doRead()

std::size_t core::socket::stream::SocketReader::doRead ( )

private

Definition at line 89 of file SocketReader.cpp.

                                   {
        errno = 0;
 
        if (size == 0) {
            cursor = 0;
 
            ssize_t retRead = 0;
            if (!shutdownInProgress) {
                const std::size_t readLen = blockSize - size;
                retRead = read(readBuffer.data() + size, readLen);
            }
            if (retRead > 0) {
                totalRead += static_cast<std::size_t>(retRead);
 
                size += static_cast<std::size_t>(retRead);
 
                if (!isSuspended()) {
                    suspend();
                }
                span();
            } else if (errno == EAGAIN || errno == EWOULDBLOCK || errno == EINTR) {
                if (isSuspended()) {
                    resume();
                }
            } else {
                onStatus(errno);
            }
        } else {
            span();
        }
 
        return size;
    }

References blockSize, cursor, core::DescriptorEventReceiver::isSuspended(), onStatus, read(), readBuffer, core::DescriptorEventReceiver::resume(), shutdownInProgress, size, core::EventReceiver::span(), core::DescriptorEventReceiver::suspend(), and totalRead.

Referenced by readEvent().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getTotalProcessed()

std::size_t core::socket::stream::SocketReader::getTotalProcessed ( ) const

protected

Definition at line 70 of file SocketReader.cpp.

                                                    {
        return totalProcessed;
    }

References totalProcessed.

◆ getTotalRead()

std::size_t core::socket::stream::SocketReader::getTotalRead ( ) const

protected

Definition at line 66 of file SocketReader.cpp.

                                               {
        return totalRead;
    }

References totalRead.

◆ onReceivedFromPeer()

virtual void core::socket::stream::SocketReader::onReceivedFromPeer ( std::size_t available )

privatepure virtual

Implemented in core::socket::stream::SocketConnectionT< PhysicalSocketT, core::socket::stream::legacy::SocketReader, core::socket::stream::legacy::SocketWriter, ConfigT >, and core::socket::stream::SocketConnectionT< PhysicalSocketT, core::socket::stream::tls::SocketReader, core::socket::stream::tls::SocketWriter, ConfigT >.

Referenced by readEvent().

Here is the caller graph for this function:

◆ read()

ssize_t core::socket::stream::SocketReader::read	(	char *	chunk,
		std::size_t	chunkLen )

protectedvirtual

Reimplemented in core::socket::stream::tls::SocketReader.

Definition at line 85 of file SocketReader.cpp.

                                                              {
        return core::system::recv(this->getRegisteredFd(), chunk, chunkLen, 0);
    }

References core::DescriptorEventReceiver::getRegisteredFd(), and core::system::recv().

Referenced by doRead(), and core::socket::stream::tls::SocketReader::read().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readEvent()

void core::socket::stream::SocketReader::readEvent ( )

finalprivatevirtual

Implements core::eventreceiver::ReadEventReceiver.

Definition at line 74 of file SocketReader.cpp.

                                 {
        const std::size_t available = doRead();
 
        if (available > 0) {
            onReceivedFromPeer(available);
        }
    }

References doRead(), and onReceivedFromPeer().

Here is the call graph for this function:

◆ readFromPeer()

std::size_t core::socket::stream::SocketReader::readFromPeer	(	char *	chunk,
		std::size_t	chunkLen )

protected

Definition at line 128 of file SocketReader.cpp.

                                                                        {
        const std::size_t maxReturn = std::min(chunkLen, size);
 
        std::copy(readBuffer.data() + cursor, readBuffer.data() + cursor + maxReturn, chunk);
 
        cursor += maxReturn;
        size -= maxReturn;
        totalProcessed += maxReturn;
 
        return maxReturn;
    }

References cursor, readBuffer, size, and totalProcessed.

◆ setBlockSize()

void core::socket::stream::SocketReader::setBlockSize ( std::size_t readBlockSize )

protected

Definition at line 123 of file SocketReader.cpp.

                                                           {
        readBuffer.resize(readBlockSize);
        blockSize = readBlockSize;
    }

References blockSize, and readBuffer.

Referenced by SocketReader().

Here is the caller graph for this function:

◆ shutdownRead()

void core::socket::stream::SocketReader::shutdownRead ( )

protected

Definition at line 140 of file SocketReader.cpp.

                                    {
        readBuffer.clear();
 
        size = 0;
        cursor = 0;
 
        shutdownInProgress = true;
 
        setTimeout(terminateTimeout);
    }

References cursor, readBuffer, core::DescriptorEventReceiver::setTimeout(), shutdownInProgress, size, and terminateTimeout.

Here is the call graph for this function:

◆ signalEvent()

void core::socket::stream::SocketReader::signalEvent ( int sigNum )

finalprivatevirtual

Reimplemented from core::eventreceiver::ReadEventReceiver.

Definition at line 82 of file SocketReader.cpp.

82 { // Do nothing in case a signal was received

83 }

Member Data Documentation

◆ blockSize

std::size_t core::socket::stream::SocketReader::blockSize = 0

private

Definition at line 96 of file SocketReader.h.

Referenced by doRead(), and setBlockSize().

◆ cursor

std::size_t core::socket::stream::SocketReader::cursor = 0

private

Definition at line 102 of file SocketReader.h.

Referenced by doRead(), readFromPeer(), and shutdownRead().

◆ onStatus

std::function<void(int)> core::socket::stream::SocketReader::onStatus

private

Definition at line 93 of file SocketReader.h.

Referenced by doRead(), and SocketReader().

◆ readBuffer

std::vector<char> core::socket::stream::SocketReader::readBuffer

private

Definition at line 95 of file SocketReader.h.

Referenced by doRead(), readFromPeer(), setBlockSize(), and shutdownRead().

◆ shutdownInProgress

bool core::socket::stream::SocketReader::shutdownInProgress = false

private

Definition at line 104 of file SocketReader.h.

Referenced by doRead(), and shutdownRead().

◆ size

std::size_t core::socket::stream::SocketReader::size = 0

private

Definition at line 101 of file SocketReader.h.

Referenced by doRead(), readFromPeer(), and shutdownRead().

◆ terminateTimeout

utils::Timeval core::socket::stream::SocketReader::terminateTimeout

protected

Definition at line 107 of file SocketReader.h.

Referenced by shutdownRead(), and SocketReader().

◆ totalProcessed

std::size_t core::socket::stream::SocketReader::totalProcessed = 0

private

Definition at line 99 of file SocketReader.h.

Referenced by getTotalProcessed(), and readFromPeer().

◆ totalRead

std::size_t core::socket::stream::SocketReader::totalRead = 0

private

Definition at line 98 of file SocketReader.h.

Referenced by doRead(), and getTotalRead().

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

core/socket/stream/SocketReader.h
core/socket/stream/SocketReader.cpp

SNode.C

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SocketReader() [1/2]

◆ SocketReader() [2/2]

Member Function Documentation

◆ doRead()

◆ getTotalProcessed()

◆ getTotalRead()

◆ onReceivedFromPeer()

◆ read()

◆ readEvent()

◆ readFromPeer()

◆ setBlockSize()

◆ shutdownRead()

◆ signalEvent()

Member Data Documentation

◆ blockSize

◆ cursor

◆ onStatus

◆ readBuffer

◆ shutdownInProgress

◆ size

◆ terminateTimeout

◆ totalProcessed

◆ totalRead