mdc.h

Go to the documentation of this file.

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
 
#ifndef _LOG4CXX_MDC_H
#define _LOG4CXX_MDC_H
 
#include <log4cxx/log4cxx.h>
#include <log4cxx/logstring.h>
#include <map>
 
namespace log4cxx
{
 
class LOG4CXX_EXPORT MDC
{
    public:
        typedef std::map<LogString, LogString> Map;
 
        MDC(const std::string& key, const std::string& value);
        ~MDC();
 
        static void put(const std::string& key, const std::string& value);
        static void putLS(const LogString& key, const LogString& value);
 
        static std::string get(const std::string& key);
        static bool get(const LogString& key, LogString& dest);
 
        static std::string remove(const std::string& key);
#if LOG4CXX_WCHAR_T_API
        MDC(const std::wstring& key, const std::wstring& value);
        static void put(const std::wstring& key, const std::wstring& value);
        static std::wstring get(const std::wstring& key);
        static std::wstring remove(const std::wstring& key);
#endif
#if LOG4CXX_UNICHAR_API
        MDC(const std::basic_string<UniChar>& key, const std::basic_string<UniChar>& value);
        static void put(const std::basic_string<UniChar>& key, const std::basic_string<UniChar>& value);
        static std::basic_string<UniChar> get(const std::basic_string<UniChar>& key);
        static std::basic_string<UniChar> remove(const std::basic_string<UniChar>& key);
#endif
#if LOG4CXX_CFSTRING_API
        MDC(const CFStringRef& key, const CFStringRef& value);
        static void put(const CFStringRef& key, const CFStringRef& value);
        static CFStringRef get(const CFStringRef& key);
        static CFStringRef remove(const CFStringRef& key);
#endif
        static bool remove(const LogString& key, LogString& prevValue);
 
        static void clear();
 
    private:
        MDC(const MDC&);
        MDC& operator=(const MDC&);
        LOG4CXX_DECLARE_PRIVATE_MEMBER(LogString, key)
}; // class MDC;
}  // namespace log4cxx
 
 
#endif // _LOG4CXX_MDC_H