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"
49#include "blocxx/String.hpp"
50
51
52namespace BLOCXX_NAMESPACE
53{
54
55class BLOCXX_COMMON_API LogAppender : public IntrusiveCountableBase
56{
57public:
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
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
169
170protected:
171
172 LogAppender(const StringArray& components = ALL_COMPONENTS,
173 const StringArray& categories = ALL_CATEGORIES,
174 const String& pattern = STR_TTCC_MESSAGE_FORMAT);
175
176private:
177 virtual void doProcessLogMessage(const String& formattedMessage, const LogMessage& message) const = 0;
178
179private: // data
184
186
188
189};
191
192#ifdef BLOCXX_WIN32
193extern DWORD dwTlsIndex;
194#else
195namespace
196{
197pthread_key_t g_loggerKey;
198}
199#endif
200
201} // end namespace BLOCXX_NAMESPACE
202
203#endif
204
205
const char * name
This class can be used to store a global variable that is lazily initialized in a thread safe manner.
static const GlobalStringArray ALL_CATEGORIES
Pass to createLogAppender to indicate all categories.
static const GlobalString TYPE_MPFILE
String of the type of the multi-process file log appender.
static const GlobalString TYPE_FILE
String of the type of the file log appender.
static const GlobalString TYPE_SYSLOG
String of the type of the syslog log appender.
SortedVectorSet< String > m_categories
SortedVectorSet< String > m_components
static const GlobalStringArray ALL_COMPONENTS
Pass to createLogAppender to indicate all components.
virtual void doProcessLogMessage(const String &formattedMessage, const LogMessage &message) const =0
static const GlobalString STR_TTCC_MESSAGE_FORMAT
The Log4j TTCC message format - TTCC is acronym for Time Thread Category Component.
static const GlobalString TYPE_NULL
String of the type of the null log appender.
static const GlobalString TYPE_STDERR
String of the type of the stderr log appender.
LogMessagePatternFormatter m_formatter
This String class is an abstract data type that represents as NULL terminated string of characters.
Definition String.hpp:67
Taken from RFC 1321.
BLOCXX_EXPORT_TEMPLATE(BLOCXX_COMMON_API, Array, Bool)