senf::scheduler::IdleEvent Class Reference
#include <senf/Scheduler/IdleEvent.hh>
Inheritance diagram for senf::scheduler::IdleEvent:
Public Types | |
| typedef boost::function< void()> | Callback |
 Public Types inherited from senf::scheduler::detail::FIFORunner::TaskInfo | |
| enum | Priority { PRIORITY_LOW = 0, PRIORITY_NORMAL = 1, PRIORITY_HIGH = 2 } |
Public Member Functions | |
| void | disable () |
| Disable event. More... | |
| void | enable () |
| Enable event. More... | |
| void | action (Callback const &cb) |
| Change event callback. More... | |
| Public Member Functions inherited from senf::scheduler::detail::FIFORunner::TaskInfo | |
| TaskInfo (std::string const &name, Priority priority=PRIORITY_NORMAL) | |
| virtual | ~TaskInfo () |
| void | run () |
| bool | runnable () const |
| Public Member Functions inherited from senf::scheduler::detail::Event | |
| std::string const & | name () const |
| Get event name. More... | |
| bool | enabled () const |
true, if event is enabled, false otherwise More... | |
| unsigned | runCount () const |
| Number of times, event was fired. More... | |
| char const * | type () const |
| Event type code. More... | |
| std::string | info () const |
| Additional event information. More... | |
| Event (std::string const &name) | |
| virtual | ~Event () |
Structors and default members | |
| IdleEvent (std::string const &name, Callback const &cb, bool initiallyEnabled=true) | |
| ~IdleEvent () | |
Additional Inherited Members | |
| Protected Member Functions inherited from senf::scheduler::detail::FIFORunner::TaskInfo | |
| void | setRunnable () |
| Protected Member Functions inherited from senf::scheduler::detail::Event | |
| void | countRun () |
Detailed Description
Definition at line 37 of file IdleEvent.hh.
Member Typedef Documentation
◆ Callback
| typedef boost::function<void ()> senf::scheduler::IdleEvent::Callback |
Definition at line 45 of file IdleEvent.hh.
Constructor & Destructor Documentation
◆ IdleEvent()
| senf::scheduler::IdleEvent::IdleEvent | ( | std::string const & | name, |
| Callback const & | cb, | ||
| bool | initiallyEnabled = true |
||
| ) |
◆ ~IdleEvent()
| senf::scheduler::IdleEvent::~IdleEvent | ( | ) |
Member Function Documentation
◆ action()
| void senf::scheduler::IdleEvent::action | ( | Callback const & | cb | ) |
Change event callback.
◆ disable()
| void senf::scheduler::IdleEvent::disable | ( | ) |
Disable event.
◆ enable()
| void senf::scheduler::IdleEvent::enable | ( | ) |
Enable event.
The documentation for this class was generated from the following files: