\autotoc
\section scheduler_scheduler The Scheduler
+ \seechapter \ref senf::scheduler
+
+ The %scheduler provides a single threaded event dispatch architecture with reliable task
+ queueing using FIFO scheduling. The %scheduler provides event handling for
- The main interface is the senf::Scheduler class. This provides support for several types of
- events:
\li File descriptors
\li Timers
\li UNIX signals
- \see senf::Scheduler
-
-
\section scheduler_clockservice The ClockService
+ \seechapter senf::ClockService
To support precise event timing, the senf::ClockService class implements a reliable monotonous
time source. It is based on the high precision POSIX clock and adds support for reliable
conversion between an abstract clock type and absolute date/time
- \see senf::ClockService
-
-
\section scheduler_helpers Miscellaneous helpers
To ease the use of the Scheduler there are some additional helpers managing callbacks and
is met (e.g. number of chars read or a specific character sequence is found in the input).
\li senf::WriteHelper writes data to an arbitrary file descriptor until all provided data has
been written.
- \li senf::SchedulerBinding is an RAII class which manages the registration of a file descriptor
- with the %scheduler.
- \li senf::SchedulerTimer is an RAII class which manages a timer registration.
-
\section scheduler_i Implementation
+ \seechapter \ref scheduler_implementation
senf::Scheduler is only a wrapper around the real implementation. The real implementation is now
based on a modular dispatcher architecture
- \see \ref scheduler_implementation
*/
/** \page scheduler_implementation The Scheduler Implementation
\li Every registered event is represented by an event specific event class instance.
- \li The Dispatcher ultimately registeres with the senf::scheduler::FdManager. Since the
+ \li The Dispatcher ultimately registeres with the senf::scheduler::detail::FdManager. Since the
event-loop is based on epoll() (it could easily be changed to be based on select() or
poll()), all events must ultimately be represented by some type of file descriptor (not
necessarily a \e different file descriptor for each event).
\li The Dispatcher registeres all callbacks as tasks with the runner
- (senf::scheduler::FIFORunner).
+ (senf::scheduler::detail::FIFORunner).
- \li The senf::scheduler::FdManager uses senf::scheduler::detail::Poller to access the low-level epoll()
- API.
+ \li The senf::scheduler::detail::FdManager uses senf::scheduler::detail::Poller to access the
+ low-level epoll() API.
- All these classes are \e not singletons. They are all instantiatied by the senf::Scheduler
- singleton.
+ All these classes are singletons.
\section scheduler_i_dispatchers Dispatchers
- There is one dispatcher for each event type
+ There is a dispatcher for each event type
- \li senf::scheduler::FdDispatcher manages poll-able file descriptors. This does \e not include
- real files.
- \li senf::scheduler::FileDispatcher manages disk files
- \li senf::scheduler::TimerDispatcher manages timers
- \li senf::scheduler::SignalDispatcher manages UNIX signals
+ \li senf::scheduler::detail::FdDispatcher manages poll-able file descriptors. This does \e not
+ include real files.
+ \li senf::scheduler::detail::FileDispatcher manages disk files
+ \li senf::scheduler::detail::TimerDispatcher manages timers
+ \li senf::scheduler::detail::SignalDispatcher manages UNIX signals
- At the moment, each dispatcher has a specific API and the integration into the main-loop is not
- standardized for performance reasons.
+ Each dispatcher has a specific API and the integration into the main-loop is not standardized
+ for performance reasons.
- The Dispatcher owns all relevant data, the other classese (senf::scheduler::FIFORunner,
- senf::scheduler::FdManager) only hold pointers to the data owned by the dispatcher.
+ The Dispatcher does not own the event instances, instead those instances are owned by the
+ respective object creating the event. The implementation uses boost::intrusive containeres to
+ manage the events. This makes the Scheduler itself be completely devoid of dynamic memory
+ allocations.
\section scheduler_i_mainloop The main loop
- The application mainloop is part of senf::Scheduler. It is constructed by calling the correct
- members of all these classes repeatedly in the correct order:
+ The application mainloop senf::scheduler::process() is constructed by calling the correct
+ members of all these classes repeatedly in the correct order:
+
\li First dispatchers are set up
\li then the senf::scheduler::FdManager is called to wait for an event
\li After cleaning up the dispatchers,
projects / senf.git / blobdiff