core::DescriptorEventReceiver Class Reference

#include <DescriptorEventReceiver.h>

Inheritance diagram for core::DescriptorEventReceiver:

Collaboration diagram for core::DescriptorEventReceiver:

Classes
struct	TIMEOUT

Public Member Functions
	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
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

Private Member Functions
void	onEvent (const utils::Timeval &currentTime) final
void	onSignal (int signum)
void	triggered (const utils::Timeval &currentTime)
void	setEnabled (const utils::Timeval &currentTime)
void	setDisabled ()
virtual void	dispatchEvent ()=0
virtual void	timeoutEvent ()=0
virtual void	signalEvent (int signum)=0

Private Attributes
DescriptorEventPublisher &	descriptorEventPublisher
int	observedFd = -1
bool	enabled = false
bool	suspended = false
utils::Timeval	lastTriggered
utils::Timeval	maxInactivity
const utils::Timeval	initialTimeout
int	eventCounter = 0

Friends
class	DescriptorEventPublisher

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 79 of file DescriptorEventReceiver.h.

Constructor & Destructor Documentation

DescriptorEventReceiver()

core::DescriptorEventReceiver::DescriptorEventReceiver	(	const std::string &	name,
		DescriptorEventPublisher &	descriptorEventPublisher,
		const utils::Timeval &	timeout = TIMEOUT::DISABLE
	)

Definition at line 75 of file DescriptorEventReceiver.cpp.

        : EventReceiver(name)
        , descriptorEventPublisher(descriptorEventPublisher)
        , maxInactivity(timeout)
        , initialTimeout(timeout) {
    }

References descriptorEventPublisher, core::EventReceiver::EventReceiver(), initialTimeout, maxInactivity, and utils::Timeval::Timeval().

Referenced by core::eventreceiver::AcceptEventReceiver::AcceptEventReceiver(), core::eventreceiver::ConnectEventReceiver::ConnectEventReceiver(), core::eventreceiver::ExceptionalConditionEventReceiver::ExceptionalConditionEventReceiver(), core::eventreceiver::ReadEventReceiver::ReadEventReceiver(), and core::eventreceiver::WriteEventReceiver::WriteEventReceiver().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Function Documentation

checkTimeout()

void core::DescriptorEventReceiver::checkTimeout

(

const utils::Timeval &

currentTime

)

Definition at line 186 of file DescriptorEventReceiver.cpp.

                                                                              {
        if (maxInactivity > 0 && currentTime - lastTriggered >= maxInactivity) {
            timeoutEvent();
        }
    }

References lastTriggered, maxInactivity, utils::Timeval::operator-(), utils::Timeval::operator>(), utils::Timeval::operator>=(), and timeoutEvent().

Referenced by core::DescriptorEventPublisher::checkTimedOutEvents().

Here is the call graph for this function:

Here is the caller graph for this function:

disable()

void core::DescriptorEventReceiver::disable ( )

protected

Definition at line 108 of file DescriptorEventReceiver.cpp.

                                          {
        if (enabled) {
            enabled = false;
            descriptorEventPublisher.disable(this);
            LOG(TRACE) << getName() << ": Disabled";
        } else {
            LOG(WARNING) << getName() << ": Double disable";
        }
    }

References descriptorEventPublisher, core::DescriptorEventPublisher::disable(), enabled, and core::EventReceiver::getName().

Referenced by core::eventreceiver::AcceptEventReceiver::acceptTimeout(), core::socket::stream::SocketConnector< PhysicalSocketClientT, ConfigT, SocketConnectionT >::connectEvent(), core::eventreceiver::ConnectEventReceiver::connectTimeout(), core::DescriptorEventPublisher::disable(), core::pipe::PipeSource::eof(), core::eventreceiver::ExceptionalConditionEventReceiver::outOfBandTimeout(), core::socket::stream::tls::TLSHandshake::readEvent(), core::socket::stream::tls::TLSShutdown::readEvent(), core::pipe::PipeSink::readEvent(), core::eventreceiver::ReadEventReceiver::readTimeout(), core::socket::stream::tls::TLSHandshake::readTimeout(), core::socket::stream::tls::TLSShutdown::readTimeout(), core::socket::stream::SocketWriter::signalEvent(), core::eventreceiver::AcceptEventReceiver::signalEvent(), core::eventreceiver::ConnectEventReceiver::signalEvent(), core::eventreceiver::ExceptionalConditionEventReceiver::signalEvent(), core::eventreceiver::ReadEventReceiver::signalEvent(), core::eventreceiver::WriteEventReceiver::signalEvent(), core::socket::stream::tls::TLSHandshake::TLSHandshake(), core::socket::stream::tls::TLSShutdown::TLSShutdown(), core::socket::stream::tls::TLSHandshake::writeEvent(), core::socket::stream::tls::TLSShutdown::writeEvent(), core::pipe::PipeSource::writeEvent(), core::eventreceiver::WriteEventReceiver::writeTimeout(), core::socket::stream::tls::TLSHandshake::writeTimeout(), and core::socket::stream::tls::TLSShutdown::writeTimeout().

Here is the call graph for this function:

Here is the caller graph for this function:

dispatchEvent()

virtual void core::DescriptorEventReceiver::dispatchEvent ( )

privatepure virtual

Implemented in core::eventreceiver::AcceptEventReceiver, core::eventreceiver::ConnectEventReceiver, core::eventreceiver::ExceptionalConditionEventReceiver, core::eventreceiver::ReadEventReceiver, and core::eventreceiver::WriteEventReceiver.

Referenced by onEvent().

Here is the caller graph for this function:

enable()

bool core::DescriptorEventReceiver::enable ( int  fd )

protected

Definition at line 88 of file DescriptorEventReceiver.cpp.

                                               {
        if (!enabled) {
            observedFd = fd;
 
            enabled = true;
            descriptorEventPublisher.enable(this);
            LOG(TRACE) << getName() << ": Enabled";
        } else {
            LOG(WARNING) << getName() << ": Double enable";
        }
 
        return enabled;
    }

References descriptorEventPublisher, core::DescriptorEventPublisher::enable(), enabled, core::EventReceiver::getName(), and observedFd.

Referenced by core::socket::stream::SocketAcceptor< PhysicalSocketServerT, ConfigT, SocketConnectionT >::init(), core::socket::stream::SocketConnector< PhysicalSocketClientT, ConfigT, SocketConnectionT >::init(), core::pipe::PipeSink::PipeSink(), core::pipe::PipeSource::PipeSource(), core::socket::stream::tls::TLSHandshake::TLSHandshake(), and core::socket::stream::tls::TLSShutdown::TLSShutdown().

Here is the call graph for this function:

Here is the caller graph for this function:

getRegisteredFd()

int core::DescriptorEventReceiver::getRegisteredFd

(

)

const

Definition at line 84 of file DescriptorEventReceiver.cpp.

                                                       {
        return observedFd;
    }

References observedFd.

Referenced by core::DescriptorEventPublisher::disable(), core::DescriptorEventPublisher::enable(), core::multiplexer::epoll::DescriptorEventPublisher::EPollEvents::muxAdd(), core::multiplexer::select::DescriptorEventPublisher::muxAdd(), core::multiplexer::poll::PollFdsManager::muxAdd(), core::multiplexer::epoll::DescriptorEventPublisher::EPollEvents::muxOff(), core::multiplexer::select::DescriptorEventPublisher::muxOff(), core::multiplexer::epoll::DescriptorEventPublisher::EPollEvents::muxOn(), core::multiplexer::select::DescriptorEventPublisher::muxOn(), core::socket::stream::SocketReader::read(), core::pipe::PipeSink::readEvent(), core::DescriptorEventPublisher::releaseDisabledEvents(), core::socket::stream::SocketWriter::write(), core::pipe::PipeSource::writeEvent(), core::pipe::PipeSink::~PipeSink(), and core::pipe::PipeSource::~PipeSource().

Here is the caller graph for this function:

getTimeout()

utils::Timeval core::DescriptorEventReceiver::getTimeout

(

const utils::Timeval &

currentTime

)

const

Definition at line 167 of file DescriptorEventReceiver.cpp.

                                                                                          {
        return maxInactivity > 0 ? currentTime > lastTriggered ? maxInactivity - (currentTime - lastTriggered) : 0 : TIMEOUT::MAX;
    }

References lastTriggered, core::DescriptorEventReceiver::TIMEOUT::MAX, maxInactivity, utils::Timeval::operator-(), and utils::Timeval::operator>().

Referenced by core::DescriptorEventPublisher::getNextTimeout().

Here is the call graph for this function:

Here is the caller graph for this function:

isEnabled()

bool core::DescriptorEventReceiver::isEnabled

(

)

const

Definition at line 122 of file DescriptorEventReceiver.cpp.

                                                  {
        return enabled;
    }

References enabled.

Referenced by core::socket::stream::SocketAcceptor< PhysicalSocketServerT, ConfigT, SocketConnectionT >::init(), core::socket::stream::SocketConnector< PhysicalSocketClientT, ConfigT, SocketConnectionT >::init(), core::socket::stream::SocketWriter::sendToPeer(), and core::socket::stream::SocketWriter::streamToPeer().

Here is the caller graph for this function:

isSuspended()

bool core::DescriptorEventReceiver::isSuspended

(

)

const

Definition at line 153 of file DescriptorEventReceiver.cpp.

                                                    {
        return suspended;
    }

References suspended.

Referenced by core::socket::stream::SocketReader::doRead(), core::socket::stream::SocketWriter::doWrite(), core::DescriptorEventPublisher::enable(), core::DescriptorEventPublisher::releaseDisabledEvents(), and core::pipe::PipeSource::send().

Here is the caller graph for this function:

onEvent()

void core::DescriptorEventReceiver::onEvent ( const utils::Timeval &  currentTime )

finalprivatevirtual

Implements core::EventReceiver.

Definition at line 171 of file DescriptorEventReceiver.cpp.

                                                                         {
        eventCounter++;
        triggered(currentTime);
 
        dispatchEvent();
    }

References dispatchEvent(), eventCounter, and triggered().

Here is the call graph for this function:

onSignal()

void core::DescriptorEventReceiver::onSignal ( int  signum )

private

Definition at line 178 of file DescriptorEventReceiver.cpp.

                                                     {
        signalEvent(signum);
    }

References signalEvent().

Referenced by core::DescriptorEventPublisher::signal().

Here is the call graph for this function:

Here is the caller graph for this function:

resume()

void core::DescriptorEventReceiver::resume ( )

protected

Definition at line 139 of file DescriptorEventReceiver.cpp.

                                         {
        if (enabled) {
            if (suspended) {
                suspended = false;
                lastTriggered = utils::Timeval::currentTime();
                descriptorEventPublisher.resume(this);
            } else {
                LOG(WARNING) << getName() << ": Double resume";
            }
        } else {
            LOG(WARNING) << getName() << ": Resume while not enabled";
        }
    }

References utils::Timeval::currentTime(), descriptorEventPublisher, enabled, core::EventReceiver::getName(), lastTriggered, utils::Timeval::operator=(), core::DescriptorEventPublisher::resume(), and suspended.

Referenced by core::socket::stream::SocketReader::doRead(), core::socket::stream::SocketWriter::doWrite(), core::socket::stream::tls::TLSHandshake::readEvent(), core::socket::stream::tls::TLSShutdown::readEvent(), core::pipe::PipeSource::send(), core::socket::stream::SocketWriter::sendToPeer(), core::socket::stream::tls::TLSHandshake::TLSHandshake(), core::socket::stream::tls::TLSShutdown::TLSShutdown(), core::socket::stream::tls::TLSHandshake::writeEvent(), and core::socket::stream::tls::TLSShutdown::writeEvent().

Here is the call graph for this function:

Here is the caller graph for this function:

setDisabled()

void core::DescriptorEventReceiver::setDisabled ( )

private

Definition at line 118 of file DescriptorEventReceiver.cpp.

                                              {
        unObserved();
    }

References core::Observer::unObserved().

Referenced by core::DescriptorEventPublisher::releaseDisabledEvents().

Here is the call graph for this function:

Here is the caller graph for this function:

setEnabled()

void core::DescriptorEventReceiver::setEnabled ( const utils::Timeval &  currentTime )

private

Definition at line 102 of file DescriptorEventReceiver.cpp.

                                                                            {
        lastTriggered = currentTime;
 
        observed();
    }

References lastTriggered, core::Observer::observed(), and utils::Timeval::operator=().

Referenced by core::DescriptorEventPublisher::enable().

Here is the call graph for this function:

Here is the caller graph for this function:

setTimeout()

void core::DescriptorEventReceiver::setTimeout

(

const utils::Timeval &

timeout

)

Definition at line 157 of file DescriptorEventReceiver.cpp.

                                                                        {
        if (timeout == TIMEOUT::DEFAULT) {
            this->maxInactivity = initialTimeout;
        } else {
            this->maxInactivity = timeout;
        }
 
        triggered(utils::Timeval::currentTime());
    }

References utils::Timeval::currentTime(), core::DescriptorEventReceiver::TIMEOUT::DEFAULT, initialTimeout, maxInactivity, utils::Timeval::operator=(), utils::Timeval::operator==(), and triggered().

Referenced by core::socket::stream::SocketAcceptor< PhysicalSocketServerT, ConfigT, SocketConnectionT >::init(), core::socket::stream::SocketConnector< PhysicalSocketClientT, ConfigT, SocketConnectionT >::init(), and core::socket::stream::SocketReader::shutdownRead().

Here is the call graph for this function:

Here is the caller graph for this function:

signalEvent()

virtual void core::DescriptorEventReceiver::signalEvent ( int  signum )

privatepure virtual

Implemented in core::socket::stream::SocketReader, core::socket::stream::SocketWriter, core::socket::stream::tls::TLSHandshake, core::socket::stream::tls::TLSShutdown, core::eventreceiver::AcceptEventReceiver, core::eventreceiver::ConnectEventReceiver, core::eventreceiver::ExceptionalConditionEventReceiver, core::eventreceiver::ReadEventReceiver, and core::eventreceiver::WriteEventReceiver.

Referenced by onSignal().

Here is the caller graph for this function:

suspend()

void core::DescriptorEventReceiver::suspend ( )

protected

Definition at line 126 of file DescriptorEventReceiver.cpp.

                                          {
        if (enabled) {
            if (!suspended) {
                suspended = true;
                descriptorEventPublisher.suspend(this);
            } else {
                LOG(WARNING) << getName() << ": Double suspend";
            }
        } else {
            LOG(WARNING) << getName() << ": Suspend while not enabled";
        }
    }

References descriptorEventPublisher, enabled, core::EventReceiver::getName(), core::DescriptorEventPublisher::suspend(), and suspended.

Referenced by core::socket::stream::SocketReader::doRead(), core::socket::stream::SocketWriter::doWrite(), core::pipe::PipeSource::PipeSource(), core::socket::stream::tls::TLSHandshake::readEvent(), core::socket::stream::tls::TLSShutdown::readEvent(), core::socket::stream::tls::TLSHandshake::TLSHandshake(), core::socket::stream::tls::TLSShutdown::TLSShutdown(), core::socket::stream::tls::TLSHandshake::writeEvent(), core::socket::stream::tls::TLSShutdown::writeEvent(), and core::pipe::PipeSource::writeEvent().

Here is the call graph for this function:

Here is the caller graph for this function:

timeoutEvent()

virtual void core::DescriptorEventReceiver::timeoutEvent ( )

privatepure virtual

Implemented in core::eventreceiver::AcceptEventReceiver, core::eventreceiver::ConnectEventReceiver, core::eventreceiver::ExceptionalConditionEventReceiver, core::eventreceiver::ReadEventReceiver, and core::eventreceiver::WriteEventReceiver.

Referenced by checkTimeout().

Here is the caller graph for this function:

triggered()

void core::DescriptorEventReceiver::triggered ( const utils::Timeval &  currentTime )

private

Definition at line 182 of file DescriptorEventReceiver.cpp.

                                                                           {
        lastTriggered = currentTime;
    }

References lastTriggered, and utils::Timeval::operator=().

Referenced by onEvent(), core::DescriptorEventPublisher::releaseDisabledEvents(), and setTimeout().

Here is the call graph for this function:

Here is the caller graph for this function:

Friends And Related Symbol Documentation

DescriptorEventPublisher

friend class DescriptorEventPublisher

friend

Definition at line 136 of file DescriptorEventReceiver.h.

Member Data Documentation

descriptorEventPublisher

DescriptorEventPublisher& core::DescriptorEventReceiver::descriptorEventPublisher

private

Definition at line 123 of file DescriptorEventReceiver.h.

Referenced by DescriptorEventReceiver(), disable(), enable(), resume(), and suspend().

enabled

bool core::DescriptorEventReceiver::enabled = false

private

Definition at line 127 of file DescriptorEventReceiver.h.

Referenced by disable(), enable(), isEnabled(), resume(), and suspend().

eventCounter

int core::DescriptorEventReceiver::eventCounter = 0

private

Definition at line 134 of file DescriptorEventReceiver.h.

Referenced by onEvent().

initialTimeout

const utils::Timeval core::DescriptorEventReceiver::initialTimeout

private

Definition at line 132 of file DescriptorEventReceiver.h.

Referenced by DescriptorEventReceiver(), and setTimeout().

lastTriggered

utils::Timeval core::DescriptorEventReceiver::lastTriggered

private

Definition at line 130 of file DescriptorEventReceiver.h.

Referenced by checkTimeout(), getTimeout(), resume(), setEnabled(), and triggered().

maxInactivity

utils::Timeval core::DescriptorEventReceiver::maxInactivity

private

Definition at line 131 of file DescriptorEventReceiver.h.

Referenced by checkTimeout(), DescriptorEventReceiver(), getTimeout(), and setTimeout().

observedFd

int core::DescriptorEventReceiver::observedFd = -1

private

Definition at line 125 of file DescriptorEventReceiver.h.

Referenced by enable(), and getRegisteredFd().

suspended

bool core::DescriptorEventReceiver::suspended = false

private

Definition at line 128 of file DescriptorEventReceiver.h.

Referenced by isSuspended(), resume(), and suspend().

---

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

• core/DescriptorEventReceiver.h
• core/DescriptorEventReceiver.cpp