Utils/Logger/Mainpage.dox

   1 // $Id$
   2 //
   3 // Copyright (C) 2007
   4 // Fraunhofer Institut fuer offene Kommunikationssysteme (FOKUS)
   5 // Kompetenzzentrum fuer Satelitenkommunikation (SatCom)
   6 //     Stefan Bund <g0dil@berlios.de>
   7 //
   8 // This program is free software; you can redistribute it and/or modify
   9 // it under the terms of the GNU General Public License as published by
  10 // the Free Software Foundation; either version 2 of the License, or
  11 // (at your option) any later version.
  12 //
  13 // This program is distributed in the hope that it will be useful,
  14 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  15 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16 // GNU General Public License for more details.
  17 //
  18 // You should have received a copy of the GNU General Public License
  19 // along with this program; if not, write to the
  20 // Free Software Foundation, Inc.,
  21 // 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  22
  23 /** \mainpage The SENF Logging library
  24
  25     The Loggger infrastructure implements a highly flexible compile- and run-time configurable
  26     logging infrastructure supporting multiple streams, user definable log areas and fine grained
  27     log levels. Logging can be configured at compile and runtime on any combination of above
  28     parameters. The library supports a host of log targets and messages can be routed into multiple
  29     targets at the same time. To allow concise usage of the library, a utility to define logging
  30     defaults for any scope is provided.
  31
  32     \see
  33         \ref logging \n
  34         \ref config \n
  35
  36     \section logging_tutorial Tutorial introduction
  37
  38     Using the logging library mostly concerns using \ref SENF_LOG statements in your code. There are
  39     some other helpers used to simplify specifying parameters.
  40
  41     \code
  42     namespace foo {
  43
  44         // Define a new log stream with default level, runtime limit and compile time limit
  45         // set to senf::log::MESSAGE
  46         SENF_LOG_DEF_STREAM( UserLog, senf::log::MESSAGE, senf::log::MESSAGE, senf::log::MESSAGE );
  47
  48         class Froblizer
  49         {
  50             // Define a log area which will automatically be used by all members of this class.
  51             // This is a combination of SENF_LOG_DEF_AREA and SENF_LOG_DEFAULT_AREA.
  52             SENF_LOG_CLASS_AREA();
  53
  54             // Set default log parameters for this scope.
  55             SENF_LOG_DEFAULT_STREAM(foo::UserLog);
  56             SENF_LOG_DEFAULT_LEVEL(senf::log::NOTICE);
  57
  58             // Define an alias for emergency debug messages
  59             // The log area is inherited from the default at the place, where this
  60             // alias is used *not* where it is defined
  61             SENF_LOG_DEF_ALIAS(LogEmerg, (senf::log::Debug)(senf::log::CRITICAL));
  62
  63             void test();
  64
  65         public:
  66             void froblize();
  67         };
  68     }
  69
  70     void foo::Froblizer::froblize()
  71     {
  72         SENF_LOG(("This is the UserLog at level NOTICE in the FroblizeArea"));
  73         SENF_LOG((senf::log::WARNING) ("Same stream and area but at warning level"));
  74         SENF_LOG((LogEmerg) ("This goes to the DebugLog at level CRITICAL in the FroblizerArea"));
  75     }
  76
  77     void foo::Froblizer::test()
  78     {
  79         // Change the default log level for this method. stream and area are taken
  80         // from the next scope up
  81         SENF_LOG_DEFAULT_LEVEL(senf::log::VERBOSE);
  82
  83         SENF_LOG(("Log to UserLog stream in Froblizer area however at VERBOSE level"));
  84     }
  85     \endcode
  86
  87     \implementation I would have much preferred a more C++ like implementation. However given the
  88         design goals
  89         \li Flexible configuration at compile and runtime
  90         \li Concise usage and simple interface
  91         \li Zero overhead for compile-time disabled log messages
  92
  93         I did not find any non-mcaro implementation which was not either completely convoluted,
  94         unusable or slow. So I turned to a macro based implementation which can provide all the
  95         design goals stated above.
  96  */
  97
  98 \f
  99 // Local Variables:
 100 // mode: c++
 101 // fill-column: 100
 102 // comment-column: 40
 103 // c-file-style: "senf"
 104 // indent-tabs-mode: nil
 105 // ispell-local-dictionary: "american"
 106 // compile-command: "scons -u test"
 107 // mode: flyspell
 108 // mode: auto-fill
 109 // End: