Fix documentation build under maverick (doxygen 1.7.1)
[senf.git] / senf / Utils / Logger / SyslogTarget.cc
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 non-inline non-template implementation */
25
26 #include "SyslogTarget.hh"
27 //#include "SyslogTarget.ih"
28
29 // Custom includes
30 #include <senf/Utils/Console/ParsedCommand.hh>
31 #include <senf/Utils/Console/Traits.hh>
32 #include <senf/Utils/Console/ScopedDirectory.hh>
33
34 //#include "SyslogTarget.mpp"
35 #define prefix_
36 //-/////////////////////////////////////////////////////////////////////////////////////////////////
37
38 int const senf::log::SyslogTarget::LEVELMAP[8] = {
39     0, LOG_DEBUG, LOG_INFO, LOG_NOTICE, LOG_WARNING, LOG_CRIT, LOG_EMERG, 0 };
40
41 prefix_ void senf::log::SyslogTarget::v_write(time_type timestamp, std::string const & stream,
42                                               std::string const & area, unsigned level,
43                                               std::string const & message)
44 {
45     if (area != "senf::log::DefaultArea")
46         syslog(facility_ | LEVELMAP[level], "[%s] %s", area.c_str(), message.c_str());
47     else
48         syslog(facility_ | LEVELMAP[level], "%s", message.c_str());
49 }
50
51 namespace senf {
52 namespace log {
53
54     SENF_CONSOLE_REGISTER_ENUM_MEMBER(SyslogTarget, LogFacility,
55                                       (AUTHPRIV)(CRON)(DAEMON)(FTP)(KERN)(LPR)(MAIL)(NEWS)(SYSLOG)
56                                       (USER)(UUCP)(LOCAL0)(LOCAL1)(LOCAL2)(LOCAL3)(LOCAL4)(LOCAL5)
57                                       (LOCAL6)(LOCAL7));
58
59 }}
60
61 prefix_ senf::log::SyslogTarget::RegisterConsole::RegisterConsole()
62 {
63     namespace kw = senf::console::kw;
64     namespace fty = senf::console::factory;
65
66     detail::TargetRegistry::instance().consoleDir()
67         .add("syslog-target",fty::Command(&RegisterConsole::create)
68              .arg("facility", "syslog facility to send messages to. One of\n"
69                   "                  AUTHPRIV CRON DAEMON FTP KERN LPR MAIL NEWS SYSLOG USER\n"
70                   "                  UUCP LOCAL0 LOCAL1 LOCAL2 LOCAL3 LOCAL4 LOCAL5 LOCAL6 LOCAL7",
71                   kw::default_value = USER)
72              .doc("Create new syslog target. Examples:\n"
73                   "\n"
74                   "Create new syslog target\n"
75                   "    $ syslog-target\n"
76                   "    <Directory '/sys/log/syslog'>\n"
77                   "\n"
78                   "In a configuration file, create new syslog target and set some parameters (If\n"
79                   "written on one line, this works at the console too:\n"
80                   "    /sys/log/syslog-target LOCAL2 {\n"
81                   "        route (IMPORTANT);             # route all important messages\n"
82                   "        timeFormat \"\";               # use non-formatted time format\n"
83                   "        showArea false;                # don't show log area\n"
84                   "    }\n") );
85 }
86
87 prefix_ boost::shared_ptr<senf::console::DirectoryNode>
88 senf::log::SyslogTarget::RegisterConsole::create(LogFacility facility)
89 {
90     std::auto_ptr<Target> tp (new SyslogTarget(facility));
91     Target & target (*tp.get());
92     detail::TargetRegistry::instance().dynamicTarget(tp);
93     return target.consoleDir().node().thisptr();
94 }
95
96 //-/////////////////////////////////////////////////////////////////////////////////////////////////
97 #undef prefix_
98 //#include "SyslogTarget.mpp"
99
100 \f
101 // Local Variables:
102 // mode: c++
103 // fill-column: 100
104 // comment-column: 40
105 // c-file-style: "senf"
106 // indent-tabs-mode: nil
107 // ispell-local-dictionary: "american"
108 // compile-command: "scons -u test"
109 // End: