blocxx
LogAppender.hpp
Go to the documentation of this file.
1 /*******************************************************************************
2 * Copyright (C) 2005, Quest Software, Inc. All rights reserved.
3 * Copyright (C) 2006, Novell, Inc. All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are met:
7 *
8 * * Redistributions of source code must retain the above copyright notice,
9 * this list of conditions and the following disclaimer.
10 * * Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
13 * * Neither the name of
14 * Quest Software, Inc.,
15 * nor Novell, Inc.,
16 * nor the names of its contributors or employees may be used to
17 * endorse or promote products derived from this software without
18 * specific prior written permission.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
24 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30 * POSSIBILITY OF SUCH DAMAGE.
31 *******************************************************************************/
32 
33 
38 #ifndef BLOCXX_LOG_APPENDER_IFC_HPP_INCLUDE_GUARD_
39 #define BLOCXX_LOG_APPENDER_IFC_HPP_INCLUDE_GUARD_
40 #include "blocxx/BLOCXX_config.h"
41 #include "blocxx/CommonFwd.hpp"
44 #include "blocxx/LogConfig.hpp"
46 #include "blocxx/LazyGlobal.hpp"
47 #include "blocxx/GlobalString.hpp"
49 #include "blocxx/String.hpp"
50 
51 
52 namespace BLOCXX_NAMESPACE
53 {
54 
55 class BLOCXX_COMMON_API LogAppender : public IntrusiveCountableBase
56 {
57 public:
58 
59  virtual ~LogAppender();
60 
70  static LogAppenderRef getCurrentLogAppender();
71 
78  static LogAppenderRef getDefaultLogAppender();
79 
84  static bool setDefaultLogAppender(const LogAppenderRef &ref);
85 
91  static LogAppenderRef getThreadLogAppender();
92 
100  static bool setThreadLogAppender(const LogAppenderRef &ref);
101 
106  void logMessage(const LogMessage& message) const;
107 
108  bool categoryIsEnabled(const String& category) const;
109  bool componentAndCategoryAreEnabled(const String& component, const String& category) const;
110 
111  ELogLevel getLogLevel() const
112  {
113  return m_logLevel;
114  }
115 
144  static LogAppenderRef createLogAppender(
145  const String& name,
146  const StringArray& components,
147  const StringArray& categories,
148  const String& messageFormat,
149  const String& type,
150  const LoggerConfigMap& configItems);
151 
160  static const GlobalString TYPE_SYSLOG;
162  static const GlobalString TYPE_STDERR;
164  static const GlobalString TYPE_FILE;
166  static const GlobalString TYPE_MPFILE;
168  static const GlobalString TYPE_NULL;
169 
170 protected:
171 
172  LogAppender(const StringArray& components = ALL_COMPONENTS,
173  const StringArray& categories = ALL_CATEGORIES,
174  const String& pattern = STR_TTCC_MESSAGE_FORMAT);
175 
176 private:
177  virtual void doProcessLogMessage(const String& formattedMessage, const LogMessage& message) const = 0;
178 
179 private: // data
184 
186 
188 
189 };
191 
192 #ifdef BLOCXX_WIN32
193 extern DWORD dwTlsIndex;
194 #else
195 namespace
196 {
197 pthread_key_t g_loggerKey;
198 }
199 #endif
200 
201 } // end namespace BLOCXX_NAMESPACE
202 
203 #endif
204 
205