loggingevent.h

Go to the documentation of this file.

// -*- C++ -*-
// Module:  Log4CPLUS
// File:    loggingevent.h
// Created: 6/2001
// Author:  Tad E. Smith
//
//
// Copyright 2001-2017 Tad E. Smith
//
// Licensed 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 LOG4CPLUS_SPI_INTERNAL_LOGGING_EVENT_HEADER_
#define LOG4CPLUS_SPI_INTERNAL_LOGGING_EVENT_HEADER_
 
#include <log4cplus/config.hxx>
 
#if defined (LOG4CPLUS_HAVE_PRAGMA_ONCE)
#pragma once
#endif
 
#include <memory>
#include <log4cplus/loglevel.h>
#include <log4cplus/ndc.h>
#include <log4cplus/mdc.h>
#include <log4cplus/tstring.h>
#include <log4cplus/helpers/timehelper.h>
#include <log4cplus/thread/threads.h>
 
namespace log4cplus {
    namespace spi {
        class LOG4CPLUS_EXPORT InternalLoggingEvent {
        public:
          // Ctors
            InternalLoggingEvent(const log4cplus::tstring& logger,
                LogLevel loglevel, const log4cplus::tstring& message,
                const char* filename, int line, const char * function = nullptr);
 
            InternalLoggingEvent(const log4cplus::tstring& logger,
                LogLevel loglevel, const log4cplus::tstring& ndc,
                MappedDiagnosticContextMap const & mdc,
                const log4cplus::tstring& message,
                const log4cplus::tstring& thread,
                log4cplus::helpers::Time time, const log4cplus::tstring& file,
                int line, const log4cplus::tstring & function
                    = log4cplus::tstring ()) LOG4CPLUS_ATTRIBUTE_DEPRECATED;
 
            InternalLoggingEvent(const log4cplus::tstring& logger,
                LogLevel loglevel, const log4cplus::tstring& ndc,
                MappedDiagnosticContextMap const & mdc,
                const log4cplus::tstring& message,
                const log4cplus::tstring& thread,
                const log4cplus::tstring& thread2,
                log4cplus::helpers::Time time, const log4cplus::tstring& file,
                int line, const log4cplus::tstring & function
                    = log4cplus::tstring ());
 
            InternalLoggingEvent ();
 
            InternalLoggingEvent(
                const log4cplus::spi::InternalLoggingEvent& rhs);
 
            virtual ~InternalLoggingEvent();
 
            void setLoggingEvent (const log4cplus::tstring & logger,
                LogLevel ll, const log4cplus::tstring & message,
                const char * filename, int line,
                const char * function = nullptr);
 
            void setFunction (char const * func);
            void setFunction (log4cplus::tstring const &);
 
 
          // public virtual methods
            virtual const log4cplus::tstring& getMessage() const;
 
            virtual unsigned int getType() const;
 
            virtual std::unique_ptr<InternalLoggingEvent> clone() const;
 
 
          // public methods
            const log4cplus::tstring& getLoggerName() const
            {
                return loggerName;
            }
 
            LogLevel getLogLevel() const
            {
                return ll;
            }
 
            const log4cplus::tstring& getNDC() const
            {
                if (!ndcCached)
                {
                    ndc = log4cplus::getNDC().get();
                    ndcCached = true;
                }
                return ndc;
            }
 
            MappedDiagnosticContextMap const & getMDCCopy () const
            {
                if (!mdcCached)
                {
                    mdc = log4cplus::getMDC().getContext ();
                    mdcCached = true;
                }
                return mdc;
            }
 
            tstring const & getMDC (tstring const & key) const;
 
            const log4cplus::tstring& getThread() const
            {
                if (! threadCached)
                {
                    thread = thread::getCurrentThreadName ();
                    threadCached = true;
                }
                return thread;
            }
 
            const log4cplus::tstring& getThread2() const
            {
                if (! thread2Cached)
                {
                    thread2 = thread::getCurrentThreadName2 ();
                    thread2Cached = true;
                }
                return thread2;
            }
 
 
            const log4cplus::helpers::Time& getTimestamp() const
            {
                return timestamp;
            }
 
            const log4cplus::tstring& getFile() const
            {
                return file;
            }
 
            int getLine() const { return line; }
 
            log4cplus::tstring const & getFunction () const
            {
                return function;
            }
 
            void gatherThreadSpecificData () const;
 
            void swap (InternalLoggingEvent &);
 
          // public operators
            log4cplus::spi::InternalLoggingEvent&
            operator=(const log4cplus::spi::InternalLoggingEvent& rhs);
 
          // static methods
            static unsigned int getDefaultType();
 
        protected:
          // Data
            log4cplus::tstring message;
            log4cplus::tstring loggerName;
            LogLevel ll;
            mutable log4cplus::tstring ndc;
            mutable MappedDiagnosticContextMap mdc;
            mutable log4cplus::tstring thread;
            mutable log4cplus::tstring thread2;
            log4cplus::helpers::Time timestamp;
            log4cplus::tstring file;
            log4cplus::tstring function;
            int line;
            mutable bool threadCached;
            mutable bool thread2Cached;
            mutable bool ndcCached;
            mutable bool mdcCached;
        };
 
    } // end namespace spi
} // end namespace log4cplus
 
#endif // LOG4CPLUS_SPI_INTERNAL_LOGGING_EVENT_HEADER_