2 * Copyright (c) 2014, Peter Thorson. All rights reserved.
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions are met:
6 * * Redistributions of source code must retain the above copyright
7 * notice, this list of conditions and the following disclaimer.
8 * * Redistributions in binary form must reproduce the above copyright
9 * notice, this list of conditions and the following disclaimer in the
10 * documentation and/or other materials provided with the distribution.
11 * * Neither the name of the WebSocket++ Project nor the
12 * names of its contributors may be used to endorse or promote products
13 * derived from this software without specific prior written permission.
15 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
16 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18 * ARE DISCLAIMED. IN NO EVENT SHALL PETER THORSON BE LIABLE FOR ANY
19 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
20 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
21 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
22 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
24 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 * The initial version of this logging policy was contributed to the WebSocket++
28 * project by Tom Hughes.
31 #ifndef WEBSOCKETPP_LOGGER_SYSLOG_HPP
32 #define WEBSOCKETPP_LOGGER_SYSLOG_HPP
36 #include <websocketpp/logger/basic.hpp>
38 #include <websocketpp/common/cpp11.hpp>
39 #include <websocketpp/logger/levels.hpp>
41 namespace websocketpp {
44 /// Basic logger that outputs to syslog
45 template <typename concurrency, typename names>
46 class syslog : public basic<concurrency, names> {
48 typedef basic<concurrency, names> base;
50 /// Construct the logger
52 * @param hint A channel type specific hint for how to construct the logger
54 syslog<concurrency,names>(channel_type_hint::value hint =
55 channel_type_hint::access)
56 : basic<concurrency,names>(hint), m_channel_type_hint(hint) {}
58 /// Construct the logger
60 * @param channels A set of channels to statically enable
61 * @param hint A channel type specific hint for how to construct the logger
63 syslog<concurrency,names>(level channels, channel_type_hint::value hint =
64 channel_type_hint::access)
65 : basic<concurrency,names>(channels, hint), m_channel_type_hint(hint) {}
67 /// Write a string message to the given channel
69 * @param channel The channel to write to
70 * @param msg The message to write
72 void write(level channel, std::string const & msg) {
73 write(channel, msg.c_str());
76 /// Write a cstring message to the given channel
78 * @param channel The channel to write to
79 * @param msg The message to write
81 void write(level channel, char const * msg) {
82 scoped_lock_type lock(base::m_lock);
83 if (!this->dynamic_test(channel)) { return; }
84 ::syslog(syslog_priority(channel), "[%s] %s",
85 names::channel_name(channel), msg);
88 typedef typename base::scoped_lock_type scoped_lock_type;
90 /// The default level is used for all access logs and any error logs that
91 /// don't trivially map to one of the standard syslog levels.
92 static int const default_level = LOG_INFO;
94 /// retrieve the syslog priority code given a WebSocket++ channel
96 * @param channel The level to look up
97 * @return The syslog level associated with `channel`
99 int syslog_priority(level channel) const {
100 if (m_channel_type_hint == channel_type_hint::access) {
101 return syslog_priority_access(channel);
103 return syslog_priority_error(channel);
107 /// retrieve the syslog priority code given a WebSocket++ error channel
109 * @param channel The level to look up
110 * @return The syslog level associated with `channel`
112 int syslog_priority_error(level channel) const {
116 case elevel::library:
127 return default_level;
131 /// retrieve the syslog priority code given a WebSocket++ access channel
133 * @param channel The level to look up
134 * @return The syslog level associated with `channel`
136 _WEBSOCKETPP_CONSTEXPR_TOKEN_ int syslog_priority_access(level) const {
137 return default_level;
140 channel_type_hint::value m_channel_type_hint;
146 #endif // WEBSOCKETPP_LOGGER_SYSLOG_HPP