senf/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_SENF_Utils_Logger_SyslogTarget_
  27 #define HH_SENF_Utils_Logger_SyslogTarget_ 1
  28
  29 // Custom includes
  30 #include <syslog.h>
  31 #include <boost/shared_ptr.hpp>
  32 #include "Target.hh"
  33
  34 //#include "SyslogTarget.mpp"
  35 ///////////////////////////////hh.p////////////////////////////////////////
  36
  37 namespace senf {
  38
  39     namespace console { class DirectoryNode; }
  40
  41 namespace log {
  42
  43     /** \brief Log target writing to the syslog
  44
  45         The SyslogTarget will send all log messages to the syslog at the given facility.
  46
  47         \code
  48         senf::log::SyslogTarget syslog;
  49
  50         // Route all messages to the syslog
  51         syslog.route();
  52         \endcode
  53
  54         Valid facility values (taken from <tt>man 3 syslog</tt>):
  55         \par ""
  56            <tt>LOG_AUTHPRIV</tt>, <tt>LOG_CRON</tt>, <tt>LOG_DAEMON</tt>, <tt>LOG_FTP</tt>,
  57            <tt>LOG_KERN</tt>, <tt>LOG_LOCAL0</tt>, <tt>LOG_LOCAL1</tt>, <tt>LOG_LOCAL2</tt>,
  58            <tt>LOG_LOCAL3</tt>, <tt>LOG_LOCAL4</tt>, <tt>LOG_LOCAL5</tt>, <tt>LOG_LOCAL6</tt>,
  59            <tt>LOG_LOCAL7</tt>, <tt>LOG_LPR</tt>, <tt>LOG_MAIL</tt>, <tt>LOG_NEWS</tt>,
  60            <tt>LOG_SYSLOG</tt>, <tt>LOG_USER</tt>, <tt>LOG_UUCP</tt>
  61
  62         The default facility is <tt>LOG_USER</tt>.
  63
  64         The SENF log levels are mapped to syslog levels in the following way:
  65
  66         <table class="senf fixedcolumn">
  67         <tr><td>senf::log::VERBOSE</td>   <td>\c LOG_DEBUG</td></tr>
  68         <tr><td>senf::log::NOTICE</td>    <td>\c LOG_INFO</td></tr>
  69         <tr><td>senf::log::MESSAGE</td>   <td>\c LOG_NOTICE</td></tr>
  70         <tr><td>senf::log::IMPORTANT</td> <td>\c LOG_WARNING</td></tr>
  71         <tr><td>senf::log::CRITICAL</td>  <td>\c LOG_CRIT</td></tr>
  72         <tr><td>senf::log::FATAL</td>     <td>\c LOG_EMERG</td></tr>
  73         </table>
  74
  75         \ingroup targets
  76      */
  77     class SyslogTarget
  78         : public Target
  79     {
  80     public:
  81         ///////////////////////////////////////////////////////////////////////////
  82         ///\name Structors and default members
  83         ///@{
  84
  85         explicit SyslogTarget(int facility = LOG_USER);
  86
  87         ///@}
  88         ///////////////////////////////////////////////////////////////////////////
  89
  90     private:
  91         void v_write(time_type timestamp, std::string const & stream,
  92                      std::string const & area, unsigned level,
  93                      std::string const & message);
  94
  95         int facility_;
  96
  97     public:
  98         static int const LEVELMAP[8];
  99
 100         enum LogFacility {
 101             AUTHPRIV = LOG_AUTHPRIV,
 102             CRON = LOG_CRON,
 103             DAEMON = LOG_DAEMON,
 104             FTP = LOG_FTP,
 105             KERN = LOG_KERN,
 106             LOCAL0 = LOG_LOCAL0,
 107             LOCAL1 = LOG_LOCAL1,
 108             LOCAL2 = LOG_LOCAL2,
 109             LOCAL3 = LOG_LOCAL3,
 110             LOCAL4 = LOG_LOCAL4,
 111             LOCAL5 = LOG_LOCAL5,
 112             LOCAL6 = LOG_LOCAL6,
 113             LOCAL7 = LOG_LOCAL7,
 114             LPR = LOG_LPR,
 115             MAIL = LOG_MAIL,
 116             NEWS = LOG_NEWS,
 117             SYSLOG = LOG_SYSLOG,
 118             USER = LOG_USER,
 119             UUCP = LOG_UUCP
 120         };
 121
 122     private:
 123         struct RegisterConsole {
 124             RegisterConsole();
 125             static boost::shared_ptr<senf::console::DirectoryNode> create(
 126                 LogFacility facility);
 127             static RegisterConsole instance;
 128         };
 129     };
 130
 131 }}
 132
 133 ///////////////////////////////hh.e////////////////////////////////////////
 134 #include "SyslogTarget.cci"
 135 //#include "SyslogTarget.ct"
 136 //#include "SyslogTarget.cti"
 137 #endif
 138
 139 \f
 140 // Local Variables:
 141 // mode: c++
 142 // fill-column: 100
 143 // comment-column: 40
 144 // c-file-style: "senf"
 145 // indent-tabs-mode: nil
 146 // ispell-local-dictionary: "american"
 147 // compile-command: "scons -u test"
 148 // End: