LogTarget.h
1/*
2 * Copyright (C) 2005-2012 by Dr. Marc Boris Duerner
3 *
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Lesser General Public
6 * License as published by the Free Software Foundation; either
7 * version 2.1 of the License, or (at your option) any later version.
8 *
9 * As a special exception, you may use this file as part of a free
10 * software library without restriction. Specifically, if other files
11 * instantiate templates or use macros or inline functions from this
12 * file, or you compile this file and link it with other files to
13 * produce an executable, this file does not by itself cause the
14 * resulting executable to be covered by the GNU General Public
15 * License. This exception does not however invalidate any other
16 * reasons why the executable file might be covered by the GNU Library
17 * General Public License.
18 *
19 * This library is distributed in the hope that it will be useful,
20 * but WITHOUT ANY WARRANTY; without even the implied warranty of
21 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
22 * Lesser General Public License for more details.
23 *
24 * You should have received a copy of the GNU Lesser General Public
25 * License along with this library; if not, write to the Free Software
26 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
27 */
28
29#ifndef Pt_System_LogTarget_h
30#define Pt_System_LogTarget_h
31
32#include <Pt/System/Api.h>
33#include <Pt/System/LogLevel.h>
34#include <Pt/NonCopyable.h>
35#include <Pt/Atomicity.h>
36#include <string>
37
38namespace Pt {
39
40namespace System {
41
42class LogChannel;
43class LogRecord;
44
62class PT_SYSTEM_API LogTarget : protected Pt::NonCopyable
63{
64 friend class LogManager;
65
66 protected:
68 LogTarget(const std::string& name, LogTarget* parent = 0);
69
70 public:
72 virtual ~LogTarget();
73
75 const std::string& name() const;
76
78 int logLevel() const
79 {
80 return atomicGet(_loglevel);
81 }
82
91 void setLogLevel(LogLevel level);
92
94 std::string channelUrl() const;
95
103 void setChannel(const std::string& url);
104
106 void reset();
107
109 void log(const LogRecord& record);
110
118 static LogTarget& get(const std::string& name);
119
120 protected:
122 LogTarget* parent() const
123 { return _parent; }
124
126 bool inheritsLogLevel() const;
127
129 void assignLogLevel(int level, bool inherited);
130
132 bool inheritsChannel() const;
133
135 LogChannel* channel() const
136 { return _channel; }
137
139 void removeChannel();
140
142 void assignChannel(LogChannel& ch);
143
144 private:
146 LogTarget* _parent;
147
149 std::string _name;
150
152 mutable volatile atomic_t _loglevel;
153
155 bool _inheritLogLevel;
156
158 LogChannel* _channel;
159
161 bool _inheritChannel;
162};
163
164} // namespace System
165
166} // namespace Pt
167
168#endif // Pt_System_LogTarget_h
Base class that disables copy construction and assignment.
Definition NonCopyable.h:59
Logging channel.
Definition LogChannel.h:52
Log records can be added to a log.
Definition LogRecord.h:94
void setLogLevel(LogLevel level)
Sets the log-level of the target and its children.
const std::string & name() const
Returns the name of the target.
virtual ~LogTarget()
Destructor.
void setChannel(const std::string &url)
Sets the channel to be used by this target.
void log(const LogRecord &record)
Write log record to this target.
static LogTarget & get(const std::string &name)
Get a target from the logging manager.
void reset()
Resets log level and channel.
std::string channelUrl() const
Returns the URL of the channel used by the target.
int logLevel() const
Returns the log level of the target.
Definition LogTarget.h:78
int atomicGet(volatile atomic_t &val)
Atomically get a value.
LogLevel
Severity of the log-message.
Definition LogLevel.h:41
System programming
Definition Connection.h:26
Core module.
Definition Allocator.h:33
Atomic integers to be used with atomicity functions.
Definition Atomicity.h:52