Skip to content
Snippets Groups Projects
Commit 27c6da00 authored by tho's avatar tho
Browse files

small documentation fixes

parent d74bbe18
No related branches found
No related tags found
No related merge requests found
Hide whitespace changes
Inline Side-by-side
Scheduler/Scheduler.hh
+ 18
− 18
View file @ 27c6da00
...@@ -47,17 +47,17 @@ namespace senf { ...@@ -47,17 +47,17 @@ namespace senf {
/** \brief Singleton class to manage the event loop /** \brief Singleton class to manage the event loop
The Scheduler singleton manages the central event loop. It manages and dispatches all types The %scheduler singleton manages the central event loop. It manages and dispatches all types
of events managed by the scheduler library: of events managed by the scheduler library:
\li File descriptor notifications \li File descriptor notifications
\li Timeouts \li Timeouts
\li UNIX Signals \li UNIX Signals
The scheduler is entered by calling it's process() member. This call will continue to run as The %scheduler is entered by calling it's process() member. This call will continue to run as
long as there is something to do, or until one of the handlers calls terminate(). The long as there is something to do, or until one of the handlers calls terminate(). The
Scheduler has 'something to do' as long as there is any file descriptor or timeout active. %scheduler has 'something to do' as long as there is any file descriptor or timeout active.
The Scheduler only provides low level primitive scheduling capability. Additional helpers The %scheduler only provides low level primitive scheduling capability. Additional helpers
are defined on top of this functionality (e.g. ReadHelper or WriteHelper or the interval are defined on top of this functionality (e.g. ReadHelper or WriteHelper or the interval
timers of the PPI). timers of the PPI).
...@@ -67,7 +67,7 @@ namespace senf { ...@@ -67,7 +67,7 @@ namespace senf {
All handlers are passed as generic <a All handlers are passed as generic <a
href="http://www.boost.org/doc/html/function.html">Boost.Function</a> objects. This allows href="http://www.boost.org/doc/html/function.html">Boost.Function</a> objects. This allows
to pass any callable as a handler. Depending on the type of handler, some additional to pass any callable as a handler. Depending on the type of handler, some additional
arguments may be passed to the handler by the scheduler. arguments may be passed to the handler by the %scheduler.
If you need to pass additional information to your handler, use <a If you need to pass additional information to your handler, use <a
href="http://www.boost.org/libs/bind/bind.html">Boost.Bind</a>: href="http://www.boost.org/libs/bind/bind.html">Boost.Bind</a>:
...@@ -101,7 +101,7 @@ namespace senf { ...@@ -101,7 +101,7 @@ namespace senf {
Only a single handler may be registered for any combination of file descriptor and event Only a single handler may be registered for any combination of file descriptor and event
(registering multiple callbacks for a single fd and event does not make sense). (registering multiple callbacks for a single fd and event does not make sense).
The scheduler will accept any object as \a handle argument as long as retrieve_filehandle() The %scheduler will accept any object as \a handle argument as long as retrieve_filehandle()
may be called on that object may be called on that object
\code \code
int fd = retrieve_filehandle(handle); int fd = retrieve_filehandle(handle);
...@@ -113,7 +113,7 @@ namespace senf { ...@@ -113,7 +113,7 @@ namespace senf {
\section sched_timers Registering timers \section sched_timers Registering timers
The Scheduler has very simple timer support. There is only one type of timer: A single-shot The %scheduler has very simple timer support. There is only one type of timer: A single-shot
deadline timer. More complex timers are built based on this. Timers are managed using deadline timer. More complex timers are built based on this. Timers are managed using
timeout() and cancelTimeout() timeout() and cancelTimeout()
\code \code
...@@ -128,7 +128,7 @@ namespace senf { ...@@ -128,7 +128,7 @@ namespace senf {
There are two parameters which adjust the exact: \a timeoutEarly and \a timeoutAdjust. \a There are two parameters which adjust the exact: \a timeoutEarly and \a timeoutAdjust. \a
timeoutEarly is the time, a callback may be called before the deadline time is timeoutEarly is the time, a callback may be called before the deadline time is
reached. Setting this value below the scheduling granularity of the kernel will have the reached. Setting this value below the scheduling granularity of the kernel will have the
scheduler go into a <em>busy wait</em> (that is, an endless loop consuming 100% of CPU %scheduler go into a <em>busy wait</em> (that is, an endless loop consuming 100% of CPU
recources) until the deadline time is reached! This is seldom desired. The default setting recources) until the deadline time is reached! This is seldom desired. The default setting
of 11ms is adequate in most cases (it's slightly above the lowest linux scheduling of 11ms is adequate in most cases (it's slightly above the lowest linux scheduling
granularity). granularity).
...@@ -140,14 +140,14 @@ namespace senf { ...@@ -140,14 +140,14 @@ namespace senf {
\section sched_signals Registering POSIX/UNIX signals \section sched_signals Registering POSIX/UNIX signals
The Scheduler also incorporates standard POSIX/UNIX signals. Signals registered with the The %scheduler also incorporates standard POSIX/UNIX signals. Signals registered with the
scheduler will be handled \e synchronously within the event loop. %scheduler will be handled \e synchronously within the event loop.
\code \code
Scheduler::instance().registerSignal(SIGUSR1, &callback); Scheduler::instance().registerSignal(SIGUSR1, &callback);
Scheduler::instance().unregisterSignal(SIGUSR1); Scheduler::instance().unregisterSignal(SIGUSR1);
\endcode \endcode
When registering a signal with the scheduler, that signal will automatically be blocked so When registering a signal with the %scheduler, that signal will automatically be blocked so
it can be handled within the scheduler. it can be handled within the %scheduler.
A registered signal does \e not count as 'something to do'. It is therefore not possible to A registered signal does \e not count as 'something to do'. It is therefore not possible to
wait for signals \e only. wait for signals \e only.
...@@ -202,13 +202,13 @@ namespace senf { ...@@ -202,13 +202,13 @@ namespace senf {
// default destructor // default destructor
// no conversion constructors // no conversion constructors
/** \brief Return Scheduler instance /** \brief Return %scheduler instance
This static member is used to access the singleton instance. This member is save to This static member is used to access the singleton instance. This member is save to
return a correctly initialized Scheduler instance even if called at global construction return a correctly initialized %scheduler instance even if called at global construction
time time
\implementation This static member just defines the Scheduler as a static method \implementation This static member just defines the %scheduler as a static method
variable. The C++ standard then provides above guarantee. The instance will be variable. The C++ standard then provides above guarantee. The instance will be
initialized the first time, the code flow passes the variable declaration found in initialized the first time, the code flow passes the variable declaration found in
the instance() body. the instance() body.
...@@ -224,7 +224,7 @@ namespace senf { ...@@ -224,7 +224,7 @@ namespace senf {
template <class Handle> template <class Handle>
void add(Handle const & handle, FdCallback const & cb, void add(Handle const & handle, FdCallback const & cb,
int eventMask = EV_ALL); ///< Add file handle event callback int eventMask = EV_ALL); ///< Add file handle event callback
/**< add() will add a callback to the Scheduler. The /**< add() will add a callback to the %scheduler. The
callback will be called for the given type of event on callback will be called for the given type of event on
the given arbitrary file-descriptor or the given arbitrary file-descriptor or
handle-like object. If there already is a Callback handle-like object. If there already is a Callback
...@@ -394,14 +394,14 @@ namespace senf { ...@@ -394,14 +394,14 @@ namespace senf {
/** \brief Default file descriptor accessor /** \brief Default file descriptor accessor
retrieve_filehandle() provides the Scheduler with support for explicit file descriptors as retrieve_filehandle() provides the %scheduler with support for explicit file descriptors as
file handle argument. file handle argument.
\relates Scheduler \relates Scheduler
*/ */
int retrieve_filehandle(int fd); int retrieve_filehandle(int fd);
/** \brief Scheduler specific time source for Utils/Logger framework /** \brief %scheduler specific time source for Utils/Logger framework
This time source may be used to provide timing information for log messages within the This time source may be used to provide timing information for log messages within the
Utils/Logger framework. This time source will use Scheduler::eventTime() to provide timing Utils/Logger framework. This time source will use Scheduler::eventTime() to provide timing
......
Utils/Logger/Levels.hh
+ 8
− 9
View file @ 27c6da00
...@@ -37,9 +37,9 @@ namespace log { ...@@ -37,9 +37,9 @@ namespace log {
/** \defgroup loglevels Log levels /** \defgroup loglevels Log levels
These are the valid log levels with some additional special values: These are the valid %log levels with some additional special values:
<dl><dt>VERBOSE</dt><dd>Really verbose log messages. Messages at this level are used for <dl><dt>VERBOSE</dt><dd>Really verbose %log messages. Messages at this level are used for
internal debugging. They should be enabled only selectively within the areas currently under internal debugging. They should be enabled only selectively within the areas currently under
inspection.</dd> inspection.</dd>
...@@ -57,22 +57,21 @@ namespace log { ...@@ -57,22 +57,21 @@ namespace log {
<dt>FATAL</dt><dd>Error condition which does terminate program execution or enforces a <dt>FATAL</dt><dd>Error condition which does terminate program execution or enforces a
restart or some kind of re-initialization with loss of state and context.</dd></dl> restart or some kind of re-initialization with loss of state and context.</dd></dl>
There are also some special values which <em>must not be used as a log level</em>: There are also some special values which <em>must not be used as a %log level</em>:
<dl><dt>DISABLED</dt><dd>Disable all log messages.</dd> <dl><dt>DISABLED</dt><dd>Disable all %log messages.</dd>
<dt>NONE</dt><dd>Special value which signifies inheritance of the default log <dt>NONE</dt><dd>Special value which signifies inheritance of the default %log
level.</dd></dl> level.</dd></dl>
Log levels are classes, not numbers. Each log level class has a \c value member which gives Log levels are classes, not numbers. Each %log level class has a \c value member which gives
that levels numeric priority. The larger the number, the more important the message is. that levels numeric priority. The larger the number, the more important the message is.
\implementation The log levels need to be classes since areas and streams are classes: Since \implementation The %log levels need to be classes since areas and streams are classes: Since
log arguments (stream, area and level) may appear in any order and number, it is much %log arguments (stream, area and level) may appear in any order and number, it is much
simpler to parse them if they are all of the same type. simpler to parse them if they are all of the same type.
*/ */
///\ingroup loglevels
///\{ ///\{
/** \brief Log level VERBOSE /** \brief Log level VERBOSE
......
Utils/Logger/Log.hh
+ 11
− 11
View file @ 27c6da00
...@@ -39,7 +39,7 @@ ...@@ -39,7 +39,7 @@
/** \defgroup logging Logging commands /** \defgroup logging Logging commands
The logging library provides several commands to create log messages. All these macro commands The logging library provides several commands to create %log messages. All these macro commands
take a variable number of arguments. Since this is not supported in a usable way by the C++ take a variable number of arguments. Since this is not supported in a usable way by the C++
preprocessor, the arguments are encoded into a <a preprocessor, the arguments are encoded into a <a
href="http://www.boost.org/libs/preprocessor/doc/index.html">Boost.Preprocessor</a> like href="http://www.boost.org/libs/preprocessor/doc/index.html">Boost.Preprocessor</a> like
...@@ -49,13 +49,13 @@ ...@@ -49,13 +49,13 @@
SENF_LOG( (senf::log::Debug)(senf::log::NOTICE)(FroblizerArea)("The log message") ); SENF_LOG( (senf::log::Debug)(senf::log::NOTICE)(FroblizerArea)("The log message") );
\endcode \endcode
The argument is comprised of a sequence of parameters and the log message itself. The parameters The argument is comprised of a sequence of parameters and the %log message itself.
are The parameters are
\li the <em>log stream</em>, - the <em>%log stream</em>,
\li the <em>log area</em>, - the <em>%log area</em>,
\li the <em>log level</em>. - the <em>%log level</em>.
These parameters are optional and may be specified <i>in arbitrary order</i> (with the log These parameters are optional and may be specified <i>in arbitrary order</i> (with the %log
message always being the last sequence element) and even multiple times in the parameter message always being the last sequence element) and even multiple times in the parameter
sequence. If some argument type occurs multiple times, the last occurrence wins. If any one of sequence. If some argument type occurs multiple times, the last occurrence wins. If any one of
the parameters is not specified, it's current default value will be used. the parameters is not specified, it's current default value will be used.
...@@ -69,20 +69,20 @@ ...@@ -69,20 +69,20 @@
The logging library defines the global defaults for stream, area and level to be \c The logging library defines the global defaults for stream, area and level to be \c
senf::log::Debug, senf::log::DefaultArea, and senf::log::NONE respectively. senf::log::Debug, senf::log::DefaultArea, and senf::log::NONE respectively.
The log level senf::log::NONE is special. If the log level is set to this value, the log level The %log level senf::log::NONE is special. If the %log level is set to this value, the %log level
will be set from the stream provided default value. will be set from the stream provided default value.
All these parameters must be <em>compile time constants</em> (they are all types, so it's All these parameters must be <em>compile time constants</em> (they are all types, so it's
difficult form them to be something else). difficult for them to be something else).
\section logging_aliases Aliases \section logging_aliases Aliases
To further simplify logging commands, aliases may be defined within any scope. An alias is an To further simplify logging commands, aliases may be defined within any scope. An alias is an
arbitrary collection of log parameters: arbitrary collection of %log parameters:
\code \code
SENF_LOG_DEF_ALIAS( VerboseDebug, (senf::log::Debug)(senf::log::VERBOSE) ); SENF_LOG_DEF_ALIAS( VerboseDebug, (senf::log::Debug)(senf::log::VERBOSE) );
\endcode \endcode
Within log statements, aliases may be used like normal parameters. They will be substituted for Within %log statements, aliases may be used like normal parameters. They will be substituted for
the parameter sequence they represent: the parameter sequence they represent:
\code \code
SENF_LOG( (VerboseDebug)("Debug message") ) SENF_LOG( (VerboseDebug)("Debug message") )
......
Utils/Logger/Target.hh
+ 1
− 1
View file @ 27c6da00
...@@ -114,7 +114,7 @@ namespace log { ...@@ -114,7 +114,7 @@ namespace log {
The target may process in any arbitrary way: reformat, writing it into an SQL DB, whatever The target may process in any arbitrary way: reformat, writing it into an SQL DB, whatever
can be envisioned. However, there is one important limitation: The \c v_write call must not can be envisioned. However, there is one important limitation: The \c v_write call must not
block. So for more complex scenarios, additional measures must be taken (e.g. writing a log block. So for more complex scenarios, additional measures must be taken (e.g. writing a %log
backend daemon which receives the messages via UDP and processes them). Of course, in rare backend daemon which receives the messages via UDP and processes them). Of course, in rare
cases messages might be lost but this cannot be avoided. cases messages might be lost but this cannot be avoided.
......
Utils/Tags.hh
+ 0
− 3
View file @ 27c6da00
...@@ -47,7 +47,6 @@ ...@@ -47,7 +47,6 @@
Of course, this only works with objects which explicitly declare, that they take an optional Of course, this only works with objects which explicitly declare, that they take an optional
senf::NoThrow_t type aprameter. senf::NoThrow_t type aprameter.
*/ */
namespace senf { namespace senf {
...@@ -61,7 +60,6 @@ namespace senf { ...@@ -61,7 +60,6 @@ namespace senf {
There is only a single value for this type: \ref senf::nothrow which is the value to pass There is only a single value for this type: \ref senf::nothrow which is the value to pass
wherever an (optional) senf::NoThrow_t parameter is requested. wherever an (optional) senf::NoThrow_t parameter is requested.
\see \ref utils_tags
\ingroup utils_tags \ingroup utils_tags
*/ */
enum NoThrow_t { nothrow }; enum NoThrow_t { nothrow };
...@@ -75,7 +73,6 @@ namespace senf { ...@@ -75,7 +73,6 @@ namespace senf {
There is only a single value for this type: \ref senf::noinit which is the value to pass There is only a single value for this type: \ref senf::noinit which is the value to pass
wherever an (optional) senf::NoInit_t parameter is requested. wherever an (optional) senf::NoInit_t parameter is requested.
\see \ref utils_tags
\ingroup utils_tags \ingroup utils_tags
*/ */
enum NoInit_t { noinit }; enum NoInit_t { noinit };
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment

Datenschutz und Impressum