Apache Log4cxx  Version 1.1.0
mdc.h
Go to the documentation of this file.
1 /*
2  * Licensed to the Apache Software Foundation (ASF) under one or more
3  * contributor license agreements. See the NOTICE file distributed with
4  * this work for additional information regarding copyright ownership.
5  * The ASF licenses this file to You under the Apache License, Version 2.0
6  * (the "License"); you may not use this file except in compliance with
7  * the License. You may obtain a copy of the License at
8  *
9  * http://www.apache.org/licenses/LICENSE-2.0
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  */
17 
18 #ifndef _LOG4CXX_MDC_H
19 #define _LOG4CXX_MDC_H
20 
21 #include <log4cxx/log4cxx.h>
22 #include <log4cxx/logstring.h>
23 #include <map>
24 
25 namespace log4cxx
26 {
27 
36 class LOG4CXX_EXPORT MDC
37 {
38  public:
41  typedef std::map<LogString, LogString> Map;
42 
50  MDC(const std::string& key, const std::string& value);
51  ~MDC();
52 
63  static void put(const std::string& key, const std::string& value);
72  static void putLS(const LogString& key, const LogString& value);
73 
81  static std::string get(const std::string& key);
88  static bool get(const LogString& key, LogString& dest);
89 
96  static std::string remove(const std::string& key);
97 #if LOG4CXX_WCHAR_T_API
105  MDC(const std::wstring& key, const std::wstring& value);
116  static void put(const std::wstring& key, const std::wstring& value);
124  static std::wstring get(const std::wstring& key);
131  static std::wstring remove(const std::wstring& key);
132 #endif
133 #if LOG4CXX_UNICHAR_API
141  MDC(const std::basic_string<UniChar>& key, const std::basic_string<UniChar>& value);
152  static void put(const std::basic_string<UniChar>& key, const std::basic_string<UniChar>& value);
160  static std::basic_string<UniChar> get(const std::basic_string<UniChar>& key);
167  static std::basic_string<UniChar> remove(const std::basic_string<UniChar>& key);
168 #endif
169 #if LOG4CXX_CFSTRING_API
177  MDC(const CFStringRef& key, const CFStringRef& value);
188  static void put(const CFStringRef& key, const CFStringRef& value);
196  static CFStringRef get(const CFStringRef& key);
203  static CFStringRef remove(const CFStringRef& key);
204 #endif
212  static bool remove(const LogString& key, LogString& prevValue);
213 
217  static void clear();
218 
219  private:
220  MDC(const MDC&);
221  MDC& operator=(const MDC&);
222  LOG4CXX_DECLARE_PRIVATE_MEMBER(LogString, key)
223 }; // class MDC;
224 } // namespace log4cxx
225 
226 
227 #endif // _LOG4CXX_MDC_H
The MDC class is similar to the NDC class except that it is based on a map instead of a stack.
Definition: mdc.h:37
MDC(const std::wstring &key, const std::wstring &value)
Places a key/value pair in the MDC for the current thread which will be removed during the correspond...
MDC(const std::string &key, const std::string &value)
Places a key/value pair in the MDC for the current thread which will be removed during the correspond...
MDC(const std::basic_string< UniChar > &key, const std::basic_string< UniChar > &value)
Places a key/value pair in the MDC for the current thread which will be removed during the correspond...
static bool get(const LogString &key, LogString &dest)
Gets the context identified by the key parameter.
static std::basic_string< UniChar > get(const std::basic_string< UniChar > &key)
Get the context identified by the key parameter.
MDC(const CFStringRef &key, const CFStringRef &value)
Places a key/value pair in the MDC for the current thread which will be removed during the correspond...
static std::basic_string< UniChar > remove(const std::basic_string< UniChar > &key)
Remove the the context identified by the key parameter.
static void clear()
Clear all entries in the MDC.
static std::string remove(const std::string &key)
Remove the the context identified by the key parameter.
static void putLS(const LogString &key, const LogString &value)
Put a context value (the o parameter) as identified with the key parameter into the current thread's ...
static void put(const CFStringRef &key, const CFStringRef &value)
Put a context value (the o parameter) as identified with the key parameter into the current thread's ...
static void put(const std::string &key, const std::string &value)
Put a context value (the o parameter) as identified with the key parameter into the current thread's ...
static void put(const std::wstring &key, const std::wstring &value)
Put a context value (the o parameter) as identified with the key parameter into the current thread's ...
static bool remove(const LogString &key, LogString &prevValue)
Remove the the context identified by the key parameter.
static void put(const std::basic_string< UniChar > &key, const std::basic_string< UniChar > &value)
Put a context value (the o parameter) as identified with the key parameter into the current thread's ...
static std::string get(const std::string &key)
Get the context identified by the key parameter.
static CFStringRef get(const CFStringRef &key)
Get the context identified by the key parameter.
static std::wstring remove(const std::wstring &key)
Remove the the context identified by the key parameter.
static CFStringRef remove(const CFStringRef &key)
Remove the the context identified by the key parameter.
static std::wstring get(const std::wstring &key)
Get the context identified by the key parameter.
std::map< LogString, LogString > Map
String to string stl map.
Definition: mdc.h:41
const struct __CFString * CFStringRef
Definition: logstring.h:30
Definition: appender.h:27
std::basic_string< logchar > LogString
Definition: logstring.h:60