Apache Log4cxx  Version 1.3.0
Loading...
Searching...
No Matches
loggingevent.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_SPI_LOGGING_EVENT_H
19#define _LOG4CXX_SPI_LOGGING_EVENT_H
20
21#include <log4cxx/logstring.h>
22#include <time.h>
23#include <log4cxx/logger.h>
24#include <log4cxx/mdc.h>
26#include <vector>
27#include <chrono>
28
29
30namespace LOG4CXX_NS
31{
32
33namespace spi
34{
36
46 public virtual helpers::Object
47{
48 public:
53
54 typedef spi::KeySet KeySet;
55
59
69 ( const LogString& logger
70 , const LevelPtr& level
71 , const LocationInfo& location
72 , LogString&& message
73 );
74
84 ( const LogString& logger
85 , const LevelPtr& level
86 , const LogString& message
87 , const LocationInfo& location
88 );
89
91
93 const LevelPtr& getLevel() const;
94
96 const LogString& getLoggerName() const;
97
99 const LogString& getMessage() const;
100
102 const LogString& getRenderedMessage() const;
103
107 static log4cxx_time_t getStartTime();
108
110 const LogString& getThreadName() const;
111
118 const LogString& getThreadUserName() const;
119
123 log4cxx_time_t getTimeStamp() const;
124
127 std::chrono::time_point<std::chrono::system_clock> getChronoTimeStamp() const;
128
130 const LocationInfo& getLocationInformation() const;
131
140 bool getNDC(LogString& dest) const;
141
151 bool getMDC(const LogString& key, LogString& dest) const;
152
159 KeySet getMDCKeySet() const;
160
161#if LOG4CXX_ABI_VERSION <= 15
165 [[ deprecated( "Use LoadDC instead" ) ]]
166 void getMDCCopy() const;
167#endif
168
176 void LoadDC() const;
177
184 bool getProperty(const LogString& key, LogString& dest) const;
185
192
196 void setProperty(const LogString& key, const LogString& value);
197
198 private:
199 LOG4CXX_DECLARE_PRIVATE_MEMBER_PTR(LoggingEventPrivate, m_priv)
200
201 //
202 // prevent copy and assignment
203 //
205 LoggingEvent& operator=(const LoggingEvent&);
206
207};
208
211}
212}
213
214#endif //_LOG4CXX_SPI_LOGGING_EVENT_H
base class for java-like objects.
Definition: object.h:106
This class represents the location of a logging statement.
Definition: locationinfo.h:40
The data recorded for each logging request.
Definition: loggingevent.h:47
KeySet getPropertyKeySet() const
The set of of the key values in the properties for the event.
void getMDCCopy() const
Obtain a copy of the current thread's diagnostic context data.
void setProperty(const LogString &key, const LogString &value)
Associate value with the property key.
spi::KeySet KeySet
Definition: loggingevent.h:54
bool getProperty(const LogString &key, LogString &dest) const
Append onto dest the value associated with the property key.
void LoadDC() const
Obtain a copy of the current thread's diagnostic context data.
#define LOG4CXX_LIST_DEF(N, T)
Definition: log4cxx.h:67
#define LOG4CXX_DECLARE_PRIVATE_MEMBER_PTR(T, V)
Definition: log4cxx.h:85
#define LOG4CXX_EXPORT
Definition: log4cxx.h:101
#define LOG4CXX_PTR_DEF(T)
Definition: log4cxx.h:64
#define LOG4CXX_NS
Definition: log4cxx.h:104
std::shared_ptr< LoggingEvent > LoggingEventPtr
Definition: appender.h:32
std::basic_string< logchar > LogString
Definition: logstring.h:60
int64_t log4cxx_time_t
log4cxx_time_t - holds the number of microseconds since 1970-01-01
Definition: log4cxx.h:111
std::shared_ptr< Level > LevelPtr
Definition: optionconverter.h:28
#define LOG4CXX_CAST_ENTRY(Interface)
Definition: object.h:158
#define END_LOG4CXX_CAST_MAP()
Definition: object.h:152
#define DECLARE_LOG4CXX_OBJECT(object)
Definition: object.h:43
#define BEGIN_LOG4CXX_CAST_MAP()
Definition: object.h:146