Utils/Logger/SyslogTarget.hh

   1 // $Id$
   2 //
   3 // Copyright (C) 2008
   4 // Fraunhofer Institute for Open Communication Systems (FOKUS)
   5 // Competence Center NETwork research (NET), St. Augustin, GERMANY
   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 /** \file
  24     \brief SyslogTarget public header */
  25
  26 #ifndef HH_SyslogTarget_
  27 #define HH_SyslogTarget_ 1
  28
  29 // Custom includes
  30 #include <syslog.h>
  31 #include "Target.hh"
  32
  33 //#include "SyslogTarget.mpp"
  34 ///////////////////////////////hh.p////////////////////////////////////////
  35
  36 namespace senf {
  37 namespace log {
  38
  39     /** \brief Log target writing to the syslog
  40
  41         The SyslogTarget will send all log messages to the syslog at the given facility.
  42
  43         \code
  44         senf::log::SyslogTarget syslog;
  45
  46         // Route all messages to the syslog
  47         syslog.route();
  48         \endcode
  49
  50         Valid facility values (taken from <tt>man 3 syslog</tt>):
  51         \par ""
  52            <tt>LOG_AUTHPRIV</tt>, <tt>LOG_CRON</tt>, <tt>LOG_DAEMON</tt>, <tt>LOG_FTP</tt>,
  53            <tt>LOG_KERN</tt>, <tt>LOG_LOCAL0</tt>, <tt>LOG_LOCAL1</tt>, <tt>LOG_LOCAL2</tt>,
  54            <tt>LOG_LOCAL3</tt>, <tt>LOG_LOCAL4</tt>, <tt>LOG_LOCAL5</tt>, <tt>LOG_LOCAL6</tt>,
  55            <tt>LOG_LOCAL7</tt>, <tt>LOG_LPR</tt>, <tt>LOG_MAIL</tt>, <tt>LOG_NEWS</tt>,
  56            <tt>LOG_SYSLOG</tt>, <tt>LOG_USER</tt>, <tt>LOG_UUCP</tt>
  57
  58         The default facility is <tt>LOG_USER</tt>.
  59
  60         The SENF log levels are mapped to syslog levels in the following way:
  61
  62         <table class="senf fixedcolumn">
  63         <tr><td>senf::log::VERBOSE</td>   <td>\c LOG_DEBUG</td></tr>
  64         <tr><td>senf::log::NOTICE</td>    <td>\c LOG_INFO</td></tr>
  65         <tr><td>senf::log::MESSAGE</td>   <td>\c LOG_NOTICE</td></tr>
  66         <tr><td>senf::log::IMPORTANT</td> <td>\c LOG_WARNING</td></tr>
  67         <tr><td>senf::log::CRITICAL</td>  <td>\c LOG_CRIT</td></tr>
  68         <tr><td>senf::log::FATAL</td>     <td>\c LOG_EMERG</td></tr>
  69         </table>
  70
  71         \ingroup targets
  72      */
  73     class SyslogTarget
  74         : public Target
  75     {
  76     public:
  77         ///////////////////////////////////////////////////////////////////////////
  78         ///\name Structors and default members
  79         ///@{
  80
  81         explicit SyslogTarget(int facility = LOG_USER);
  82
  83         ///@}
  84         ///////////////////////////////////////////////////////////////////////////
  85
  86     private:
  87         void v_write(time_type timestamp, std::string const & stream,
  88                      std::string const & area, unsigned level,
  89                      std::string const & message);
  90
  91         int facility_;
  92         static int const LEVELMAP_[8];
  93     };
  94
  95 }}
  96
  97 ///////////////////////////////hh.e////////////////////////////////////////
  98 #include "SyslogTarget.cci"
  99 //#include "SyslogTarget.ct"
 100 //#include "SyslogTarget.cti"
 101 #endif
 102
 103 \f
 104 // Local Variables:
 105 // mode: c++
 106 // fill-column: 100
 107 // comment-column: 40
 108 // c-file-style: "senf"
 109 // indent-tabs-mode: nil
 110 // ispell-local-dictionary: "american"
 111 // compile-command: "scons -u test"
 112 // End: