blob: 9ebaf3f01816196cea08af630a498e2140341024 [file] [log] [blame]
<!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"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Apache log4cxx: messagepatternconverter.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="customdoxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Apache log4cxx
&#160;<span id="projectnumber">Version 0.13.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('messagepatternconverter_8h_source.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="headertitle">
<div class="title">messagepatternconverter.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="messagepatternconverter_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">/*</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment"> * Licensed to the Apache Software Foundation (ASF) under one or more</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment"> * contributor license agreements. See the NOTICE file distributed with</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment"> * this work for additional information regarding copyright ownership.</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment"> * The ASF licenses this file to You under the Apache License, Version 2.0</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment"> * (the &quot;License&quot;); you may not use this file except in compliance with</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment"> * the License. You may obtain a copy of the License at</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment"> * Unless required by applicable law or agreed to in writing, software</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment"> * distributed under the License is distributed on an &quot;AS IS&quot; BASIS,</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment"> * See the License for the specific language governing permissions and</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="comment"> * limitations under the License.</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;</div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="preprocessor">#ifndef _LOG4CXX_PATTERN_MESSAGE_PATTERN_CONVERTER</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="preprocessor">#define _LOG4CXX_PATTERN_MESSAGE_PATTERN_CONVERTER</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;</div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="loggingeventpatternconverter_8h.html">log4cxx/pattern/loggingeventpatternconverter.h</a>&gt;</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;</div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespacelog4cxx.html">log4cxx</a></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;{</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="keyword">namespace </span>pattern</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;{</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;</div><div class="line"><a name="l00035"></a><span class="lineno"><a class="line" href="classlog4cxx_1_1pattern_1_1MessagePatternConverter.html"> 35</a></span>&#160;<span class="keyword">class </span>LOG4CXX_EXPORT <a class="code" href="classlog4cxx_1_1pattern_1_1MessagePatternConverter.html">MessagePatternConverter</a> : <span class="keyword">public</span> <a class="code" href="classlog4cxx_1_1pattern_1_1LoggingEventPatternConverter.html">LoggingEventPatternConverter</a></div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;{</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; <a class="code" href="classlog4cxx_1_1pattern_1_1MessagePatternConverter.html">MessagePatternConverter</a>();</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; <span class="keyword">public</span>:</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; <a class="code" href="patternconverter_8h.html#af93dc7287929a0437da734174549a7d0">DECLARE_LOG4CXX_PATTERN</a>(MessagePatternConverter)</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; <a class="code" href="object_8h.html#ac8ff8f70159e03fe7d8c4aa743cc9cda">BEGIN_LOG4CXX_CAST_MAP</a>()</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; <a class="code" href="object_8h.html#a642180530328ec0378468edda5bc94e2">LOG4CXX_CAST_ENTRY</a>(MessagePatternConverter)</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; <a class="code" href="object_8h.html#ab14dc1a75d63a11359c8861a59786abc">LOG4CXX_CAST_ENTRY_CHAIN</a>(<a class="code" href="classlog4cxx_1_1pattern_1_1LoggingEventPatternConverter.html">LoggingEventPatternConverter</a>)</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; <a class="code" href="object_8h.html#a917a7d053853b1ffdf45a3d91aeca4f1">END_LOG4CXX_CAST_MAP</a>()</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160;</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; </div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; <span class="keyword">static</span> PatternConverterPtr newInstance(</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; <span class="keyword">const</span> std::vector&lt;LogString&gt;&amp; options);</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160;</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; <span class="keyword">using</span> <a class="code" href="classlog4cxx_1_1pattern_1_1LoggingEventPatternConverter.html#ab28bf396645f7c7594f6a2a8687b3a38">LoggingEventPatternConverter::format</a>;</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160;</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; <span class="keywordtype">void</span> format(<span class="keyword">const</span> <a class="code" href="namespacelog4cxx_1_1spi.html#aae6992e1b33222c26bdc1173b6aedc6c">log4cxx::spi::LoggingEventPtr</a>&amp; event,</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; <a class="code" href="namespacelog4cxx.html#aa2308ed05fef2a1366066cb38b177e94">LogString</a>&amp; toAppendTo,</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; <a class="code" href="classlog4cxx_1_1helpers_1_1Pool.html">log4cxx::helpers::Pool</a>&amp; p) <span class="keyword">const</span>;</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160;};</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160;}</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160;}</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160;<span class="preprocessor">#endif</span></div><div class="ttc" id="object_8h_html_a642180530328ec0378468edda5bc94e2"><div class="ttname"><a href="object_8h.html#a642180530328ec0378468edda5bc94e2">LOG4CXX_CAST_ENTRY</a></div><div class="ttdeci">#define LOG4CXX_CAST_ENTRY(Interface)</div><div class="ttdef"><b>Definition:</b> object.h:153</div></div>
<div class="ttc" id="object_8h_html_a917a7d053853b1ffdf45a3d91aeca4f1"><div class="ttname"><a href="object_8h.html#a917a7d053853b1ffdf45a3d91aeca4f1">END_LOG4CXX_CAST_MAP</a></div><div class="ttdeci">#define END_LOG4CXX_CAST_MAP()</div><div class="ttdef"><b>Definition:</b> object.h:147</div></div>
<div class="ttc" id="namespacelog4cxx_1_1spi_html_aae6992e1b33222c26bdc1173b6aedc6c"><div class="ttname"><a href="namespacelog4cxx_1_1spi.html#aae6992e1b33222c26bdc1173b6aedc6c">log4cxx::spi::LoggingEventPtr</a></div><div class="ttdeci">std::shared_ptr&lt; LoggingEvent &gt; LoggingEventPtr</div><div class="ttdef"><b>Definition:</b> appender.h:37</div></div>
<div class="ttc" id="object_8h_html_ac8ff8f70159e03fe7d8c4aa743cc9cda"><div class="ttname"><a href="object_8h.html#ac8ff8f70159e03fe7d8c4aa743cc9cda">BEGIN_LOG4CXX_CAST_MAP</a></div><div class="ttdeci">#define BEGIN_LOG4CXX_CAST_MAP()</div><div class="ttdef"><b>Definition:</b> object.h:141</div></div>
<div class="ttc" id="classlog4cxx_1_1pattern_1_1LoggingEventPatternConverter_html"><div class="ttname"><a href="classlog4cxx_1_1pattern_1_1LoggingEventPatternConverter.html">log4cxx::pattern::LoggingEventPatternConverter</a></div><div class="ttdoc">LoggingEventPatternConverter is a base class for pattern converters that can format information from ...</div><div class="ttdef"><b>Definition:</b> loggingeventpatternconverter.h:37</div></div>
<div class="ttc" id="classlog4cxx_1_1pattern_1_1LoggingEventPatternConverter_html_ab28bf396645f7c7594f6a2a8687b3a38"><div class="ttname"><a href="classlog4cxx_1_1pattern_1_1LoggingEventPatternConverter.html#ab28bf396645f7c7594f6a2a8687b3a38">log4cxx::pattern::LoggingEventPatternConverter::format</a></div><div class="ttdeci">virtual void format(const log4cxx::spi::LoggingEventPtr &amp;event, LogString &amp;toAppendTo, log4cxx::helpers::Pool &amp;p) const =0</div><div class="ttdoc">Formats an event into a string buffer. </div></div>
<div class="ttc" id="classlog4cxx_1_1pattern_1_1MessagePatternConverter_html"><div class="ttname"><a href="classlog4cxx_1_1pattern_1_1MessagePatternConverter.html">log4cxx::pattern::MessagePatternConverter</a></div><div class="ttdoc">Formats the message of an logging event. </div><div class="ttdef"><b>Definition:</b> messagepatternconverter.h:35</div></div>
<div class="ttc" id="classlog4cxx_1_1helpers_1_1Pool_html"><div class="ttname"><a href="classlog4cxx_1_1helpers_1_1Pool.html">log4cxx::helpers::Pool</a></div><div class="ttdef"><b>Definition:</b> pool.h:32</div></div>
<div class="ttc" id="object_8h_html_ab14dc1a75d63a11359c8861a59786abc"><div class="ttname"><a href="object_8h.html#ab14dc1a75d63a11359c8861a59786abc">LOG4CXX_CAST_ENTRY_CHAIN</a></div><div class="ttdeci">#define LOG4CXX_CAST_ENTRY_CHAIN(Interface)</div><div class="ttdef"><b>Definition:</b> object.h:159</div></div>
<div class="ttc" id="patternconverter_8h_html_af93dc7287929a0437da734174549a7d0"><div class="ttname"><a href="patternconverter_8h.html#af93dc7287929a0437da734174549a7d0">DECLARE_LOG4CXX_PATTERN</a></div><div class="ttdeci">#define DECLARE_LOG4CXX_PATTERN(cls)</div><div class="ttdef"><b>Definition:</b> patternconverter.h:31</div></div>
<div class="ttc" id="loggingeventpatternconverter_8h_html"><div class="ttname"><a href="loggingeventpatternconverter_8h.html">loggingeventpatternconverter.h</a></div></div>
<div class="ttc" id="namespacelog4cxx_html"><div class="ttname"><a href="namespacelog4cxx.html">log4cxx</a></div><div class="ttdef"><b>Definition:</b> appender.h:32</div></div>
<div class="ttc" id="namespacelog4cxx_html_aa2308ed05fef2a1366066cb38b177e94"><div class="ttname"><a href="namespacelog4cxx.html#aa2308ed05fef2a1366066cb38b177e94">log4cxx::LogString</a></div><div class="ttdeci">std::basic_string&lt; logchar &gt; LogString</div><div class="ttdef"><b>Definition:</b> logstring.h:66</div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- HTML footer for doxygen 1.8.13-->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_5eb159725f84c66aafd839904a4acdd0.html">main</a></li><li class="navelem"><a class="el" href="dir_df3bee86fdbfb464c3a94507855b0bdc.html">include</a></li><li class="navelem"><a class="el" href="dir_7be30a74690c85c659aa4940da9d1914.html">log4cxx</a></li><li class="navelem"><a class="el" href="dir_5e0574ca792075d61026f042d0b321c8.html">pattern</a></li><li class="navelem"><a class="el" href="messagepatternconverter_8h.html">messagepatternconverter.h</a></li>
<li class="footer">Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
<li class="center">
Copyright &copy; 2003-2022 <a href="https://www.apache.org/">Apache Software Foundation</a>. All Rights Reserved. <a href="https://privacy.apache.org/policies/privacy-policy-public.html">Privacy Policy</a><br/>
Apache Logging, Apache Log4j, Log4j, Apache, the Apache feather logo, and the Apache Logging project logo are trademarks of The Apache Software Foundation.<br/>
</li>
</ul>
</div>
</body>
</html>