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.
28 #ifndef WEBSOCKETPP_LOGGER_STUB_HPP
29 #define WEBSOCKETPP_LOGGER_STUB_HPP
31 #include <websocketpp/logger/levels.hpp>
33 #include <websocketpp/common/cpp11.hpp>
37 namespace websocketpp {
40 /// Stub logger that ignores all input
43 /// Construct the logger
45 * @param hint A channel type specific hint for how to construct the logger
47 explicit stub(channel_type_hint::value) {}
49 /// Construct the logger
51 * @param default_channels A set of channels to statically enable
52 * @param hint A channel type specific hint for how to construct the logger
54 stub(level, channel_type_hint::value) {}
55 _WEBSOCKETPP_CONSTEXPR_TOKEN_ stub() {}
57 /// Dynamically enable the given list of channels
59 * All operations on the stub logger are no-ops and all arguments are
62 * @param channels The package of channels to enable
64 void set_channels(level) {}
66 /// Dynamically disable the given list of channels
68 * All operations on the stub logger are no-ops and all arguments are
71 * @param channels The package of channels to disable
73 void clear_channels(level) {}
75 /// Write a string message to the given channel
77 * Writing on the stub logger is a no-op and all arguments are ignored
79 * @param channel The channel to write to
80 * @param msg The message to write
82 void write(level, std::string const &) {}
84 /// Write a cstring message to the given channel
86 * Writing on the stub logger is a no-op and all arguments are ignored
88 * @param channel The channel to write to
89 * @param msg The message to write
91 void write(level, char const *) {}
93 /// Test whether a channel is statically enabled
95 * The stub logger has no channels so all arguments are ignored and
96 * `static_test` always returns false.
98 * @param channel The package of channels to test
100 _WEBSOCKETPP_CONSTEXPR_TOKEN_ bool static_test(level) const {
104 /// Test whether a channel is dynamically enabled
106 * The stub logger has no channels so all arguments are ignored and
107 * `dynamic_test` always returns false.
109 * @param channel The package of channels to test
111 bool dynamic_test(level) {
119 #endif // WEBSOCKETPP_LOGGER_STUB_HPP