loggingevent.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_SPI_LOGGING_EVENT_H
#define _LOG4CXX_SPI_LOGGING_EVENT_H
 
#include <log4cxx/logstring.h>
#include <time.h>
#include <log4cxx/logger.h>
#include <log4cxx/mdc.h>
#include <log4cxx/spi/location/locationinfo.h>
#include <vector>
#include <chrono>
 
 
namespace LOG4CXX_NS
{
 
namespace spi
{
LOG4CXX_LIST_DEF(KeySet, LogString);

class LOG4CXX_EXPORT LoggingEvent :
    public virtual helpers::Object
{
    public:
        DECLARE_LOG4CXX_OBJECT(LoggingEvent)
        BEGIN_LOG4CXX_CAST_MAP()
        LOG4CXX_CAST_ENTRY(LoggingEvent)
        END_LOG4CXX_CAST_MAP()
 
        typedef spi::KeySet KeySet;

        LoggingEvent();

        LoggingEvent
            ( const LogString& logger
            , const LevelPtr& level
            , const LocationInfo& location
            , LogString&& message
            );

        LoggingEvent
            ( const LogString& logger
            , const LevelPtr&  level
            , const LogString& message
            , const LocationInfo& location
            );

        LoggingEvent
            ( const LogString& logger
            , const LevelPtr& level
            , const LocationInfo& location
            , helpers::AsyncBuffer&& messageAppender
            );
 
        ~LoggingEvent();

        const LevelPtr& getLevel() const;

        const LogString& getLoggerName() const;

        const LogString& getMessage() const;

        const LogString& getRenderedMessage() const;

        static log4cxx_time_t getStartTime();

        const LogString& getThreadName() const;

        const LogString& getThreadUserName() const;

        log4cxx_time_t getTimeStamp() const;

        std::chrono::time_point<std::chrono::system_clock> getChronoTimeStamp() const;

        const LocationInfo& getLocationInformation() const;

        bool getNDC(LogString& dest) const;

        bool getMDC(const LogString& key, LogString& dest) const;

        KeySet getMDCKeySet() const;
 
#if LOG4CXX_ABI_VERSION <= 15
        [[ deprecated( "Use LoadDC instead" ) ]]
        void getMDCCopy() const;
#endif

        void LoadDC() const;

        bool getProperty(const LogString& key, LogString& dest) const;

        KeySet getPropertyKeySet() const;

        void setProperty(const LogString& key, const LogString& value);

        void renderMessage();
 
    private:
        LOG4CXX_DECLARE_PRIVATE_MEMBER_PTR(LoggingEventPrivate, m_priv)
 
        //
        //   prevent copy and assignment
        //
        LoggingEvent(const LoggingEvent&);
        LoggingEvent& operator=(const LoggingEvent&);
 
};
 
LOG4CXX_PTR_DEF(LoggingEvent);
LOG4CXX_LIST_DEF(LoggingEventList, LoggingEventPtr);
}
}
 
#endif //_LOG4CXX_SPI_LOGGING_EVENT_H