Utils/Logger: SyslogTarget documentation
[senf.git] / 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         Valid facility values (taken from <tt>man 3 syslog</tt>):
44         \par "" 
45            <tt>LOG_AUTHPRIV</tt>, <tt>LOG_CRON</tt>, <tt>LOG_DAEMON</tt>, <tt>LOG_FTP</tt>,
46            <tt>LOG_KERN</tt>, <tt>LOG_LOCAL0</tt>, <tt>LOG_LOCAL1</tt>, <tt>LOG_LOCAL2</tt>,
47            <tt>LOG_LOCAL3</tt>, <tt>LOG_LOCAL4</tt>, <tt>LOG_LOCAL5</tt>, <tt>LOG_LOCAL6</tt>,
48            <tt>LOG_LOCAL7</tt>, <tt>LOG_LPR</tt>, <tt>LOG_MAIL</tt>, <tt>LOG_NEWS</tt>,
49            <tt>LOG_SYSLOG</tt>, <tt>LOG_USER</tt>, <tt>LOG_UUCP</tt>
50
51         The default facility is <tt>LOG_USER</tt>.
52
53         \ingroup targets
54      */
55     class SyslogTarget 
56         : public Target
57     {
58     public:
59         ///////////////////////////////////////////////////////////////////////////
60         ///\name Structors and default members
61         ///@{
62
63         explicit SyslogTarget(int facility = LOG_USER);
64
65         ///@}
66         ///////////////////////////////////////////////////////////////////////////
67
68     private:
69         void v_write(time_type timestamp, std::string const & stream, 
70                      std::string const & area, unsigned level, 
71                      std::string const & message);
72
73         int facility_;
74         static int const LEVELMAP_[8];
75     };
76
77 }}
78
79 ///////////////////////////////hh.e////////////////////////////////////////
80 #include "SyslogTarget.cci"
81 //#include "SyslogTarget.ct"
82 //#include "SyslogTarget.cti"
83 #endif
84
85 \f
86 // Local Variables:
87 // mode: c++
88 // fill-column: 100
89 // comment-column: 40
90 // c-file-style: "senf"
91 // indent-tabs-mode: nil
92 // ispell-local-dictionary: "american"
93 // compile-command: "scons -u test"
94 // End: