websocketpp  0.5.1
C++/Boost Asio based websocket client/server library
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Pages
basic.hpp
1 /*
2  * Copyright (c) 2014, Peter Thorson. All rights reserved.
3  *
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.
14  *
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.
25  *
26  */
27 
28 #ifndef WEBSOCKETPP_LOGGER_BASIC_HPP
29 #define WEBSOCKETPP_LOGGER_BASIC_HPP
30 
31 /* Need a way to print a message to the log
32  *
33  * - timestamps
34  * - channels
35  * - thread safe
36  * - output to stdout or file
37  * - selective output channels, both compile time and runtime
38  * - named channels
39  * - ability to test whether a log message will be printed at compile time
40  *
41  */
42 
43 #include <websocketpp/logger/levels.hpp>
44 
45 #include <websocketpp/common/cpp11.hpp>
46 #include <websocketpp/common/stdint.hpp>
47 #include <websocketpp/common/time.hpp>
48 
49 #include <ctime>
50 #include <iostream>
51 #include <iomanip>
52 #include <string>
53 
54 namespace websocketpp {
55 namespace log {
56 
58 template <typename concurrency, typename names>
59 class basic {
60 public:
63  : m_static_channels(0xffffffff)
64  , m_dynamic_channels(0)
65  , m_out(h == channel_type_hint::error ? &std::cerr : &std::cout) {}
66 
67  basic<concurrency,names>(std::ostream * out)
68  : m_static_channels(0xffffffff)
69  , m_dynamic_channels(0)
70  , m_out(out) {}
71 
74  : m_static_channels(c)
75  , m_dynamic_channels(0)
76  , m_out(h == channel_type_hint::error ? &std::cerr : &std::cout) {}
77 
78  basic<concurrency,names>(level c, std::ostream * out)
79  : m_static_channels(c)
80  , m_dynamic_channels(0)
81  , m_out(out) {}
82 
83  void set_ostream(std::ostream * out = &std::cout) {
84  m_out = out;
85  }
86 
87  void set_channels(level channels) {
88  if (channels == names::none) {
89  clear_channels(names::all);
90  return;
91  }
92 
93  scoped_lock_type lock(m_lock);
94  m_dynamic_channels |= (channels & m_static_channels);
95  }
96 
97  void clear_channels(level channels) {
98  scoped_lock_type lock(m_lock);
99  m_dynamic_channels &= ~channels;
100  }
101 
103 
107  void write(level channel, std::string const & msg) {
108  scoped_lock_type lock(m_lock);
109  if (!this->dynamic_test(channel)) { return; }
110  *m_out << "[" << timestamp << "] "
111  << "[" << names::channel_name(channel) << "] "
112  << msg << "\n";
113  m_out->flush();
114  }
115 
117 
121  void write(level channel, char const * msg) {
122  scoped_lock_type lock(m_lock);
123  if (!this->dynamic_test(channel)) { return; }
124  *m_out << "[" << timestamp << "] "
125  << "[" << names::channel_name(channel) << "] "
126  << msg << "\n";
127  m_out->flush();
128  }
129 
130  _WEBSOCKETPP_CONSTEXPR_TOKEN_ bool static_test(level channel) const {
131  return ((channel & m_static_channels) != 0);
132  }
133 
134  bool dynamic_test(level channel) {
135  return ((channel & m_dynamic_channels) != 0);
136  }
137 
138 protected:
139  typedef typename concurrency::scoped_lock_type scoped_lock_type;
140  typedef typename concurrency::mutex_type mutex_type;
141  mutex_type m_lock;
142 
143 private:
144  // The timestamp does not include the time zone, because on Windows with the
145  // default registry settings, the time zone would be written out in full,
146  // which would be obnoxiously verbose.
147  //
148  // TODO: find a workaround for this or make this format user settable
149  static std::ostream & timestamp(std::ostream & os) {
150  std::time_t t = std::time(NULL);
151  std::tm lt = lib::localtime(t);
152  #ifdef _WEBSOCKETPP_PUTTIME_
153  return os << std::put_time(&lt,"%Y-%m-%d %H:%M:%S");
154  #else // Falls back to strftime, which requires a temporary copy of the string.
155  char buffer[20];
156  size_t result = std::strftime(buffer,sizeof(buffer),"%Y-%m-%d %H:%M:%S",&lt);
157  return os << (result == 0 ? "Unknown" : buffer);
158  #endif
159  }
160 
161  level const m_static_channels;
162  level m_dynamic_channels;
163  std::ostream * m_out;
164 };
165 
166 } // log
167 } // websocketpp
168 
169 #endif // WEBSOCKETPP_LOGGER_BASIC_HPP
uint32_t value
Type of a channel type hint value.
Definition: levels.hpp:48
static value const access
Access log.
Definition: levels.hpp:53
void write(level channel, char const *msg)
Write a cstring message to the given channel.
Definition: basic.hpp:121
void write(level channel, std::string const &msg)
Write a string message to the given channel.
Definition: basic.hpp:107
static value const error
Error log.
Definition: levels.hpp:55
Basic logger that outputs to an ostream.
Definition: basic.hpp:59
Namespace for the WebSocket++ project.
Definition: base64.hpp:41