1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
|
/*
* Copyright Andrey Semashev 2007 - 2015.
* Distributed under the Boost Software License, Version 1.0.
* (See accompanying file LICENSE_1_0.txt or copy at
* http://www.boost.org/LICENSE_1_0.txt)
*/
/*!
* \file channel_feature.hpp
* \author Andrey Semashev
* \date 28.02.2008
*
* The header contains implementation of a channel support feature.
*/
#ifndef BOOST_LOG_SOURCES_CHANNEL_FEATURE_HPP_INCLUDED_
#define BOOST_LOG_SOURCES_CHANNEL_FEATURE_HPP_INCLUDED_
#include <string>
#include <boost/move/core.hpp>
#include <boost/move/utility.hpp>
#include <boost/log/detail/config.hpp>
#include <boost/log/detail/locks.hpp>
#include <boost/log/detail/default_attribute_names.hpp>
#include <boost/log/keywords/channel.hpp>
#include <boost/log/attributes/mutable_constant.hpp>
#include <boost/log/utility/strictest_lock.hpp>
#include <boost/log/core/record.hpp>
#include <boost/log/detail/header.hpp>
#ifdef BOOST_HAS_PRAGMA_ONCE
#pragma once
#endif
namespace boost {
BOOST_LOG_OPEN_NAMESPACE
namespace sources {
/*!
* \brief Channel feature implementation
*/
template< typename BaseT, typename ChannelT >
class basic_channel_logger :
public BaseT
{
//! Base type
typedef BaseT base_type;
typedef basic_channel_logger this_type;
BOOST_COPYABLE_AND_MOVABLE_ALT(this_type)
public:
//! Character type
typedef typename base_type::char_type char_type;
//! Final type
typedef typename base_type::final_type final_type;
//! Threading model being used
typedef typename base_type::threading_model threading_model;
//! Channel type
typedef ChannelT channel_type;
//! Channel attribute type
typedef attributes::mutable_constant< channel_type > channel_attribute;
//! Lock requirement for the \c open_record_unlocked method
typedef typename strictest_lock<
typename base_type::open_record_lock,
#ifndef BOOST_LOG_NO_THREADS
boost::log::aux::exclusive_lock_guard< threading_model >
#else
no_lock< threading_model >
#endif // !defined(BOOST_LOG_NO_THREADS)
>::type open_record_lock;
//! Lock requirement for the \c swap_unlocked method
typedef typename strictest_lock<
typename base_type::swap_lock,
#ifndef BOOST_LOG_NO_THREADS
boost::log::aux::exclusive_lock_guard< threading_model >
#else
no_lock< threading_model >
#endif // !defined(BOOST_LOG_NO_THREADS)
>::type swap_lock;
private:
//! Default channel name generator
struct make_default_channel_name
{
typedef channel_type result_type;
result_type operator() () const { return result_type(); }
};
private:
//! Channel attribute
channel_attribute m_ChannelAttr;
public:
/*!
* Default constructor. The constructed logger has the default-constructed channel name.
*/
basic_channel_logger() : base_type(), m_ChannelAttr(channel_type())
{
base_type::add_attribute_unlocked(boost::log::aux::default_attribute_names::channel(), m_ChannelAttr);
}
/*!
* Copy constructor
*/
basic_channel_logger(basic_channel_logger const& that) :
base_type(static_cast< base_type const& >(that)),
m_ChannelAttr(that.m_ChannelAttr)
{
base_type::attributes()[boost::log::aux::default_attribute_names::channel()] = m_ChannelAttr;
}
/*!
* Move constructor
*/
basic_channel_logger(BOOST_RV_REF(basic_channel_logger) that) :
base_type(boost::move(static_cast< base_type& >(that))),
m_ChannelAttr(boost::move(that.m_ChannelAttr))
{
base_type::attributes()[boost::log::aux::default_attribute_names::channel()] = m_ChannelAttr;
}
/*!
* Constructor with arguments. Allows to register a channel name attribute on construction.
*
* \param args A set of named arguments. The following arguments are supported:
* \li \c channel - a string that represents the channel name
*/
template< typename ArgsT >
explicit basic_channel_logger(ArgsT const& args) :
base_type(args),
m_ChannelAttr(args[keywords::channel || make_default_channel_name()])
{
base_type::add_attribute_unlocked(boost::log::aux::default_attribute_names::channel(), m_ChannelAttr);
}
/*!
* The observer of the channel name
*
* \return The channel name that was set by the logger
*/
channel_type channel() const
{
BOOST_LOG_EXPR_IF_MT(boost::log::aux::shared_lock_guard< const threading_model > lock(this->get_threading_model());)
return m_ChannelAttr.get();
}
/*!
* The setter of the channel name
*
* \param ch The channel name to be set for the logger
*/
void channel(channel_type const& ch)
{
BOOST_LOG_EXPR_IF_MT(boost::log::aux::exclusive_lock_guard< threading_model > lock(this->get_threading_model());)
m_ChannelAttr.set(ch);
}
protected:
/*!
* Channel attribute accessor
*/
channel_attribute const& get_channel_attribute() const { return m_ChannelAttr; }
/*!
* Unlocked \c open_record
*/
template< typename ArgsT >
record open_record_unlocked(ArgsT const& args)
{
return open_record_with_channel_unlocked(args, args[keywords::channel | parameter::void_()]);
}
/*!
* Unlocked swap
*/
void swap_unlocked(basic_channel_logger& that)
{
base_type::swap_unlocked(static_cast< base_type& >(that));
m_ChannelAttr.swap(that.m_ChannelAttr);
}
private:
//! The \c open_record implementation for the case when the channel is specified in log statement
template< typename ArgsT, typename T >
record open_record_with_channel_unlocked(ArgsT const& args, T const& ch)
{
m_ChannelAttr.set(ch);
return base_type::open_record_unlocked(args);
}
//! The \c open_record implementation for the case when the channel is not specified in log statement
template< typename ArgsT >
record open_record_with_channel_unlocked(ArgsT const& args, parameter::void_)
{
return base_type::open_record_unlocked(args);
}
};
/*!
* \brief Channel support feature
*
* The logger with this feature automatically registers an attribute with the specified
* on construction value, which is a channel name. The channel name can be modified
* through the logger life time, either by calling the \c channel method or by specifying
* the name in the logging statement.
*
* The type of the channel name can be customized by providing it as a template parameter
* to the feature template. By default, a string will be used.
*/
template< typename ChannelT = std::string >
struct channel
{
template< typename BaseT >
struct apply
{
typedef basic_channel_logger<
BaseT,
ChannelT
> type;
};
};
} // namespace sources
BOOST_LOG_CLOSE_NAMESPACE // namespace log
} // namespace boost
//! The macro allows to put a record with a specific channel name into log
#define BOOST_LOG_STREAM_CHANNEL(logger, chan)\
BOOST_LOG_STREAM_WITH_PARAMS((logger), (::boost::log::keywords::channel = (chan)))
#ifndef BOOST_LOG_NO_SHORTHAND_NAMES
//! An equivalent to BOOST_LOG_STREAM_CHANNEL(logger, chan)
#define BOOST_LOG_CHANNEL(logger, chan) BOOST_LOG_STREAM_CHANNEL(logger, chan)
#endif // BOOST_LOG_NO_SHORTHAND_NAMES
#include <boost/log/detail/footer.hpp>
#endif // BOOST_LOG_SOURCES_CHANNEL_FEATURE_HPP_INCLUDED_
|
