<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Apache log4cxx: LoggingEvent Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.3 -->
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Apache log4cxx <span id="projectnumber">Version 0.10.0</span></div>
</td>
</tr>
</tbody>
</table>
</div>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
initNavTree('classlog4cxx_1_1spi_1_1_logging_event.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-methods">Static Public Member Functions</a> </div>
<div class="headertitle">
<h1>LoggingEvent Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="log4cxx::spi::LoggingEvent" --><!-- doxytag: inherits="log4cxx::helpers::ObjectImpl" -->
<p>The internal representation of logging events.
<a href="#_details">More...</a></p>
<p>Inherits <a class="el" href="classlog4cxx_1_1helpers_1_1_object_impl.html">log4cxx::helpers::ObjectImpl</a>.</p>
<p><a href="classlog4cxx_1_1spi_1_1_logging_event-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1spi_1_1_logging_event.html#a5a286d3b465aaf1f2491960fc03fa9eb">LoggingEvent</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">For serialization only. <a href="#a5a286d3b465aaf1f2491960fc03fa9eb"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1spi_1_1_logging_event.html#a51c451ec8d7d3cca1dbc7eba86938687">LoggingEvent</a> (const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &logger, const <a class="el" href="classlog4cxx_1_1helpers_1_1_object_ptr_t.html">LevelPtr</a> &level, const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &message, const <a class="el" href="classlog4cxx_1_1spi_1_1_location_info.html">log4cxx::spi::LocationInfo</a> &location)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Instantiate a <a class="el" href="classlog4cxx_1_1spi_1_1_logging_event.html" title="The internal representation of logging events.">LoggingEvent</a> from the supplied parameters. <a href="#a51c451ec8d7d3cca1dbc7eba86938687"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1spi_1_1_logging_event.html#a230dfbc85d6f51417472fea7893e4203">~LoggingEvent</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classlog4cxx_1_1helpers_1_1_object_ptr_t.html">LevelPtr</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1spi_1_1_logging_event.html#a183d6ded66a2e18d2b9fd505aa9a8021">getLevel</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the level of this event. <a href="#a183d6ded66a2e18d2b9fd505aa9a8021"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1spi_1_1_logging_event.html#a0fa9dec3d04d993afe60c366efefdd5f">getLoggerName</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the name of the logger. <a href="#a0fa9dec3d04d993afe60c366efefdd5f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1spi_1_1_logging_event.html#a821ec92b63f4b294ed6d7b4aafc93877">getMessage</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the message for this logging event. <a href="#a821ec92b63f4b294ed6d7b4aafc93877"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1spi_1_1_logging_event.html#ad01c9d1ca53e5036d4d95e8a2f15b266">getRenderedMessage</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the message for this logging event. <a href="#ad01c9d1ca53e5036d4d95e8a2f15b266"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1spi_1_1_logging_event.html#ad4b02dfb65a00116f57a06895fbb34ad">getThreadName</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the threadName of this event. <a href="#ad4b02dfb65a00116f57a06895fbb34ad"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="log4cxx_8h.html#adcf85375d350e7045ac5570a2c922aec">log4cxx_time_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1spi_1_1_logging_event.html#a94cf977261a98da0cc53f2346f3a45d0">getTimeStamp</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the timeStamp of this event. <a href="#a94cf977261a98da0cc53f2346f3a45d0"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classlog4cxx_1_1spi_1_1_location_info.html">log4cxx::spi::LocationInfo</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1spi_1_1_logging_event.html#a30b6c199fbbf62aef273ac6441117476">getLocationInformation</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1spi_1_1_logging_event.html#a2d62917cb60bdbd09706603825c13aab">getNDC</a> (<a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &dest) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">This method appends the <a class="el" href="classlog4cxx_1_1_n_d_c.html" title="the ndc class implements nested diagnostic contexts as defined by neil harrison in the article "...">NDC</a> for this event to passed string. <a href="#a2d62917cb60bdbd09706603825c13aab"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1spi_1_1_logging_event.html#a52e0d159b6a0e4ebd10ebd559bb771a9">write</a> (<a class="el" href="classlog4cxx_1_1helpers_1_1_object_output_stream.html">helpers::ObjectOutputStream</a> &os, <a class="el" href="classlog4cxx_1_1helpers_1_1_pool.html">helpers::Pool</a> &p) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Writes the content of the <a class="el" href="classlog4cxx_1_1spi_1_1_logging_event.html" title="The internal representation of logging events.">LoggingEvent</a> in a format compatible with log4j's serialized form. <a href="#a52e0d159b6a0e4ebd10ebd559bb771a9"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1spi_1_1_logging_event.html#a694c2b2b58295c301950e41848c95a56">getMDC</a> (const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &key, <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &dest) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Appends the the context corresponding to the <code>key</code> parameter. <a href="#a694c2b2b58295c301950e41848c95a56"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1spi_1_1_logging_event.html#a9da37769335aee7de9d62d952893e165">LOG4CXX_LIST_DEF</a> (KeySet, <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a>)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">KeySet </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1spi_1_1_logging_event.html#a31d9fbc3746c91b951bb037056120a53">getMDCKeySet</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the set of of the key values in the <a class="el" href="classlog4cxx_1_1_m_d_c.html" title="The MDC class is similar to the NDC class except that it is based on a map instead of a stack...">MDC</a> for the event. <a href="#a31d9fbc3746c91b951bb037056120a53"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1spi_1_1_logging_event.html#a3451748570be6b86736868e00551c159">getMDCCopy</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Obtain a copy of this thread's <a class="el" href="classlog4cxx_1_1_m_d_c.html" title="The MDC class is similar to the NDC class except that it is based on a map instead of a stack...">MDC</a> prior to serialization or asynchronous logging. <a href="#a3451748570be6b86736868e00551c159"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1spi_1_1_logging_event.html#a5bf95971b2f6bc5f2b9b4d6735574ce1">getProperty</a> (const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &key, <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &dest) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return a previously set property. <a href="#a5bf95971b2f6bc5f2b9b4d6735574ce1"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">KeySet </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1spi_1_1_logging_event.html#a31a5674c3c16f242c1274d4914d2560b">getPropertyKeySet</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the set of of the key values in the properties for the event. <a href="#a31a5674c3c16f242c1274d4914d2560b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1spi_1_1_logging_event.html#a78260008ffd6edbf8225f6da1f439baa">setProperty</a> (const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &key, const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &value)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set a string property using a key and a string value. <a href="#a78260008ffd6edbf8225f6da1f439baa"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="log4cxx_8h.html#adcf85375d350e7045ac5570a2c922aec">log4cxx_time_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1spi_1_1_logging_event.html#a0777f0af7b63696f63774073c2075760">getStartTime</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the time when the application started, in seconds elapsed since 01.01.1970. <a href="#a0777f0af7b63696f63774073c2075760"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>The internal representation of logging events. </p>
<p>When an affirmative decision is made to log then a <code><a class="el" href="classlog4cxx_1_1spi_1_1_logging_event.html" title="The internal representation of logging events.">LoggingEvent</a></code> instance is created. This instance is passed around to the different <a class="el" href="namespacelog4cxx.html">log4cxx</a> components.</p>
<p>This class is of concern to those wishing to extend <a class="el" href="namespacelog4cxx.html">log4cxx</a>. </p>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a5a286d3b465aaf1f2491960fc03fa9eb"></a><!-- doxytag: member="log4cxx::spi::LoggingEvent::LoggingEvent" ref="a5a286d3b465aaf1f2491960fc03fa9eb" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classlog4cxx_1_1spi_1_1_logging_event.html">LoggingEvent</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>For serialization only. </p>
</div>
</div>
<a class="anchor" id="a51c451ec8d7d3cca1dbc7eba86938687"></a><!-- doxytag: member="log4cxx::spi::LoggingEvent::LoggingEvent" ref="a51c451ec8d7d3cca1dbc7eba86938687" args="(const LogString &logger, const LevelPtr &level, const LogString &message, const log4cxx::spi::LocationInfo &location)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classlog4cxx_1_1spi_1_1_logging_event.html">LoggingEvent</a> </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> & </td>
<td class="paramname"><em>logger</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classlog4cxx_1_1helpers_1_1_object_ptr_t.html">LevelPtr</a> & </td>
<td class="paramname"><em>level</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> & </td>
<td class="paramname"><em>message</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classlog4cxx_1_1spi_1_1_location_info.html">log4cxx::spi::LocationInfo</a> & </td>
<td class="paramname"><em>location</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Instantiate a <a class="el" href="classlog4cxx_1_1spi_1_1_logging_event.html" title="The internal representation of logging events.">LoggingEvent</a> from the supplied parameters. </p>
<p>Except timeStamp all the other fields of <code><a class="el" href="classlog4cxx_1_1spi_1_1_logging_event.html" title="The internal representation of logging events.">LoggingEvent</a></code> are filled when actually needed. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">logger</td><td>The logger of this event. </td></tr>
<tr><td class="paramname">level</td><td>The level of this event. </td></tr>
<tr><td class="paramname">message</td><td>The message of this event. </td></tr>
<tr><td class="paramname">location</td><td>location of logging request. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a230dfbc85d6f51417472fea7893e4203"></a><!-- doxytag: member="log4cxx::spi::LoggingEvent::~LoggingEvent" ref="a230dfbc85d6f51417472fea7893e4203" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">~<a class="el" href="classlog4cxx_1_1spi_1_1_logging_event.html">LoggingEvent</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a183d6ded66a2e18d2b9fd505aa9a8021"></a><!-- doxytag: member="log4cxx::spi::LoggingEvent::getLevel" ref="a183d6ded66a2e18d2b9fd505aa9a8021" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classlog4cxx_1_1helpers_1_1_object_ptr_t.html">LevelPtr</a>& getLevel </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the level of this event. </p>
</div>
</div>
<a class="anchor" id="a30b6c199fbbf62aef273ac6441117476"></a><!-- doxytag: member="log4cxx::spi::LoggingEvent::getLocationInformation" ref="a30b6c199fbbf62aef273ac6441117476" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classlog4cxx_1_1spi_1_1_location_info.html">log4cxx::spi::LocationInfo</a>& getLocationInformation </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a0fa9dec3d04d993afe60c366efefdd5f"></a><!-- doxytag: member="log4cxx::spi::LoggingEvent::getLoggerName" ref="a0fa9dec3d04d993afe60c366efefdd5f" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a>& getLoggerName </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the name of the logger. </p>
</div>
</div>
<a class="anchor" id="a694c2b2b58295c301950e41848c95a56"></a><!-- doxytag: member="log4cxx::spi::LoggingEvent::getMDC" ref="a694c2b2b58295c301950e41848c95a56" args="(const LogString &key, LogString &dest) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool getMDC </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> & </td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> & </td>
<td class="paramname"><em>dest</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Appends the the context corresponding to the <code>key</code> parameter. </p>
<p>If there is a local <a class="el" href="classlog4cxx_1_1_m_d_c.html" title="The MDC class is similar to the NDC class except that it is based on a map instead of a stack...">MDC</a> copy, possibly because we are in a logging server or running inside <a class="el" href="classlog4cxx_1_1_async_appender.html" title="The AsyncAppender lets users log events asynchronously.">AsyncAppender</a>, then we search for the key in <a class="el" href="classlog4cxx_1_1_m_d_c.html" title="The MDC class is similar to the NDC class except that it is based on a map instead of a stack...">MDC</a> copy, if a value is found it is returned. Otherwise, if the search in <a class="el" href="classlog4cxx_1_1_m_d_c.html" title="The MDC class is similar to the NDC class except that it is based on a map instead of a stack...">MDC</a> copy returns an empty result, then the current thread's <code><a class="el" href="classlog4cxx_1_1_m_d_c.html" title="The MDC class is similar to the NDC class except that it is based on a map instead of a stack...">MDC</a></code> is used.</p>
<p>Note that <em>both</em> the local <a class="el" href="classlog4cxx_1_1_m_d_c.html" title="The MDC class is similar to the NDC class except that it is based on a map instead of a stack...">MDC</a> copy and the current thread's <a class="el" href="classlog4cxx_1_1_m_d_c.html" title="The MDC class is similar to the NDC class except that it is based on a map instead of a stack...">MDC</a> are searched. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">key</td><td>key. </td></tr>
<tr><td class="paramname">dest</td><td>string to which value, if any, is appended. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if key had a corresponding value. </dd></dl>
</div>
</div>
<a class="anchor" id="a3451748570be6b86736868e00551c159"></a><!-- doxytag: member="log4cxx::spi::LoggingEvent::getMDCCopy" ref="a3451748570be6b86736868e00551c159" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void getMDCCopy </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Obtain a copy of this thread's <a class="el" href="classlog4cxx_1_1_m_d_c.html" title="The MDC class is similar to the NDC class except that it is based on a map instead of a stack...">MDC</a> prior to serialization or asynchronous logging. </p>
</div>
</div>
<a class="anchor" id="a31d9fbc3746c91b951bb037056120a53"></a><!-- doxytag: member="log4cxx::spi::LoggingEvent::getMDCKeySet" ref="a31d9fbc3746c91b951bb037056120a53" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">KeySet getMDCKeySet </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the set of of the key values in the <a class="el" href="classlog4cxx_1_1_m_d_c.html" title="The MDC class is similar to the NDC class except that it is based on a map instead of a stack...">MDC</a> for the event. </p>
<p>The returned set is unmodifiable by the caller.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>Set an unmodifiable set of the <a class="el" href="classlog4cxx_1_1_m_d_c.html" title="The MDC class is similar to the NDC class except that it is based on a map instead of a stack...">MDC</a> keys. </dd></dl>
</div>
</div>
<a class="anchor" id="a821ec92b63f4b294ed6d7b4aafc93877"></a><!-- doxytag: member="log4cxx::spi::LoggingEvent::getMessage" ref="a821ec92b63f4b294ed6d7b4aafc93877" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a>& getMessage </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the message for this logging event. </p>
</div>
</div>
<a class="anchor" id="a2d62917cb60bdbd09706603825c13aab"></a><!-- doxytag: member="log4cxx::spi::LoggingEvent::getNDC" ref="a2d62917cb60bdbd09706603825c13aab" args="(LogString &dest) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool getNDC </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> & </td>
<td class="paramname"><em>dest</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This method appends the <a class="el" href="classlog4cxx_1_1_n_d_c.html" title="the ndc class implements nested diagnostic contexts as defined by neil harrison in the article "...">NDC</a> for this event to passed string. </p>
<p>It will return the correct content even if the event was generated in a different thread or even on a different machine. The <a class="el" href="classlog4cxx_1_1_n_d_c.html#aec930584769a8379ff4ee6ecd2448508" title="Get the current value of the NDC of the currrent thread.">NDC::get</a> method should <em>never</em> be called directly.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">dest</td><td>destination for <a class="el" href="classlog4cxx_1_1_n_d_c.html" title="the ndc class implements nested diagnostic contexts as defined by neil harrison in the article "...">NDC</a>, unchanged if <a class="el" href="classlog4cxx_1_1_n_d_c.html" title="the ndc class implements nested diagnostic contexts as defined by neil harrison in the article "...">NDC</a> is not set. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if <a class="el" href="classlog4cxx_1_1_n_d_c.html" title="the ndc class implements nested diagnostic contexts as defined by neil harrison in the article "...">NDC</a> is set. </dd></dl>
</div>
</div>
<a class="anchor" id="a5bf95971b2f6bc5f2b9b4d6735574ce1"></a><!-- doxytag: member="log4cxx::spi::LoggingEvent::getProperty" ref="a5bf95971b2f6bc5f2b9b4d6735574ce1" args="(const LogString &key, LogString &dest) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool getProperty </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> & </td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> & </td>
<td class="paramname"><em>dest</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return a previously set property. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">key</td><td>key. </td></tr>
<tr><td class="paramname">dest</td><td>string to which value, if any, is appended. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if key had a corresponding value. </dd></dl>
</div>
</div>
<a class="anchor" id="a31a5674c3c16f242c1274d4914d2560b"></a><!-- doxytag: member="log4cxx::spi::LoggingEvent::getPropertyKeySet" ref="a31a5674c3c16f242c1274d4914d2560b" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">KeySet getPropertyKeySet </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the set of of the key values in the properties for the event. </p>
<p>The returned set is unmodifiable by the caller.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>Set an unmodifiable set of the property keys. </dd></dl>
</div>
</div>
<a class="anchor" id="ad01c9d1ca53e5036d4d95e8a2f15b266"></a><!-- doxytag: member="log4cxx::spi::LoggingEvent::getRenderedMessage" ref="ad01c9d1ca53e5036d4d95e8a2f15b266" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a>& getRenderedMessage </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the message for this logging event. </p>
</div>
</div>
<a class="anchor" id="a0777f0af7b63696f63774073c2075760"></a><!-- doxytag: member="log4cxx::spi::LoggingEvent::getStartTime" ref="a0777f0af7b63696f63774073c2075760" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="log4cxx_8h.html#adcf85375d350e7045ac5570a2c922aec">log4cxx_time_t</a> getStartTime </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the time when the application started, in seconds elapsed since 01.01.1970. </p>
</div>
</div>
<a class="anchor" id="ad4b02dfb65a00116f57a06895fbb34ad"></a><!-- doxytag: member="log4cxx::spi::LoggingEvent::getThreadName" ref="ad4b02dfb65a00116f57a06895fbb34ad" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a>& getThreadName </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the threadName of this event. </p>
</div>
</div>
<a class="anchor" id="a94cf977261a98da0cc53f2346f3a45d0"></a><!-- doxytag: member="log4cxx::spi::LoggingEvent::getTimeStamp" ref="a94cf977261a98da0cc53f2346f3a45d0" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="log4cxx_8h.html#adcf85375d350e7045ac5570a2c922aec">log4cxx_time_t</a> getTimeStamp </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the timeStamp of this event. </p>
</div>
</div>
<a class="anchor" id="a9da37769335aee7de9d62d952893e165"></a><!-- doxytag: member="log4cxx::spi::LoggingEvent::LOG4CXX_LIST_DEF" ref="a9da37769335aee7de9d62d952893e165" args="(KeySet, LogString)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">LOG4CXX_LIST_DEF </td>
<td>(</td>
<td class="paramtype">KeySet </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> </td>
<td class="paramname"> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a78260008ffd6edbf8225f6da1f439baa"></a><!-- doxytag: member="log4cxx::spi::LoggingEvent::setProperty" ref="a78260008ffd6edbf8225f6da1f439baa" args="(const LogString &key, const LogString &value)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void setProperty </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> & </td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> & </td>
<td class="paramname"><em>value</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set a string property using a key and a string value. </p>
<p>since 1.3 </p>
</div>
</div>
<a class="anchor" id="a52e0d159b6a0e4ebd10ebd559bb771a9"></a><!-- doxytag: member="log4cxx::spi::LoggingEvent::write" ref="a52e0d159b6a0e4ebd10ebd559bb771a9" args="(helpers::ObjectOutputStream &os, helpers::Pool &p) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void write </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classlog4cxx_1_1helpers_1_1_object_output_stream.html">helpers::ObjectOutputStream</a> & </td>
<td class="paramname"><em>os</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classlog4cxx_1_1helpers_1_1_pool.html">helpers::Pool</a> & </td>
<td class="paramname"><em>p</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Writes the content of the <a class="el" href="classlog4cxx_1_1spi_1_1_logging_event.html" title="The internal representation of logging events.">LoggingEvent</a> in a format compatible with log4j's serialized form. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="loggingevent_8h.html">loggingevent.h</a></li>
</ul>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespacelog4cxx.html">log4cxx</a> </li>
<li class="navelem"><a class="el" href="namespacelog4cxx_1_1spi.html">spi</a> </li>
<li class="navelem"><a class="el" href="classlog4cxx_1_1spi_1_1_logging_event.html">LoggingEvent</a> </li>
<!--
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.
-->
</BODY>
</HTML>
