| <html> |
| <head> |
| <title> |
| log4cxx - Documentation |
| </title> |
| <link href="../css/doxygen.css" rel="stylesheet" type="text/css"/> |
| </head> |
| |
| <body bgcolor="#ffffff" text="#000000" link="#525D76"> |
| <!-- START Header table --> |
| <table border="0" cellspacing="0" width="90%"> |
| <!-- TOP IMAGE --> |
| <tr> |
| <td colspan="2"> |
| <a href="http://logging.apache.org"> |
| <img src="http://logging.apache.org/images/ls-logo.jpg" align="left" border="0"/> |
| </a> |
| </td> |
| |
| </tr> |
| </table> |
| <!-- END Header table --> |
| |
| <!-- START main table --> |
| <table id="main" border="0" width="90%" cellspacing="2" cellpadding="0"> |
| <tr><td colspan="2"> |
| <hr noshade="" size="1"/> |
| </td></tr> |
| |
| <tr> |
| <!-- LEFT SIDE NAVIGATION --> |
| <td id="navbar" valign="top"> |
| <!-- ============================================================ --> |
| <table id="navbar" border="0" cellspacing="0" cellpadding="0"> |
| <tr > |
| <td class="navbarHeader" nowrap="true"> |
| <strong>Apache</strong> |
| </td> |
| </tr> |
| <tr><td class="navbarItem"><small> <a href="http://www.apache.org">Apache Home</a> |
| </small></td></tr> |
| <tr><td class="navbarItem"><small> <a href="http://logging.apache.org/">Logging Services</a> |
| </small></td></tr> |
| <tr > |
| <td class="navbarHeader" nowrap="true"> |
| <strong>log4cxx project</strong> |
| </td> |
| </tr> |
| <tr><td class="navbarItem"><small> <a href="../index.html">About</a> |
| </small></td></tr> |
| <tr><td class="navbarItem"><small> <a href="../news.html">News</a> |
| </small></td></tr> |
| <tr><td class="navbarItem"><small> <a href="../team.html">Team</a> |
| </small></td></tr> |
| <tr><td class="navbarItem"><small> <a href="../manual/index.html">Documentation</a> |
| </small></td></tr> |
| <tr><td class="navbarItem"><small> <a href="../performance.html">Performance</a> |
| </small></td></tr> |
| <tr><td class="navbarItem"><small> <a href="../download.html">Download</a> |
| </small></td></tr> |
| </table> |
| |
| </td> |
| <td id="mainContents" align="left" valign="top"> |
| <hr> |
| <!-- Generated by Doxygen 1.3.5 --> |
| <div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="modules.html">Modules</a> | <a class="qindex" href="hierarchy.html">Class Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical List</a> | <a class="qindex" href="annotated.html">Class List</a> | <a class="qindex" href="functions.html">Class Members</a></div> |
| <h1>LoggingEvent Class Reference</h1>Inheritance diagram for LoggingEvent:<p><center><img src="classlog4cxx_1_1spi_1_1LoggingEvent__inherit__graph.png" border="0" usemap="#LoggingEvent__inherit__map" alt="Inheritance graph"></center> |
| <map name="LoggingEvent__inherit__map"> |
| <area href="classlog4cxx_1_1helpers_1_1ObjectImpl.html" shape="rect" coords="14,93,89,117" alt=""> |
| <area href="classlog4cxx_1_1helpers_1_1Object.html" shape="rect" coords="26,18,77,42" alt=""> |
| </map> |
| <center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center>Collaboration diagram for LoggingEvent:<p><center><img src="classlog4cxx_1_1spi_1_1LoggingEvent__coll__graph.png" border="0" usemap="#LoggingEvent__coll__map" alt="Collaboration graph"></center> |
| <map name="LoggingEvent__coll__map"> |
| <area href="classlog4cxx_1_1helpers_1_1ObjectImpl.html" shape="rect" coords="6,96,81,120" alt=""> |
| <area href="classlog4cxx_1_1helpers_1_1Object.html" shape="rect" coords="18,18,69,42" alt=""> |
| <area href="classlog4cxx_1_1helpers_1_1ObjectPtrT.html" shape="rect" coords="105,96,177,120" alt=""> |
| </map> |
| <center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classlog4cxx_1_1spi_1_1LoggingEvent-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> |
| <tr><td></td></tr> |
| <tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr> |
| <tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="classlog4cxx_1_1spi_1_1LoggingEvent.html#a0">LoggingEvent</a> ()</td></tr> |
| |
| <tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="classlog4cxx_1_1spi_1_1LoggingEvent.html#a1">LoggingEvent</a> (const String &fqnOfLoggerClass, const <a class="el" href="classlog4cxx_1_1helpers_1_1ObjectPtrT.html">LoggerPtr</a> &logger, const <a class="el" href="classlog4cxx_1_1helpers_1_1ObjectPtrT.html">LevelPtr</a> &level, const String &message, const char *file=0, int line=-1)</td></tr> |
| |
| <tr><td class="memItemLeft" nowrap align=right valign=top>const <a class="el" href="classlog4cxx_1_1helpers_1_1ObjectPtrT.html">LevelPtr</a> & </td><td class="memItemRight" valign=bottom><a class="el" href="classlog4cxx_1_1spi_1_1LoggingEvent.html#a3">getLevel</a> () const </td></tr> |
| |
| <tr><td class="memItemLeft" nowrap align=right valign=top>const String & </td><td class="memItemRight" valign=bottom><a class="el" href="classlog4cxx_1_1spi_1_1LoggingEvent.html#a4">getLoggerName</a> () const </td></tr> |
| |
| <tr><td class="memItemLeft" nowrap align=right valign=top>const String & </td><td class="memItemRight" valign=bottom><a class="el" href="classlog4cxx_1_1spi_1_1LoggingEvent.html#a5">getMessage</a> () const </td></tr> |
| |
| <tr><td class="memItemLeft" nowrap align=right valign=top>const String & </td><td class="memItemRight" valign=bottom><a class="el" href="classlog4cxx_1_1spi_1_1LoggingEvent.html#a6">getRenderedMessage</a> () const </td></tr> |
| |
| <tr><td class="memItemLeft" nowrap align=right valign=top>unsigned long </td><td class="memItemRight" valign=bottom><a class="el" href="classlog4cxx_1_1spi_1_1LoggingEvent.html#a7">getThreadId</a> () const </td></tr> |
| |
| <tr><td class="memItemLeft" nowrap align=right valign=top>int64_t </td><td class="memItemRight" valign=bottom><a class="el" href="classlog4cxx_1_1spi_1_1LoggingEvent.html#a8">getTimeStamp</a> () const </td></tr> |
| |
| <tr><td class="memItemLeft" nowrap align=right valign=top>const String & </td><td class="memItemRight" valign=bottom><a class="el" href="classlog4cxx_1_1spi_1_1LoggingEvent.html#a11">getNDC</a> () const </td></tr> |
| |
| <tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="classlog4cxx_1_1spi_1_1LoggingEvent.html#a12">write</a> (<a class="el" href="classlog4cxx_1_1helpers_1_1ObjectPtrT.html">helpers::SocketOutputStreamPtr</a> &os) const </td></tr> |
| |
| <tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="classlog4cxx_1_1spi_1_1LoggingEvent.html#a14">read</a> (const <a class="el" href="classlog4cxx_1_1helpers_1_1ObjectPtrT.html">helpers::SocketInputStreamPtr</a> &is)</td></tr> |
| |
| <tr><td class="memItemLeft" nowrap align=right valign=top>String </td><td class="memItemRight" valign=bottom><a class="el" href="classlog4cxx_1_1spi_1_1LoggingEvent.html#a16">getMDC</a> (const String &key) const </td></tr> |
| |
| <tr><td class="memItemLeft" nowrap align=right valign=top>std::set< String > </td><td class="memItemRight" valign=bottom><a class="el" href="classlog4cxx_1_1spi_1_1LoggingEvent.html#a17">getMDCKeySet</a> () const </td></tr> |
| |
| <tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="classlog4cxx_1_1spi_1_1LoggingEvent.html#a18">getMDCCopy</a> () const </td></tr> |
| |
| <tr><td class="memItemLeft" nowrap align=right valign=top>String </td><td class="memItemRight" valign=bottom><a class="el" href="classlog4cxx_1_1spi_1_1LoggingEvent.html#a19">getProperty</a> (const String &key) const </td></tr> |
| |
| <tr><td class="memItemLeft" nowrap align=right valign=top>std::set< String > </td><td class="memItemRight" valign=bottom><a class="el" href="classlog4cxx_1_1spi_1_1LoggingEvent.html#a20">getPropertyKeySet</a> () const </td></tr> |
| |
| <tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="classlog4cxx_1_1spi_1_1LoggingEvent.html#a21">setProperty</a> (const String &key, const String &value)</td></tr> |
| |
| <tr><td colspan=2><br><h2>Static Public Member Functions</h2></td></tr> |
| <tr><td class="memItemLeft" nowrap align=right valign=top>int64_t </td><td class="memItemRight" valign=bottom><a class="el" href="classlog4cxx_1_1spi_1_1LoggingEvent.html#e0">getStartTime</a> ()</td></tr> |
| |
| <tr><td colspan=2><br><h2>Public Attributes</h2></td></tr> |
| <tr><td class="memItemLeft" nowrap align=right valign=top>String </td><td class="memItemRight" valign=bottom><a class="el" href="classlog4cxx_1_1spi_1_1LoggingEvent.html#o0">fqnOfCategoryClass</a></td></tr> |
| |
| </table> |
| <hr><a name="_details"></a><h2>Detailed Description</h2> |
| The internal representation of logging events. When an affirmative decision is made to log then a <code><a class="el" href="classlog4cxx_1_1spi_1_1LoggingEvent.html">LoggingEvent</a></code> instance is created. This instance is passed around to the different log4cxx components.<p> |
| This class is of concern to those wishing to extend log4cxx. |
| <p> |
| <hr><h2>Constructor & Destructor Documentation</h2> |
| <a class="anchor" name="a0" doxytag="log4cxx::spi::LoggingEvent::LoggingEvent" ></a><p> |
| <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
| <tr> |
| <td class="mdRow"> |
| <table cellpadding="0" cellspacing="0" border="0"> |
| <tr> |
| <td class="md" nowrap valign="top"> <a class="el" href="classlog4cxx_1_1spi_1_1LoggingEvent.html">LoggingEvent</a> </td> |
| <td class="md" valign="top">( </td> |
| <td class="mdname1" valign="top" nowrap> </td> |
| <td class="md" valign="top"> ) </td> |
| <td class="md" nowrap></td> |
| </tr> |
| |
| </table> |
| </td> |
| </tr> |
| </table> |
| <table cellspacing=5 cellpadding=0 border=0> |
| <tr> |
| <td> |
| |
| </td> |
| <td> |
| |
| <p> |
| For serialization only </td> |
| </tr> |
| </table> |
| <a class="anchor" name="a1" doxytag="log4cxx::spi::LoggingEvent::LoggingEvent" ></a><p> |
| <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
| <tr> |
| <td class="mdRow"> |
| <table cellpadding="0" cellspacing="0" border="0"> |
| <tr> |
| <td class="md" nowrap valign="top"> <a class="el" href="classlog4cxx_1_1spi_1_1LoggingEvent.html">LoggingEvent</a> </td> |
| <td class="md" valign="top">( </td> |
| <td class="md" nowrap valign="top">const String & </td> |
| <td class="mdname" nowrap> <em>fqnOfLoggerClass</em>, </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td></td> |
| <td class="md" nowrap>const <a class="el" href="classlog4cxx_1_1helpers_1_1ObjectPtrT.html">LoggerPtr</a> & </td> |
| <td class="mdname" nowrap> <em>logger</em>, </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td></td> |
| <td class="md" nowrap>const <a class="el" href="classlog4cxx_1_1helpers_1_1ObjectPtrT.html">LevelPtr</a> & </td> |
| <td class="mdname" nowrap> <em>level</em>, </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td></td> |
| <td class="md" nowrap>const String & </td> |
| <td class="mdname" nowrap> <em>message</em>, </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td></td> |
| <td class="md" nowrap>const char * </td> |
| <td class="mdname" nowrap> <em>file</em> = 0, </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td></td> |
| <td class="md" nowrap>int </td> |
| <td class="mdname" nowrap> <em>line</em> = -1</td> |
| </tr> |
| <tr> |
| <td></td> |
| <td class="md">) </td> |
| <td class="md" colspan="2"></td> |
| </tr> |
| |
| </table> |
| </td> |
| </tr> |
| </table> |
| <table cellspacing=5 cellpadding=0 border=0> |
| <tr> |
| <td> |
| |
| </td> |
| <td> |
| |
| <p> |
| Instantiate a <a class="el" href="classlog4cxx_1_1spi_1_1LoggingEvent.html">LoggingEvent</a> from the supplied parameters.<p> |
| Except #timeStamp all the other fields of <code><a class="el" href="classlog4cxx_1_1spi_1_1LoggingEvent.html">LoggingEvent</a></code> are filled when actually needed. <p> |
| <dl compact><dt><b>Parameters:</b></dt><dd> |
| <table border="0" cellspacing="2" cellpadding="0"> |
| <tr><td valign=top><em>fqnOfLoggerClass</em> </td><td>The fully qualified name of the calling logger class. </td></tr> |
| <tr><td valign=top><em>logger</em> </td><td>The logger of this event. </td></tr> |
| <tr><td valign=top><em>level</em> </td><td>The level of this event. </td></tr> |
| <tr><td valign=top><em>message</em> </td><td>The message of this event. </td></tr> |
| <tr><td valign=top><em>file</em> </td><td>The file where this log statement was written. </td></tr> |
| <tr><td valign=top><em>line</em> </td><td>The line where this log statement was written.</td></tr> |
| </table> |
| </dl> |
| </td> |
| </tr> |
| </table> |
| <hr><h2>Member Function Documentation</h2> |
| <a class="anchor" name="a3" doxytag="log4cxx::spi::LoggingEvent::getLevel" ></a><p> |
| <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
| <tr> |
| <td class="mdRow"> |
| <table cellpadding="0" cellspacing="0" border="0"> |
| <tr> |
| <td class="md" nowrap valign="top"> const <a class="el" href="classlog4cxx_1_1helpers_1_1ObjectPtrT.html">LevelPtr</a>& getLevel </td> |
| <td class="md" valign="top">( </td> |
| <td class="mdname1" valign="top" nowrap> </td> |
| <td class="md" valign="top"> ) </td> |
| <td class="md" nowrap> const<code> [inline]</code></td> |
| </tr> |
| |
| </table> |
| </td> |
| </tr> |
| </table> |
| <table cellspacing=5 cellpadding=0 border=0> |
| <tr> |
| <td> |
| |
| </td> |
| <td> |
| |
| <p> |
| Return the #level of this event. </td> |
| </tr> |
| </table> |
| <a class="anchor" name="a4" doxytag="log4cxx::spi::LoggingEvent::getLoggerName" ></a><p> |
| <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
| <tr> |
| <td class="mdRow"> |
| <table cellpadding="0" cellspacing="0" border="0"> |
| <tr> |
| <td class="md" nowrap valign="top"> const String & getLoggerName </td> |
| <td class="md" valign="top">( </td> |
| <td class="mdname1" valign="top" nowrap> </td> |
| <td class="md" valign="top"> ) </td> |
| <td class="md" nowrap> const</td> |
| </tr> |
| |
| </table> |
| </td> |
| </tr> |
| </table> |
| <table cellspacing=5 cellpadding=0 border=0> |
| <tr> |
| <td> |
| |
| </td> |
| <td> |
| |
| <p> |
| Return the name of the #logger. </td> |
| </tr> |
| </table> |
| <a class="anchor" name="a16" doxytag="log4cxx::spi::LoggingEvent::getMDC" ></a><p> |
| <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
| <tr> |
| <td class="mdRow"> |
| <table cellpadding="0" cellspacing="0" border="0"> |
| <tr> |
| <td class="md" nowrap valign="top"> String getMDC </td> |
| <td class="md" valign="top">( </td> |
| <td class="md" nowrap valign="top">const String & </td> |
| <td class="mdname1" valign="top" nowrap> <em>key</em> </td> |
| <td class="md" valign="top"> ) </td> |
| <td class="md" nowrap> const</td> |
| </tr> |
| |
| </table> |
| </td> |
| </tr> |
| </table> |
| <table cellspacing=5 cellpadding=0 border=0> |
| <tr> |
| <td> |
| |
| </td> |
| <td> |
| |
| <p> |
| Returns the the context corresponding to the <code>key</code> parameter. If there is a local <a class="el" href="classlog4cxx_1_1MDC.html">MDC</a> copy, possibly because we are in a logging server or running inside <a class="el" href="classlog4cxx_1_1AsyncAppender.html">AsyncAppender</a>, then we search for the key in <a class="el" href="classlog4cxx_1_1MDC.html">MDC</a> copy, if a value is found it is returned. Otherwise, if the search in <a class="el" href="classlog4cxx_1_1MDC.html">MDC</a> copy returns an empty result, then the current thread's <code><a class="el" href="classlog4cxx_1_1MDC.html">MDC</a></code> is used.<p> |
| Note that <em>both</em> the local <a class="el" href="classlog4cxx_1_1MDC.html">MDC</a> copy and the current thread's <a class="el" href="classlog4cxx_1_1MDC.html">MDC</a> are searched. </td> |
| </tr> |
| </table> |
| <a class="anchor" name="a18" doxytag="log4cxx::spi::LoggingEvent::getMDCCopy" ></a><p> |
| <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
| <tr> |
| <td class="mdRow"> |
| <table cellpadding="0" cellspacing="0" border="0"> |
| <tr> |
| <td class="md" nowrap valign="top"> void getMDCCopy </td> |
| <td class="md" valign="top">( </td> |
| <td class="mdname1" valign="top" nowrap> </td> |
| <td class="md" valign="top"> ) </td> |
| <td class="md" nowrap> const</td> |
| </tr> |
| |
| </table> |
| </td> |
| </tr> |
| </table> |
| <table cellspacing=5 cellpadding=0 border=0> |
| <tr> |
| <td> |
| |
| </td> |
| <td> |
| |
| <p> |
| Obtain a copy of this thread's <a class="el" href="classlog4cxx_1_1MDC.html">MDC</a> prior to serialization or asynchronous logging. </td> |
| </tr> |
| </table> |
| <a class="anchor" name="a17" doxytag="log4cxx::spi::LoggingEvent::getMDCKeySet" ></a><p> |
| <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
| <tr> |
| <td class="mdRow"> |
| <table cellpadding="0" cellspacing="0" border="0"> |
| <tr> |
| <td class="md" nowrap valign="top"> std::set< String > getMDCKeySet </td> |
| <td class="md" valign="top">( </td> |
| <td class="mdname1" valign="top" nowrap> </td> |
| <td class="md" valign="top"> ) </td> |
| <td class="md" nowrap> const</td> |
| </tr> |
| |
| </table> |
| </td> |
| </tr> |
| </table> |
| <table cellspacing=5 cellpadding=0 border=0> |
| <tr> |
| <td> |
| |
| </td> |
| <td> |
| |
| <p> |
| Returns the set of of the key values in the <a class="el" href="classlog4cxx_1_1MDC.html">MDC</a> for the event. The returned set is unmodifiable by the caller.<p> |
| <dl compact><dt><b>Returns:</b></dt><dd>Set an unmodifiable set of the <a class="el" href="classlog4cxx_1_1MDC.html">MDC</a> keys. </dd></dl> |
| <dl compact><dt><b>Since:</b></dt><dd>1.3</dd></dl> |
| </td> |
| </tr> |
| </table> |
| <a class="anchor" name="a5" doxytag="log4cxx::spi::LoggingEvent::getMessage" ></a><p> |
| <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
| <tr> |
| <td class="mdRow"> |
| <table cellpadding="0" cellspacing="0" border="0"> |
| <tr> |
| <td class="md" nowrap valign="top"> const String& getMessage </td> |
| <td class="md" valign="top">( </td> |
| <td class="mdname1" valign="top" nowrap> </td> |
| <td class="md" valign="top"> ) </td> |
| <td class="md" nowrap> const<code> [inline]</code></td> |
| </tr> |
| |
| </table> |
| </td> |
| </tr> |
| </table> |
| <table cellspacing=5 cellpadding=0 border=0> |
| <tr> |
| <td> |
| |
| </td> |
| <td> |
| |
| <p> |
| Return the #message for this logging event. </td> |
| </tr> |
| </table> |
| <a class="anchor" name="a11" doxytag="log4cxx::spi::LoggingEvent::getNDC" ></a><p> |
| <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
| <tr> |
| <td class="mdRow"> |
| <table cellpadding="0" cellspacing="0" border="0"> |
| <tr> |
| <td class="md" nowrap valign="top"> const String & getNDC </td> |
| <td class="md" valign="top">( </td> |
| <td class="mdname1" valign="top" nowrap> </td> |
| <td class="md" valign="top"> ) </td> |
| <td class="md" nowrap> const</td> |
| </tr> |
| |
| </table> |
| </td> |
| </tr> |
| </table> |
| <table cellspacing=5 cellpadding=0 border=0> |
| <tr> |
| <td> |
| |
| </td> |
| <td> |
| |
| <p> |
| This method returns the <a class="el" href="classlog4cxx_1_1NDC.html">NDC</a> for this event. 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_1NDC.html#e3">NDC::get</a> method should <em>never</em> be called directly. </td> |
| </tr> |
| </table> |
| <a class="anchor" name="a19" doxytag="log4cxx::spi::LoggingEvent::getProperty" ></a><p> |
| <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
| <tr> |
| <td class="mdRow"> |
| <table cellpadding="0" cellspacing="0" border="0"> |
| <tr> |
| <td class="md" nowrap valign="top"> String getProperty </td> |
| <td class="md" valign="top">( </td> |
| <td class="md" nowrap valign="top">const String & </td> |
| <td class="mdname1" valign="top" nowrap> <em>key</em> </td> |
| <td class="md" valign="top"> ) </td> |
| <td class="md" nowrap> const</td> |
| </tr> |
| |
| </table> |
| </td> |
| </tr> |
| </table> |
| <table cellspacing=5 cellpadding=0 border=0> |
| <tr> |
| <td> |
| |
| </td> |
| <td> |
| |
| <p> |
| Return a previously set property. The return value can be null. </td> |
| </tr> |
| </table> |
| <a class="anchor" name="a20" doxytag="log4cxx::spi::LoggingEvent::getPropertyKeySet" ></a><p> |
| <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
| <tr> |
| <td class="mdRow"> |
| <table cellpadding="0" cellspacing="0" border="0"> |
| <tr> |
| <td class="md" nowrap valign="top"> std::set< String > getPropertyKeySet </td> |
| <td class="md" valign="top">( </td> |
| <td class="mdname1" valign="top" nowrap> </td> |
| <td class="md" valign="top"> ) </td> |
| <td class="md" nowrap> const</td> |
| </tr> |
| |
| </table> |
| </td> |
| </tr> |
| </table> |
| <table cellspacing=5 cellpadding=0 border=0> |
| <tr> |
| <td> |
| |
| </td> |
| <td> |
| |
| <p> |
| Returns the set of of the key values in the properties for the event. The returned set is unmodifiable by the caller.<p> |
| <dl compact><dt><b>Returns:</b></dt><dd>Set an unmodifiable set of the property keys.</dd></dl> |
| </td> |
| </tr> |
| </table> |
| <a class="anchor" name="a6" doxytag="log4cxx::spi::LoggingEvent::getRenderedMessage" ></a><p> |
| <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
| <tr> |
| <td class="mdRow"> |
| <table cellpadding="0" cellspacing="0" border="0"> |
| <tr> |
| <td class="md" nowrap valign="top"> const String& getRenderedMessage </td> |
| <td class="md" valign="top">( </td> |
| <td class="mdname1" valign="top" nowrap> </td> |
| <td class="md" valign="top"> ) </td> |
| <td class="md" nowrap> const<code> [inline]</code></td> |
| </tr> |
| |
| </table> |
| </td> |
| </tr> |
| </table> |
| <table cellspacing=5 cellpadding=0 border=0> |
| <tr> |
| <td> |
| |
| </td> |
| <td> |
| |
| <p> |
| Return the #message for this logging event. </td> |
| </tr> |
| </table> |
| <a class="anchor" name="e0" doxytag="log4cxx::spi::LoggingEvent::getStartTime" ></a><p> |
| <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
| <tr> |
| <td class="mdRow"> |
| <table cellpadding="0" cellspacing="0" border="0"> |
| <tr> |
| <td class="md" nowrap valign="top"> int64_t getStartTime </td> |
| <td class="md" valign="top">( </td> |
| <td class="mdname1" valign="top" nowrap> </td> |
| <td class="md" valign="top"> ) </td> |
| <td class="md" nowrap><code> [inline, static]</code></td> |
| </tr> |
| |
| </table> |
| </td> |
| </tr> |
| </table> |
| <table cellspacing=5 cellpadding=0 border=0> |
| <tr> |
| <td> |
| |
| </td> |
| <td> |
| |
| <p> |
| Returns the time when the application started, in seconds elapsed since 01.01.1970. </td> |
| </tr> |
| </table> |
| <a class="anchor" name="a7" doxytag="log4cxx::spi::LoggingEvent::getThreadId" ></a><p> |
| <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
| <tr> |
| <td class="mdRow"> |
| <table cellpadding="0" cellspacing="0" border="0"> |
| <tr> |
| <td class="md" nowrap valign="top"> unsigned long getThreadId </td> |
| <td class="md" valign="top">( </td> |
| <td class="mdname1" valign="top" nowrap> </td> |
| <td class="md" valign="top"> ) </td> |
| <td class="md" nowrap> const<code> [inline]</code></td> |
| </tr> |
| |
| </table> |
| </td> |
| </tr> |
| </table> |
| <table cellspacing=5 cellpadding=0 border=0> |
| <tr> |
| <td> |
| |
| </td> |
| <td> |
| |
| <p> |
| Return the #threadId of this event. </td> |
| </tr> |
| </table> |
| <a class="anchor" name="a8" doxytag="log4cxx::spi::LoggingEvent::getTimeStamp" ></a><p> |
| <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
| <tr> |
| <td class="mdRow"> |
| <table cellpadding="0" cellspacing="0" border="0"> |
| <tr> |
| <td class="md" nowrap valign="top"> int64_t getTimeStamp </td> |
| <td class="md" valign="top">( </td> |
| <td class="mdname1" valign="top" nowrap> </td> |
| <td class="md" valign="top"> ) </td> |
| <td class="md" nowrap> const<code> [inline]</code></td> |
| </tr> |
| |
| </table> |
| </td> |
| </tr> |
| </table> |
| <table cellspacing=5 cellpadding=0 border=0> |
| <tr> |
| <td> |
| |
| </td> |
| <td> |
| |
| <p> |
| Return the #timeStamp of this event. </td> |
| </tr> |
| </table> |
| <a class="anchor" name="a14" doxytag="log4cxx::spi::LoggingEvent::read" ></a><p> |
| <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
| <tr> |
| <td class="mdRow"> |
| <table cellpadding="0" cellspacing="0" border="0"> |
| <tr> |
| <td class="md" nowrap valign="top"> void read </td> |
| <td class="md" valign="top">( </td> |
| <td class="md" nowrap valign="top">const <a class="el" href="classlog4cxx_1_1helpers_1_1ObjectPtrT.html">helpers::SocketInputStreamPtr</a> & </td> |
| <td class="mdname1" valign="top" nowrap> <em>is</em> </td> |
| <td class="md" valign="top"> ) </td> |
| <td class="md" nowrap></td> |
| </tr> |
| |
| </table> |
| </td> |
| </tr> |
| </table> |
| <table cellspacing=5 cellpadding=0 border=0> |
| <tr> |
| <td> |
| |
| </td> |
| <td> |
| |
| <p> |
| Read this event from a helpers::SocketOutputStream. </td> |
| </tr> |
| </table> |
| <a class="anchor" name="a21" doxytag="log4cxx::spi::LoggingEvent::setProperty" ></a><p> |
| <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
| <tr> |
| <td class="mdRow"> |
| <table cellpadding="0" cellspacing="0" border="0"> |
| <tr> |
| <td class="md" nowrap valign="top"> void setProperty </td> |
| <td class="md" valign="top">( </td> |
| <td class="md" nowrap valign="top">const String & </td> |
| <td class="mdname" nowrap> <em>key</em>, </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td></td> |
| <td class="md" nowrap>const String & </td> |
| <td class="mdname" nowrap> <em>value</em></td> |
| </tr> |
| <tr> |
| <td></td> |
| <td class="md">) </td> |
| <td class="md" colspan="2"></td> |
| </tr> |
| |
| </table> |
| </td> |
| </tr> |
| </table> |
| <table cellspacing=5 cellpadding=0 border=0> |
| <tr> |
| <td> |
| |
| </td> |
| <td> |
| |
| <p> |
| Set a string property using a key and a string value. since 1.3 </td> |
| </tr> |
| </table> |
| <a class="anchor" name="a12" doxytag="log4cxx::spi::LoggingEvent::write" ></a><p> |
| <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
| <tr> |
| <td class="mdRow"> |
| <table cellpadding="0" cellspacing="0" border="0"> |
| <tr> |
| <td class="md" nowrap valign="top"> void write </td> |
| <td class="md" valign="top">( </td> |
| <td class="md" nowrap valign="top"><a class="el" href="classlog4cxx_1_1helpers_1_1ObjectPtrT.html">helpers::SocketOutputStreamPtr</a> & </td> |
| <td class="mdname1" valign="top" nowrap> <em>os</em> </td> |
| <td class="md" valign="top"> ) </td> |
| <td class="md" nowrap> const</td> |
| </tr> |
| |
| </table> |
| </td> |
| </tr> |
| </table> |
| <table cellspacing=5 cellpadding=0 border=0> |
| <tr> |
| <td> |
| |
| </td> |
| <td> |
| |
| <p> |
| Write this event to a helpers::SocketOutputStream. </td> |
| </tr> |
| </table> |
| <hr><h2>Member Data Documentation</h2> |
| <a class="anchor" name="o0" doxytag="log4cxx::spi::LoggingEvent::fqnOfCategoryClass" ></a><p> |
| <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
| <tr> |
| <td class="mdRow"> |
| <table cellpadding="0" cellspacing="0" border="0"> |
| <tr> |
| <td class="md" nowrap valign="top"> String <a class="el" href="classlog4cxx_1_1spi_1_1LoggingEvent.html#o0">fqnOfCategoryClass</a> |
| </table> |
| </td> |
| </tr> |
| </table> |
| <table cellspacing=5 cellpadding=0 border=0> |
| <tr> |
| <td> |
| |
| </td> |
| <td> |
| |
| <p> |
| Fully qualified name of the calling category class. </td> |
| </tr> |
| </table> |
| <hr>The documentation for this class was generated from the following files:<ul> |
| <li>loggingevent.h<li>loggingevent.cpp</ul> |
| |
| </td> |
| </tr> |
| |
| <!-- FOOTER --> |
| <tr><td colspan="2"> |
| <hr noshade="" size="1"/> |
| </td></tr> |
| <tr><td colspan="2"> |
| <div align="center"><font color="#525D76" size="-1"><em> |
| Copyright © 1999-2004, Apache Software Foundation |
| </em></font></div> |
| </td></tr> |
| </table> |
| <!-- END main table --> |
| </body> |
| </html> |
| <!-- end the processing --> |
