FdEvent.hh

Go to the documentation of this file.

//
// Copyright (c) 2020 Fraunhofer Institute for Applied Information Technology (FIT)
//                    Network Research Group (NET)
//                    Schloss Birlinghoven, 53754 Sankt Augustin, GERMANY
//                    Contact: support@wiback.org
//
// This file is part of the SENF code tree.
// It is licensed under the 3-clause BSD License (aka New BSD License).
// See LICENSE.txt in the top level directory for details or visit
// https://opensource.org/licenses/BSD-3-Clause
//


#ifndef HH_SENF_Scheduler_FdEvent_
#define HH_SENF_Scheduler_FdEvent_ 1

// Custom includes
#include <boost/intrusive/set_hook.hpp>
#include <senf/Utils/Exception.hh>
#include "FdManager.hh"
#include "FIFORunner.hh"

//#include "FdEvent.mpp"
//-/////////////////////////////////////////////////////////////////////////////////////////////////

namespace senf {
namespace scheduler {

    namespace detail {
        struct FdSetTag;
        typedef boost::intrusive::set_base_hook< boost::intrusive::tag<FdSetTag> > FdSetBase;
        struct FdSetCompare;
        class FdDispatcher;
        class FileDispatcher;
    }

    class FdEvent
        : public detail::FIFORunner::TaskInfo,
          public detail::FdSetBase,
          public detail::FdManager::Event
    {
    public:
        //-////////////////////////////////////////////////////////////////////////
        // Types

        typedef boost::function<void (int)> Callback;

        enum Events {
            EV_NULL = 0                             
          , EV_READ = detail::FdManager::EV_READ    
          , EV_PRIO = detail::FdManager::EV_PRIO    
          , EV_WRITE = detail::FdManager::EV_WRITE  
          , EV_HUP = detail::FdManager::EV_HUP      
          , EV_ERR = detail::FdManager::EV_ERR      
          , EV_ALL = (detail::FdManager::EV_READ
                      | detail::FdManager::EV_WRITE
                      | detail::FdManager::EV_PRIO) 
        };

        //-////////////////////////////////////////////////////////////////////////
        //\{

        template <class Handle>
        FdEvent(std::string const & name, Callback const & cb, Handle const & handle, int events,
                bool initiallyEnabled = true);

        FdEvent(std::string const & name, Callback const & cb);

        ~FdEvent();

        //\}
        //-////////////////////////////////////////////////////////////////////////

        void disable();                 
        void enable();                  

        FdEvent & action(Callback const & cb); 

        FdEvent & events(int events);   
        FdEvent & addEvents(int events); 
        FdEvent & removeEvents(int events); 
        int events();                   

        template <class Handle>
        FdEvent & handle(Handle const & handle); 

        struct DuplicateEventRegistrationException : public Exception
        { DuplicateEventRegistrationException() : Exception("duplicate fd event registration") {} };

    protected:

    private:
        virtual void signal(int events);
        virtual void v_run();
        virtual char const * v_type() const;
        virtual std::string v_info() const;

        Callback cb_;
        int fd_;
        bool pollable_;
        int events_;
        int signaledEvents_;

        friend struct detail::FdSetCompare;
        friend class detail::FdDispatcher;
        friend class detail::FileDispatcher;
    };

    template <class Handle>
    int get_descriptor(Handle const & handle);
}}

//-/////////////////////////////////////////////////////////////////////////////////////////////////
#include "FdEvent.cci"
#include "FdEvent.ct"
#include "FdEvent.cti"
#endif


// Local Variables:
// mode: c++
// fill-column: 100
// comment-column: 40
// c-file-style: "senf"
// indent-tabs-mode: nil
// ispell-local-dictionary: "american"
// compile-command: "scons -u test"
// End: