core::pipe::PipeSink Class Reference

#include <PipeSink.h>

Inheritance diagram for core::pipe::PipeSink:

Collaboration diagram for core::pipe::PipeSink:

Public Member Functions
	PipeSink (const PipeSink &)=delete
PipeSink &	operator= (const PipeSink &)=delete
	PipeSink (int fd)
	~PipeSink () override
void	setOnData (const std::function< void(const char *, std::size_t)> &onData)
void	setOnEof (const std::function< void()> &onEof)
void	setOnError (const std::function< void(int)> &onError)
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

Private Member Functions
void	readEvent () override
void	unobservedEvent () override

Private Attributes
std::function< void(const char *, std::size_t)>	onData
std::function< void()>	onEof
std::function< void(int errnum)>	onError

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

Detailed Description

Definition at line 34 of file PipeSink.h.

Constructor & Destructor Documentation

PipeSink() [1/2]

core::pipe::PipeSink::PipeSink ( const PipeSink & )

delete

PipeSink() [2/2]

core::pipe::PipeSink::PipeSink ( int fd )

explicit

Definition at line 38 of file PipeSink.cpp.

        : core::eventreceiver::ReadEventReceiver("PipeSink fd = " + std::to_string(fd), 60) {
        if (!ReadEventReceiver::enable(fd)) {
            delete this;
        }
    }

References core::DescriptorEventReceiver::enable(), and PipeSink().

Referenced by core::pipe::Pipe::Pipe(), and PipeSink().

Here is the call graph for this function:

Here is the caller graph for this function:

~PipeSink()

core::pipe::PipeSink::~PipeSink ( )

override

Definition at line 45 of file PipeSink.cpp.

                        {
        close(getRegisteredFd());
    }

References core::DescriptorEventReceiver::getRegisteredFd().

Here is the call graph for this function:

Member Function Documentation

operator=()

PipeSink & core::pipe::PipeSink::operator= ( const PipeSink & )

delete

readEvent()

void core::pipe::PipeSink::readEvent ( )

overrideprivatevirtual

Implements core::eventreceiver::ReadEventReceiver.

Definition at line 49 of file PipeSink.cpp.

                             {
        // NOLINTNEXTLINE(cppcoreguidelines-avoid-c-arrays, hicpp-avoid-c-arrays, modernize-avoid-c-arrays)
        static char chunk[MAX_READ_JUNKSIZE];
 
        const ssize_t ret = core::system::read(getRegisteredFd(), chunk, MAX_READ_JUNKSIZE);
 
        if (ret > 0) {
            if (onData) {
                onData(chunk, static_cast<std::size_t>(ret));
            }
        } else {
            ReadEventReceiver::disable();
 
            if (ret == 0) {
                if (onEof) {
                    onEof();
                }
            } else {
                if (onError) {
                    onError(errno);
                }
            }
        }
    }

References core::DescriptorEventReceiver::disable(), core::DescriptorEventReceiver::getRegisteredFd(), and core::system::read().

Here is the call graph for this function:

setOnData()

void core::pipe::PipeSink::setOnData

(

const std::function< void(const char *, std::size_t)> &

onData

)

Definition at line 74 of file PipeSink.cpp.

                                                                                    {
        this->onData = onData;
    }

setOnEof()

void core::pipe::PipeSink::setOnEof

(

const std::function< void()> &

onEof

)

Definition at line 78 of file PipeSink.cpp.

                                                            {
        this->onEof = onEof;
    }

setOnError()

void core::pipe::PipeSink::setOnError

(

const std::function< void(int)> &

onError

)

Definition at line 82 of file PipeSink.cpp.

                                                                   {
        this->onError = onError;
    }

unobservedEvent()

void core::pipe::PipeSink::unobservedEvent ( )

overrideprivatevirtual

Implements core::Observer.

Definition at line 86 of file PipeSink.cpp.

                                   {
        delete this;
    }

Member Data Documentation

onData

std::function<void(const char*, std::size_t)> core::pipe::PipeSink::onData

private

Definition at line 51 of file PipeSink.h.

onEof

std::function<void()> core::pipe::PipeSink::onEof

private

Definition at line 52 of file PipeSink.h.

onError

std::function<void(int errnum)> core::pipe::PipeSink::onError

private

Definition at line 53 of file PipeSink.h.

---

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

• core/pipe/PipeSink.h
• core/pipe/PipeSink.cpp