senf::ppi::IdleEvent Class Reference

Continually signaled event. More...

#include <senf/PPI/IdleEvent.hh>

Inheritance diagram for senf::ppi::IdleEvent:

Public Member Functions

 IdleEvent (std::string const &name="")
 
- Public Member Functions inherited from senf::ppi::EventImplementation<>
module::Modulemodule () const
 Module in which the event is registered. More...
 
EventManagermanager () const
 EventManager of the event. More...
 
- Public Member Functions inherited from senf::ppi::EventDescriptor
virtual ~EventDescriptor ()
 
bool enabled () const
 Check, whether the event is currently enabled. More...
 
void enabled (bool v)
 Enable or disable the event. More...
 

Additional Inherited Members

- Public Types inherited from senf::ppi::EventImplementation<>
typedef EventType Event
 
typedef detail::EventArgType< EventType >::type EventArg
 
- Protected Types inherited from senf::ppi::EventImplementationHelper< EventType, Self >
typedef detail::EventArgType< EventType >::type EventArg
 
- Protected Member Functions inherited from senf::ppi::EventImplementation<>
 EventImplementation ()
 
- Protected Member Functions inherited from senf::ppi::EventDescriptor
 EventDescriptor ()
 
- Protected Member Functions inherited from senf::ppi::EventImplementationHelper< EventType, Self >
void callback (EventArg event, ClockService::clock_type time)
 Forward event to user callback. More...
 
void callback (EventArg event)
 Forward event to user callback. More...
 

Detailed Description

Continually signaled event.

An IdleEvent is signaled continually and repeatedly while enabled. It will consume 100% of available CPU resources. The resource usage is controlled by adequate event throttling.

Definition at line 37 of file IdleEvent.hh.

Constructor & Destructor Documentation

◆ IdleEvent()

senf::ppi::IdleEvent::IdleEvent ( std::string const &  name = "")

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