core::DescriptorEventPublisher Class Reference

#include <DescriptorEventPublisher.h>

Inheritance diagram for core::DescriptorEventPublisher:

Collaboration diagram for core::DescriptorEventPublisher:

Public Member Functions
	DescriptorEventPublisher ()=delete
virtual	~DescriptorEventPublisher ()
	DescriptorEventPublisher (const DescriptorEventPublisher &)=delete
DescriptorEventPublisher &	operator= (const DescriptorEventPublisher &)=delete
void	enable (DescriptorEventReceiver *descriptorEventReceiver)
void	disable (DescriptorEventReceiver *descriptorEventReceiver)
void	suspend (DescriptorEventReceiver *descriptorEventReceiver)
void	resume (DescriptorEventReceiver *descriptorEventReceiver)
virtual void	spanActiveEvents ()=0
void	checkTimedOutEvents (const utils::Timeval &currentTime)
void	releaseDisabledEvents (const utils::Timeval &currentTime)
int	getObservedEventReceiverCount () const
int	maxFd () const
utils::Timeval	getNextTimeout (const utils::Timeval &currentTime) const
void	signal (int sigNum)
void	disable ()
const std::string &	getName () const

Protected Member Functions
	DescriptorEventPublisher (std::string name)

Protected Attributes
std::map< int, std::list< DescriptorEventReceiver * > >	observedEventReceiverLists
unsigned long	eventCounter = 0

Private Member Functions
virtual void	muxAdd (DescriptorEventReceiver *descriptorEventReceiver)=0
virtual void	muxDel (int fd)=0
virtual void	muxOn (DescriptorEventReceiver *descriptorEventReceiver)=0
virtual void	muxOff (DescriptorEventReceiver *descriptorEventReceiver)=0

Private Attributes
std::string	name
std::map< std::list< DescriptorEventReceiver * > *, std::list< DescriptorEventReceiver * > >	dirtyEventReceiverLists

Detailed Description

Definition at line 63 of file DescriptorEventPublisher.h.

Constructor & Destructor Documentation

DescriptorEventPublisher() [1/3]

core::DescriptorEventPublisher::DescriptorEventPublisher ( std::string  name )

protected

Definition at line 58 of file DescriptorEventPublisher.cpp.

        : name(std::move(name)) {
    }

References name.

Referenced by core::multiplexer::poll::DescriptorEventPublisher::DescriptorEventPublisher(), core::multiplexer::select::DescriptorEventPublisher::DescriptorEventPublisher(), and core::multiplexer::epoll::DescriptorEventPublisher::DescriptorEventPublisher().

Here is the caller graph for this function:

DescriptorEventPublisher() [2/3]

core::DescriptorEventPublisher::DescriptorEventPublisher ( )

delete

~DescriptorEventPublisher()

core::DescriptorEventPublisher::~DescriptorEventPublisher ( )

virtual

Definition at line 62 of file DescriptorEventPublisher.cpp.

                                                        {
    }

DescriptorEventPublisher() [3/3]

core::DescriptorEventPublisher::DescriptorEventPublisher ( const DescriptorEventPublisher &  )

delete

Member Function Documentation

checkTimedOutEvents()

void core::DescriptorEventPublisher::checkTimedOutEvents

(

const utils::Timeval &

currentTime

)

Definition at line 90 of file DescriptorEventPublisher.cpp.

                                                                                      {
        for (auto& [fd, eventReceivers] : observedEventReceiverLists) {
            eventReceivers.front()->checkTimeout(currentTime);
        }
    }

References core::DescriptorEventReceiver::checkTimeout(), and observedEventReceiverLists.

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

Here is the call graph for this function:

Here is the caller graph for this function:

disable() [1/2]

void core::DescriptorEventPublisher::disable

(

)

Definition at line 160 of file DescriptorEventPublisher.cpp.

                                           {
        for (auto& [fd, eventReceivers] : observedEventReceiverLists) {
            for (DescriptorEventReceiver* eventReceiver : eventReceivers) {
                eventReceiver->disable();
            }
        }
    }

References core::DescriptorEventReceiver::disable(), and observedEventReceiverLists.

Referenced by core::EventMultiplexer::terminate().

Here is the call graph for this function:

Here is the caller graph for this function:

disable() [2/2]

void core::DescriptorEventPublisher::disable

(

DescriptorEventReceiver *

descriptorEventReceiver

)

Definition at line 76 of file DescriptorEventPublisher.cpp.

                                                                                           {
        const int fd = descriptorEventReceiver->getRegisteredFd();
 
        dirtyEventReceiverLists[&observedEventReceiverLists[fd]].push_back(descriptorEventReceiver);
    }

References dirtyEventReceiverLists, core::DescriptorEventReceiver::getRegisteredFd(), and observedEventReceiverLists.

Referenced by core::DescriptorEventReceiver::disable().

Here is the call graph for this function:

Here is the caller graph for this function:

enable()

void core::DescriptorEventPublisher::enable

(

DescriptorEventReceiver *

descriptorEventReceiver

)

Definition at line 65 of file DescriptorEventPublisher.cpp.

                                                                                          {
        const int fd = descriptorEventReceiver->getRegisteredFd();
 
        observedEventReceiverLists[fd].push_front(descriptorEventReceiver);
        muxAdd(descriptorEventReceiver);
        if (descriptorEventReceiver->isSuspended()) {
            muxOff(descriptorEventReceiver);
        }
        descriptorEventReceiver->setEnabled(utils::Timeval::currentTime());
    }

References utils::Timeval::currentTime(), core::DescriptorEventReceiver::getRegisteredFd(), core::DescriptorEventReceiver::isSuspended(), muxAdd(), muxOff(), observedEventReceiverLists, and core::DescriptorEventReceiver::setEnabled().

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

Here is the call graph for this function:

Here is the caller graph for this function:

getName()

const std::string & core::DescriptorEventPublisher::getName

(

)

const

Definition at line 168 of file DescriptorEventPublisher.cpp.

                                                             {
        return name;
    }

References name.

getNextTimeout()

utils::Timeval core::DescriptorEventPublisher::getNextTimeout

(

const utils::Timeval &

currentTime

)

const

Definition at line 138 of file DescriptorEventPublisher.cpp.

                                                                                               {
        utils::Timeval nextTimeout = DescriptorEventReceiver::TIMEOUT::MAX;
 
        if (dirtyEventReceiverLists.empty()) {
            for (const auto& [fd, eventReceivers] : observedEventReceiverLists) {
                nextTimeout = std::min(eventReceivers.front()->getTimeout(currentTime), nextTimeout);
            }
        } else {
            nextTimeout = 0;
        }
 
        return nextTimeout;
    }

References dirtyEventReceiverLists, core::DescriptorEventReceiver::getTimeout(), core::DescriptorEventReceiver::TIMEOUT::MAX, observedEventReceiverLists, and utils::Timeval::operator=().

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

Here is the call graph for this function:

Here is the caller graph for this function:

getObservedEventReceiverCount()

int core::DescriptorEventPublisher::getObservedEventReceiverCount

(

)

const

Definition at line 124 of file DescriptorEventPublisher.cpp.

                                                                      {
        return static_cast<int>(observedEventReceiverLists.size());
    }

References observedEventReceiverLists.

Referenced by core::EventMultiplexer::observedEventReceiverCount().

Here is the caller graph for this function:

maxFd()

int core::DescriptorEventPublisher::maxFd

(

)

const

Definition at line 128 of file DescriptorEventPublisher.cpp.

                                              {
        int maxFd = -1;
 
        if (!observedEventReceiverLists.empty()) {
            maxFd = observedEventReceiverLists.rbegin()->first;
        }
 
        return maxFd;
    }

References observedEventReceiverLists.

Referenced by core::EventMultiplexer::maxFd().

Here is the caller graph for this function:

muxAdd()

virtual void core::DescriptorEventPublisher::muxAdd ( DescriptorEventReceiver *  descriptorEventReceiver )

privatepure virtual

Implemented in core::multiplexer::epoll::DescriptorEventPublisher, core::multiplexer::poll::DescriptorEventPublisher, and core::multiplexer::select::DescriptorEventPublisher.

Referenced by enable().

Here is the caller graph for this function:

muxDel()

virtual void core::DescriptorEventPublisher::muxDel ( int  fd )

privatepure virtual

Implemented in core::multiplexer::epoll::DescriptorEventPublisher, core::multiplexer::poll::DescriptorEventPublisher, and core::multiplexer::select::DescriptorEventPublisher.

Referenced by releaseDisabledEvents().

Here is the caller graph for this function:

muxOff()

virtual void core::DescriptorEventPublisher::muxOff ( DescriptorEventReceiver *  descriptorEventReceiver )

privatepure virtual

Implemented in core::multiplexer::epoll::DescriptorEventPublisher, core::multiplexer::poll::DescriptorEventPublisher, and core::multiplexer::select::DescriptorEventPublisher.

Referenced by enable(), releaseDisabledEvents(), and suspend().

Here is the caller graph for this function:

muxOn()

virtual void core::DescriptorEventPublisher::muxOn ( DescriptorEventReceiver *  descriptorEventReceiver )

privatepure virtual

Implemented in core::multiplexer::epoll::DescriptorEventPublisher, core::multiplexer::poll::DescriptorEventPublisher, and core::multiplexer::select::DescriptorEventPublisher.

Referenced by releaseDisabledEvents(), and resume().

Here is the caller graph for this function:

operator=()

DescriptorEventPublisher & core::DescriptorEventPublisher::operator= ( const DescriptorEventPublisher &  )

delete

releaseDisabledEvents()

void core::DescriptorEventPublisher::releaseDisabledEvents

(

const utils::Timeval &

currentTime

)

Definition at line 96 of file DescriptorEventPublisher.cpp.

                                                                                        {
        for (auto& [dirtyDescriptEventReceiverList, disabledDescriptorEventReceivers] : dirtyEventReceiverLists) {
            for (DescriptorEventReceiver* disabledDescriptorEventReceiver : disabledDescriptorEventReceivers) {
                dirtyDescriptEventReceiverList->remove(disabledDescriptorEventReceiver);
 
                if (dirtyDescriptEventReceiverList->empty()) {
                    const int fd = disabledDescriptorEventReceiver->getRegisteredFd();
 
                    muxDel(fd);
                    observedEventReceiverLists.erase(fd);
                } else {
                    DescriptorEventReceiver* activeDescriptorEventReceiver = dirtyDescriptEventReceiverList->front();
 
                    activeDescriptorEventReceiver->triggered(currentTime);
                    if (!activeDescriptorEventReceiver->isSuspended()) {
                        muxOn(activeDescriptorEventReceiver);
                    } else {
                        muxOff(activeDescriptorEventReceiver);
                    }
                }
 
                disabledDescriptorEventReceiver->setDisabled();
            }
        }
 
        dirtyEventReceiverLists.clear();
    }

References dirtyEventReceiverLists, core::DescriptorEventReceiver::getRegisteredFd(), core::DescriptorEventReceiver::isSuspended(), muxDel(), muxOff(), muxOn(), observedEventReceiverLists, core::DescriptorEventReceiver::setDisabled(), and core::DescriptorEventReceiver::triggered().

Referenced by core::EventMultiplexer::releaseExpiredResources().

Here is the call graph for this function:

Here is the caller graph for this function:

resume()

void core::DescriptorEventPublisher::resume

(

DescriptorEventReceiver *

descriptorEventReceiver

)

Definition at line 86 of file DescriptorEventPublisher.cpp.

                                                                                          {
        muxOn(descriptorEventReceiver);
    }

References muxOn().

Referenced by core::DescriptorEventReceiver::resume().

Here is the call graph for this function:

Here is the caller graph for this function:

signal()

void core::DescriptorEventPublisher::signal

(

int

sigNum

)

Definition at line 152 of file DescriptorEventPublisher.cpp.

                                                    {
        for (auto& [fd, eventReceivers] : observedEventReceiverLists) {
            for (DescriptorEventReceiver* eventReceiver : eventReceivers) {
                eventReceiver->onSignal(sigNum);
            }
        }
    }

References observedEventReceiverLists, and core::DescriptorEventReceiver::onSignal().

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

Here is the call graph for this function:

Here is the caller graph for this function:

spanActiveEvents()

virtual void core::DescriptorEventPublisher::spanActiveEvents ( )

pure virtual

Implemented in core::multiplexer::epoll::DescriptorEventPublisher, core::multiplexer::poll::DescriptorEventPublisher, and core::multiplexer::select::DescriptorEventPublisher.

Referenced by core::multiplexer::epoll::EventMultiplexer::spanActiveEvents(), core::multiplexer::poll::EventMultiplexer::spanActiveEvents(), and core::multiplexer::select::EventMultiplexer::spanActiveEvents().

Here is the caller graph for this function:

suspend()

void core::DescriptorEventPublisher::suspend

(

DescriptorEventReceiver *

descriptorEventReceiver

)

Definition at line 82 of file DescriptorEventPublisher.cpp.

                                                                                           {
        muxOff(descriptorEventReceiver);
    }

References muxOff().

Referenced by core::DescriptorEventReceiver::suspend().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

dirtyEventReceiverLists

std::map<std::list<DescriptorEventReceiver*>*, std::list<DescriptorEventReceiver*> > core::DescriptorEventPublisher::dirtyEventReceiverLists

private

Definition at line 106 of file DescriptorEventPublisher.h.

Referenced by disable(), getNextTimeout(), and releaseDisabledEvents().

eventCounter

unsigned long core::DescriptorEventPublisher::eventCounter = 0

protected

Definition at line 97 of file DescriptorEventPublisher.h.

Referenced by core::multiplexer::epoll::DescriptorEventPublisher::spanActiveEvents(), core::multiplexer::poll::DescriptorEventPublisher::spanActiveEvents(), and core::multiplexer::select::DescriptorEventPublisher::spanActiveEvents().

name

std::string core::DescriptorEventPublisher::name

private

Definition at line 105 of file DescriptorEventPublisher.h.

Referenced by DescriptorEventPublisher(), and getName().

observedEventReceiverLists

std::map<int, std::list<DescriptorEventReceiver*> > core::DescriptorEventPublisher::observedEventReceiverLists

protected

Definition at line 96 of file DescriptorEventPublisher.h.

Referenced by checkTimedOutEvents(), disable(), disable(), enable(), getNextTimeout(), getObservedEventReceiverCount(), maxFd(), releaseDisabledEvents(), signal(), core::multiplexer::poll::DescriptorEventPublisher::spanActiveEvents(), and core::multiplexer::select::DescriptorEventPublisher::spanActiveEvents().

---

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

• core/DescriptorEventPublisher.h
• core/DescriptorEventPublisher.cpp