mdc.h
Go to the documentation of this file.
// -*- C++ -*-
// Copyright (C) 2010-2017, Vaclav Haisman. All rights reserved.
//
// Redistribution and use in source and binary forms, with or without modifica-
// tion, are permitted provided that the following conditions are met:
//
// 1. Redistributions of source code must retain the above copyright notice,
// this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright notice,
// this list of conditions and the following disclaimer in the documentation
// and/or other materials provided with the distribution.
//
// THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES,
// INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
// FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
// APACHE SOFTWARE FOUNDATION OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
// INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLU-
// DING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
// OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
// ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
// THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
#ifndef LOG4CPLUS_MDC_H_HEADER
#define LOG4CPLUS_MDC_H_HEADER
#include <log4cplus/config.hxx>
#if defined (LOG4CPLUS_HAVE_PRAGMA_ONCE)
#pragma once
#endif
#include <log4cplus/tstring.h>
#include <map>
namespace log4cplus
{
typedef std::map<tstring, tstring> MappedDiagnosticContextMap;
class LOG4CPLUS_EXPORT MDC
{
public:
void clear();
void put (tstring const & key, tstring const & value);
bool get (tstring * value, tstring const & key) const;
void remove (tstring const & key);
MappedDiagnosticContextMap const & getContext () const;
// Public ctor and dtor but only to be used by internal::DefaultContext.
MDC ();
virtual ~MDC ();
private:
LOG4CPLUS_PRIVATE static MappedDiagnosticContextMap * getPtr ();
};
LOG4CPLUS_EXPORT MDC & getMDC ();
} // namespace log4cplus
#endif // LOG4CPLUS_MDC_H_HEADER
log4cplus::MDC
Definition mdc.h:47
log4cplus::MDC::clear
void clear()
Clear any nested diagnostic information if any.
log4cplus::MDC::put
void put(tstring const &key, tstring const &value)
log4cplus::MDC::~MDC
virtual ~MDC()
log4cplus::MDC::get
bool get(tstring *value, tstring const &key) const
log4cplus::MDC::MDC
MDC()
log4cplus::MDC::getContext
MappedDiagnosticContextMap const & getContext() const
log4cplus::MDC::remove
void remove(tstring const &key)
config.hxx
LOG4CPLUS_PRIVATE
#define LOG4CPLUS_PRIVATE
Definition config.hxx:53
log4cplus
Definition appender.h:46
log4cplus::getMDC
LOG4CPLUS_EXPORT MDC & getMDC()
log4cplus::tstring
std::basic_string< tchar > tstring
Definition tstring.h:39
log4cplus::MappedDiagnosticContextMap
std::map< tstring, tstring > MappedDiagnosticContextMap
Definition mdc.h:43
tstring.h
LOG4CPLUS_EXPORT
#define LOG4CPLUS_EXPORT
Definition win32.h:141