core::pipe::PipeSource Class Reference

#include <PipeSource.h>

Inheritance diagram for core::pipe::PipeSource:

Collaboration diagram for core::pipe::PipeSource:

Public Member Functions
	PipeSource (const PipeSource &)=delete
PipeSource &	operator= (const PipeSource &)=delete
	PipeSource (int fd)
	~PipeSource () override
void	send (const char *chunk, std::size_t chunkLen)
void	send (const std::string &data)
void	eof ()
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

Protected Member Functions
void	writeEvent () override
void	unobservedEvent () override
Protected Member Functions inherited from core::eventreceiver::WriteEventReceiver
	WriteEventReceiver (const std::string &name, const utils::Timeval &timeout)
virtual void	writeTimeout ()
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

Private Attributes
std::function< void(int errnum)>	onError
std::vector< char >	writeBuffer

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 58 of file PipeSource.h.

Constructor & Destructor Documentation

PipeSource() [1/2]

core::pipe::PipeSource::PipeSource ( const PipeSource &  )

delete

PipeSource() [2/2]

core::pipe::PipeSource::PipeSource ( int  fd )

explicit

Definition at line 60 of file PipeSource.cpp.

        : core::eventreceiver::WriteEventReceiver("PipeSource fd = " + std::to_string(fd), 60) {
        if (!WriteEventReceiver::enable(fd)) {
            delete this;
        } else {
            WriteEventReceiver::suspend();
        }
    }

References core::DescriptorEventReceiver::enable(), core::DescriptorEventReceiver::suspend(), and core::eventreceiver::WriteEventReceiver::WriteEventReceiver().

Referenced by core::pipe::Pipe::Pipe().

Here is the call graph for this function:

Here is the caller graph for this function:

~PipeSource()

core::pipe::PipeSource::~PipeSource ( )

override

Definition at line 69 of file PipeSource.cpp.

                            {
        close(getRegisteredFd());
    }

References core::DescriptorEventReceiver::getRegisteredFd().

Here is the call graph for this function:

Member Function Documentation

eof()

void core::pipe::PipeSource::eof

(

)

Definition at line 89 of file PipeSource.cpp.

                         {
        WriteEventReceiver::disable();
    }

References core::DescriptorEventReceiver::disable().

Here is the call graph for this function:

operator=()

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

delete

send() [1/2]

void core::pipe::PipeSource::send	(	const char *	chunk,
		std::size_t	chunkLen
	)

Definition at line 77 of file PipeSource.cpp.

                                                               {
        writeBuffer.insert(writeBuffer.end(), chunk, chunk + chunkLen);
 
        if (WriteEventReceiver::isSuspended()) {
            WriteEventReceiver::resume();
        }
    }

References core::DescriptorEventReceiver::isSuspended(), core::DescriptorEventReceiver::resume(), and writeBuffer.

Referenced by main(), and send().

Here is the call graph for this function:

Here is the caller graph for this function:

send() [2/2]

void core::pipe::PipeSource::send

(

const std::string &

data

)

Definition at line 85 of file PipeSource.cpp.

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

References send().

Referenced by main().

Here is the call graph for this function:

Here is the caller graph for this function:

setOnError()

void core::pipe::PipeSource::setOnError

(

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

onError

)

Definition at line 73 of file PipeSource.cpp.

                                                                     {
        this->onError = onError;
    }

References onError.

Referenced by main().

Here is the caller graph for this function:

unobservedEvent()

void core::pipe::PipeSource::unobservedEvent ( )

overrideprotectedvirtual

Implements core::Observer.

Definition at line 112 of file PipeSource.cpp.

                                     {
        delete this;
    }

writeEvent()

void core::pipe::PipeSource::writeEvent ( )

overrideprotectedvirtual

Implements core::eventreceiver::WriteEventReceiver.

Definition at line 93 of file PipeSource.cpp.

                                {
        const ssize_t ret = core::system::write(
            getRegisteredFd(), writeBuffer.data(), (writeBuffer.size() < MAX_SEND_CHUNKSIZE) ? writeBuffer.size() : MAX_SEND_CHUNKSIZE);
 
        if (ret > 0) {
            writeBuffer.erase(writeBuffer.begin(), writeBuffer.begin() + ret);
 
            if (writeBuffer.empty()) {
                WriteEventReceiver::suspend();
            }
        } else if (errno != EAGAIN && errno != EWOULDBLOCK && errno != EINTR) {
            WriteEventReceiver::disable();
 
            if (onError) {
                onError(errno);
            }
        }
    }

References core::DescriptorEventReceiver::disable(), core::DescriptorEventReceiver::getRegisteredFd(), onError, core::DescriptorEventReceiver::suspend(), core::system::write(), and writeBuffer.

Here is the call graph for this function:

Member Data Documentation

onError

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

private

Definition at line 78 of file PipeSource.h.

Referenced by setOnError(), and writeEvent().

writeBuffer

std::vector<char> core::pipe::PipeSource::writeBuffer

private

Definition at line 80 of file PipeSource.h.

Referenced by send(), and writeEvent().

---

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

• core/pipe/PipeSource.h
• core/pipe/PipeSource.cpp