blob: 77670cd0d3cd49ea83f3a074401dc305d937a284 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>pvlogger.h File Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.2.18 -->
<center>
<a class="qindex" href="index.html">Main Page</a> &nbsp; <a class="qindex" href="modules.html">Modules</a> &nbsp; <a class="qindex" href="hierarchy.html">Class Hierarchy</a> &nbsp; <a class="qindex" href="annotated.html">Data Structures</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="functions.html">Data Fields</a> &nbsp; <a class="qindex" href="globals.html">Globals</a> &nbsp; </center>
<hr><h1>pvlogger.h File Reference</h1>This file contains basic logger interfaces for common use across platforms.
<a href="#_details">More...</a>
<p>
<code>#include "<a class="el" href="oscl__base_8h-source.html">oscl_base.h</a>"</code><br>
<code>#include "<a class="el" href="oscl__vector_8h-source.html">oscl_vector.h</a>"</code><br>
<code>#include "<a class="el" href="oscl__shared__ptr_8h-source.html">oscl_shared_ptr.h</a>"</code><br>
<code>#include "<a class="el" href="oscl__base__alloc_8h-source.html">oscl_base_alloc.h</a>"</code><br>
<p>
<a href="pvlogger_8h-source.html">Go to the source code of this file.</a><table border=0 cellpadding=0 cellspacing=0>
<tr><td></td></tr>
<tr><td colspan=2><br><h2>Data Structures</h2></td></tr>
<tr><td nowrap align=right valign=top>class &nbsp;</td><td valign=bottom><a class="el" href="classPVLogger.html">PVLogger</a></td></tr>
<tr><td colspan=2><br><h2>Defines</h2></td></tr>
<tr><td nowrap align=right valign=top>#define&nbsp;</td><td valign=bottom><a class="el" href="pvlogger_8h.html#a0">PVLOGMSG_INST_REL</a>&nbsp;&nbsp;&nbsp;0</td></tr>
<tr><td nowrap align=right valign=top>#define&nbsp;</td><td valign=bottom><a class="el" href="pvlogger_8h.html#a1">PVLOGMSG_INST_PROF</a>&nbsp;&nbsp;&nbsp;1</td></tr>
<tr><td nowrap align=right valign=top>#define&nbsp;</td><td valign=bottom><a class="el" href="pvlogger_8h.html#a2">PVLOGMSG_INST_HLDBG</a>&nbsp;&nbsp;&nbsp;2</td></tr>
<tr><td nowrap align=right valign=top>#define&nbsp;</td><td valign=bottom><a class="el" href="pvlogger_8h.html#a3">PVLOGMSG_INST_MLDBG</a>&nbsp;&nbsp;&nbsp;3</td></tr>
<tr><td nowrap align=right valign=top>#define&nbsp;</td><td valign=bottom><a class="el" href="pvlogger_8h.html#a4">PVLOGMSG_INST_LLDBG</a>&nbsp;&nbsp;&nbsp;4</td></tr>
<tr><td nowrap align=right valign=top>#define&nbsp;</td><td valign=bottom><a class="el" href="pvlogger_8h.html#a5">PVLOGGER_INST_LEVEL</a>&nbsp;&nbsp;&nbsp;5</td></tr>
<tr><td nowrap align=right valign=top>#define&nbsp;</td><td valign=bottom><a class="el" href="pvlogger_8h.html#a6">_PVLOGGER_LOGMSG</a>(LOGGER, LEVEL, MESSAGE)</td></tr>
<tr><td nowrap align=right valign=top>#define&nbsp;</td><td valign=bottom><a class="el" href="pvlogger_8h.html#a7">_PVLOGGER_LOGMSG_V</a>(LOGGER, LEVEL, MESSAGE)</td></tr>
<tr><td nowrap align=right valign=top>#define&nbsp;</td><td valign=bottom><a class="el" href="pvlogger_8h.html#a8">_PVLOGGER_LOGBIN</a>(LOGGER, LEVEL, MESSAGE)</td></tr>
<tr><td nowrap align=right valign=top>#define&nbsp;</td><td valign=bottom><a class="el" href="pvlogger_8h.html#a9">_PVLOGGER_LOGBIN_V</a>(LOGGER, LEVEL, MESSAGE)</td></tr>
<tr><td nowrap align=right valign=top>#define&nbsp;</td><td valign=bottom><a class="el" href="pvlogger_8h.html#a10">PVLOGGER_INST_LEVEL_SUPPORT</a>&nbsp;&nbsp;&nbsp;1</td></tr>
<tr><td nowrap align=right valign=top>#define&nbsp;</td><td valign=bottom><a class="el" href="pvlogger_8h.html#a11">PVLOGGER_LOGMSG_PVLOGMSG_INST_REL</a>(LOGGER, LEVEL, MESSAGE)&nbsp;&nbsp;&nbsp;_PVLOGGER_LOGMSG(LOGGER, LEVEL, MESSAGE)</td></tr>
<tr><td nowrap align=right valign=top>#define&nbsp;</td><td valign=bottom><a class="el" href="pvlogger_8h.html#a12">PVLOGGER_LOGMSG_V_PVLOGMSG_INST_REL</a>(LOGGER, LEVEL, MESSAGE)&nbsp;&nbsp;&nbsp;_PVLOGGER_LOGMSG_V(LOGGER, LEVEL, MESSAGE)</td></tr>
<tr><td nowrap align=right valign=top>#define&nbsp;</td><td valign=bottom><a class="el" href="pvlogger_8h.html#a13">PVLOGGER_LOGBIN_PVLOGMSG_INST_REL</a>(LOGGER, LEVEL, MESSAGE)&nbsp;&nbsp;&nbsp;_PVLOGGER_LOGBIN(LOGGER, LEVEL, MESSAGE)</td></tr>
<tr><td nowrap align=right valign=top>#define&nbsp;</td><td valign=bottom><a class="el" href="pvlogger_8h.html#a14">PVLOGGER_LOGBIN_V_PVLOGMSG_INST_REL</a>(LOGGER, LEVEL, MESSAGE)&nbsp;&nbsp;&nbsp;_PVLOGGER_LOGBIN_V(LOGGER, LEVEL, MESSAGE)</td></tr>
<tr><td nowrap align=right valign=top>#define&nbsp;</td><td valign=bottom><a class="el" href="pvlogger_8h.html#a15">PVLOGGER_LOGMSG_PVLOGMSG_INST_PROF</a>(LOGGER, LEVEL, MESSAGE)&nbsp;&nbsp;&nbsp;_PVLOGGER_LOGMSG(LOGGER, LEVEL, MESSAGE)</td></tr>
<tr><td nowrap align=right valign=top>#define&nbsp;</td><td valign=bottom><a class="el" href="pvlogger_8h.html#a16">PVLOGGER_LOGMSG_V_PVLOGMSG_INST_PROF</a>(LOGGER, LEVEL, MESSAGE)&nbsp;&nbsp;&nbsp;_PVLOGGER_LOGMSG_V(LOGGER, LEVEL, MESSAGE)</td></tr>
<tr><td nowrap align=right valign=top>#define&nbsp;</td><td valign=bottom><a class="el" href="pvlogger_8h.html#a17">PVLOGGER_LOGBIN_PVLOGMSG_INST_PROF</a>(LOGGER, LEVEL, MESSAGE)&nbsp;&nbsp;&nbsp;_PVLOGGER_LOGBIN(LOGGER, LEVEL, MESSAGE)</td></tr>
<tr><td nowrap align=right valign=top>#define&nbsp;</td><td valign=bottom><a class="el" href="pvlogger_8h.html#a18">PVLOGGER_LOGBIN_V_PVLOGMSG_INST_PROF</a>(LOGGER, LEVEL, MESSAGE)&nbsp;&nbsp;&nbsp;_PVLOGGER_LOGBIN_V(LOGGER, LEVEL, MESSAGE)</td></tr>
<tr><td nowrap align=right valign=top>#define&nbsp;</td><td valign=bottom><a class="el" href="pvlogger_8h.html#a19">PVLOGGER_LOGMSG_PVLOGMSG_INST_HLDBG</a>(LOGGER, LEVEL, MESSAGE)&nbsp;&nbsp;&nbsp;_PVLOGGER_LOGMSG(LOGGER, LEVEL, MESSAGE)</td></tr>
<tr><td nowrap align=right valign=top>#define&nbsp;</td><td valign=bottom><a class="el" href="pvlogger_8h.html#a20">PVLOGGER_LOGMSG_V_PVLOGMSG_INST_HLDBG</a>(LOGGER, LEVEL, MESSAGE)&nbsp;&nbsp;&nbsp;_PVLOGGER_LOGMSG_V(LOGGER, LEVEL, MESSAGE)</td></tr>
<tr><td nowrap align=right valign=top>#define&nbsp;</td><td valign=bottom><a class="el" href="pvlogger_8h.html#a21">PVLOGGER_LOGBIN_PVLOGMSG_INST_HLDBG</a>(LOGGER, LEVEL, MESSAGE)&nbsp;&nbsp;&nbsp;_PVLOGGER_LOGBIN(LOGGER, LEVEL, MESSAGE)</td></tr>
<tr><td nowrap align=right valign=top>#define&nbsp;</td><td valign=bottom><a class="el" href="pvlogger_8h.html#a22">PVLOGGER_LOGBIN_V_PVLOGMSG_INST_HLDBG</a>(LOGGER, LEVEL, MESSAGE)&nbsp;&nbsp;&nbsp;_PVLOGGER_LOGBIN_V(LOGGER, LEVEL, MESSAGE)</td></tr>
<tr><td nowrap align=right valign=top>#define&nbsp;</td><td valign=bottom><a class="el" href="pvlogger_8h.html#a23">PVLOGGER_LOGMSG_PVLOGMSG_INST_MLDBG</a>(LOGGER, LEVEL, MESSAGE)&nbsp;&nbsp;&nbsp;_PVLOGGER_LOGMSG(LOGGER, LEVEL, MESSAGE)</td></tr>
<tr><td nowrap align=right valign=top>#define&nbsp;</td><td valign=bottom><a class="el" href="pvlogger_8h.html#a24">PVLOGGER_LOGMSG_V_PVLOGMSG_INST_MLDBG</a>(LOGGER, LEVEL, MESSAGE)&nbsp;&nbsp;&nbsp;_PVLOGGER_LOGMSG_V(LOGGER, LEVEL, MESSAGE)</td></tr>
<tr><td nowrap align=right valign=top>#define&nbsp;</td><td valign=bottom><a class="el" href="pvlogger_8h.html#a25">PVLOGGER_LOGBIN_PVLOGMSG_INST_MLDBG</a>(LOGGER, LEVEL, MESSAGE)&nbsp;&nbsp;&nbsp;_PVLOGGER_LOGBIN(LOGGER, LEVEL, MESSAGE)</td></tr>
<tr><td nowrap align=right valign=top>#define&nbsp;</td><td valign=bottom><a class="el" href="pvlogger_8h.html#a26">PVLOGGER_LOGBIN_V_PVLOGMSG_V_INST_MLDBG</a>(LOGGER, LEVEL, MESSAGE)&nbsp;&nbsp;&nbsp;_PVLOGGER_LOGBIN_V(LOGGER, LEVEL, MESSAGE)</td></tr>
<tr><td nowrap align=right valign=top>#define&nbsp;</td><td valign=bottom><a class="el" href="pvlogger_8h.html#a27">PVLOGGER_LOGMSG_PVLOGMSG_INST_LLDBG</a>(LOGGER, LEVEL, MESSAGE)&nbsp;&nbsp;&nbsp;_PVLOGGER_LOGMSG(LOGGER, LEVEL, MESSAGE)</td></tr>
<tr><td nowrap align=right valign=top>#define&nbsp;</td><td valign=bottom><a class="el" href="pvlogger_8h.html#a28">PVLOGGER_LOGMSG_V_PVLOGMSG_INST_LLDBG</a>(LOGGER, LEVEL, MESSAGE)&nbsp;&nbsp;&nbsp;_PVLOGGER_LOGMSG_V(LOGGER, LEVEL, MESSAGE)</td></tr>
<tr><td nowrap align=right valign=top>#define&nbsp;</td><td valign=bottom><a class="el" href="pvlogger_8h.html#a29">PVLOGGER_LOGBIN_PVLOGMSG_INST_LLDBG</a>(LOGGER, LEVEL, MESSAGE)&nbsp;&nbsp;&nbsp;_PVLOGGER_LOGBIN(LOGGER, LEVEL, MESSAGE)</td></tr>
<tr><td nowrap align=right valign=top>#define&nbsp;</td><td valign=bottom><a class="el" href="pvlogger_8h.html#a30">PVLOGGER_LOGBIN_V_PVLOGMSG_INST_LLDBG</a>(LOGGER, LEVEL, MESSAGE)&nbsp;&nbsp;&nbsp;_PVLOGGER_LOGBIN_V(LOGGER, LEVEL, MESSAGE)</td></tr>
<tr><td nowrap align=right valign=top>#define&nbsp;</td><td valign=bottom><a class="el" href="pvlogger_8h.html#a31">PVLOGGER_LOGMSG</a>(IL, LOGGER, LEVEL, MESSAGE)&nbsp;&nbsp;&nbsp;PVLOGGER_LOGMSG_ ## IL (LOGGER, LEVEL, MESSAGE)</td></tr>
<tr><td nowrap align=right valign=top>#define&nbsp;</td><td valign=bottom><a class="el" href="pvlogger_8h.html#a32">PVLOGGER_LOGMSG_V</a>(IL, LOGGER, LEVEL, MESSAGE)&nbsp;&nbsp;&nbsp;PVLOGGER_LOGMSG_V_ ## IL (LOGGER, LEVEL, MESSAGE)</td></tr>
<tr><td nowrap align=right valign=top>#define&nbsp;</td><td valign=bottom><a class="el" href="pvlogger_8h.html#a33">PVLOGGER_LOGBIN</a>(IL, LOGGER, LEVEL, MESSAGE)&nbsp;&nbsp;&nbsp;PVLOGGER_LOGBIN_ ## IL (LOGGER, LEVEL, MESSAGE)</td></tr>
<tr><td nowrap align=right valign=top>#define&nbsp;</td><td valign=bottom><a class="el" href="pvlogger_8h.html#a34">PVLOGGER_LOGBIN_V</a>(IL, LOGGER, LEVEL, MESSAGE)&nbsp;&nbsp;&nbsp;PVLOGGER_LOGBIN_V_ ## IL (LOGGER, LEVEL, MESSAGE)</td></tr>
<tr><td nowrap align=right valign=top>#define&nbsp;</td><td valign=bottom><a class="el" href="pvlogger_8h.html#a35">PVLOGGER_LOG_USE_ONLY</a>(x)&nbsp;&nbsp;&nbsp;x</td></tr>
<tr><td nowrap align=right valign=top>#define&nbsp;</td><td valign=bottom><a class="el" href="pvlogger_8h.html#a36">PVLOGGER_ENABLE</a>&nbsp;&nbsp;&nbsp;1</td></tr>
<tr><td colspan=2><br><h2>Variables</h2></td></tr>
<tr><td nowrap align=right valign=top>const int32&nbsp;</td><td valign=bottom><a class="el" href="pvlogger_8h.html#a37">PVLOGGER_LEVEL_UNINTIALIZED</a> = -1</td></tr>
<tr><td nowrap align=right valign=top>const <a class="el" href="classPVLogger.html#s0">PVLogger::log_level_type</a>&nbsp;</td><td valign=bottom><a class="el" href="pvlogger_8h.html#a38">PVLOGMSG_EMERG</a> = 0</td></tr>
<tr><td nowrap align=right valign=top>const <a class="el" href="classPVLogger.html#s0">PVLogger::log_level_type</a>&nbsp;</td><td valign=bottom><a class="el" href="pvlogger_8h.html#a39">PVLOGMSG_ALERT</a> = 1</td></tr>
<tr><td nowrap align=right valign=top>const <a class="el" href="classPVLogger.html#s0">PVLogger::log_level_type</a>&nbsp;</td><td valign=bottom><a class="el" href="pvlogger_8h.html#a40">PVLOGMSG_CRIT</a> = 2</td></tr>
<tr><td nowrap align=right valign=top>const <a class="el" href="classPVLogger.html#s0">PVLogger::log_level_type</a>&nbsp;</td><td valign=bottom><a class="el" href="pvlogger_8h.html#a41">PVLOGMSG_ERR</a> = 3</td></tr>
<tr><td nowrap align=right valign=top>const <a class="el" href="classPVLogger.html#s0">PVLogger::log_level_type</a>&nbsp;</td><td valign=bottom><a class="el" href="pvlogger_8h.html#a42">PVLOGMSG_WARNING</a> = 4</td></tr>
<tr><td nowrap align=right valign=top>const <a class="el" href="classPVLogger.html#s0">PVLogger::log_level_type</a>&nbsp;</td><td valign=bottom><a class="el" href="pvlogger_8h.html#a43">PVLOGMSG_NOTICE</a> = 5</td></tr>
<tr><td nowrap align=right valign=top>const <a class="el" href="classPVLogger.html#s0">PVLogger::log_level_type</a>&nbsp;</td><td valign=bottom><a class="el" href="pvlogger_8h.html#a44">PVLOGMSG_INFO</a> = 6</td></tr>
<tr><td nowrap align=right valign=top>const <a class="el" href="classPVLogger.html#s0">PVLogger::log_level_type</a>&nbsp;</td><td valign=bottom><a class="el" href="pvlogger_8h.html#a45">PVLOGMSG_STACK_TRACE</a> = 7</td></tr>
<tr><td nowrap align=right valign=top>const <a class="el" href="classPVLogger.html#s0">PVLogger::log_level_type</a>&nbsp;</td><td valign=bottom><a class="el" href="pvlogger_8h.html#a46">PVLOGMSG_DEBUG</a> = 8</td></tr>
<tr><td nowrap align=right valign=top>const <a class="el" href="classPVLogger.html#s0">PVLogger::log_level_type</a>&nbsp;</td><td valign=bottom><a class="el" href="pvlogger_8h.html#a47">PVLOGMSG_FATAL_ERROR</a> = <a class="el" href="pvlogger_8h.html#a38">PVLOGMSG_EMERG</a></td></tr>
<tr><td nowrap align=right valign=top>const <a class="el" href="classPVLogger.html#s0">PVLogger::log_level_type</a>&nbsp;</td><td valign=bottom><a class="el" href="pvlogger_8h.html#a48">PVLOGMSG_NONFATAL_ERROR</a> = <a class="el" href="pvlogger_8h.html#a41">PVLOGMSG_ERR</a></td></tr>
<tr><td nowrap align=right valign=top>const <a class="el" href="classPVLogger.html#s0">PVLogger::log_level_type</a>&nbsp;</td><td valign=bottom><a class="el" href="pvlogger_8h.html#a49">PVLOGMSG_STATISTIC</a> = <a class="el" href="pvlogger_8h.html#a44">PVLOGMSG_INFO</a></td></tr>
<tr><td nowrap align=right valign=top>const <a class="el" href="classPVLogger.html#s0">PVLogger::log_level_type</a>&nbsp;</td><td valign=bottom><a class="el" href="pvlogger_8h.html#a50">PVLOGMSG_VERBOSE</a> = <a class="el" href="pvlogger_8h.html#a46">PVLOGMSG_DEBUG</a></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
This file contains basic logger interfaces for common use across platforms.
<p>
This is the main entry point header file for the logger library. It should be the only one users directly include.
<p>
<hr><h2>Define Documentation</h2>
<a name="a8" doxytag="pvlogger.h::_PVLOGGER_LOGBIN"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> #define _PVLOGGER_LOGBIN</td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">LOGGER, <tr>
<td></td>
<td></td>
<td class="md" nowrap>LEVEL, <tr>
<td></td>
<td></td>
<td class="md" nowrap>MESSAGE&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
<b>Value:</b><div class="fragment"><pre>{\
<span class="keywordflow">if</span> (LOGGER)\
{\
<span class="keywordflow">if</span> (LOGGER-&gt;IsActive(LEVEL))\
{\
LOGGER-&gt;LogMsgBuffers MESSAGE;\
}\
}\
}</pre></div> </td>
</tr>
</table>
<a name="a9" doxytag="pvlogger.h::_PVLOGGER_LOGBIN_V"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> #define _PVLOGGER_LOGBIN_V</td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">LOGGER, <tr>
<td></td>
<td></td>
<td class="md" nowrap>LEVEL, <tr>
<td></td>
<td></td>
<td class="md" nowrap>MESSAGE&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
<b>Value:</b><div class="fragment"><pre>{\
<span class="keywordflow">if</span> (LOGGER)\
{\
<span class="keywordflow">if</span> (LOGGER-&gt;IsActive(LEVEL))\
{\
LOGGER-&gt;LogMsgBuffersV MESSAGE;\
}\
}\
}</pre></div> </td>
</tr>
</table>
<a name="a6" doxytag="pvlogger.h::_PVLOGGER_LOGMSG"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> #define _PVLOGGER_LOGMSG</td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">LOGGER, <tr>
<td></td>
<td></td>
<td class="md" nowrap>LEVEL, <tr>
<td></td>
<td></td>
<td class="md" nowrap>MESSAGE&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
<b>Value:</b><div class="fragment"><pre>{\
<span class="keywordflow">if</span> (LOGGER)\
{\
<span class="keywordflow">if</span> (LOGGER-&gt;IsActive(LEVEL))\
{\
LOGGER-&gt;LogMsgString MESSAGE;\
}\
}\
}</pre></div> </td>
</tr>
</table>
<a name="a7" doxytag="pvlogger.h::_PVLOGGER_LOGMSG_V"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> #define _PVLOGGER_LOGMSG_V</td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">LOGGER, <tr>
<td></td>
<td></td>
<td class="md" nowrap>LEVEL, <tr>
<td></td>
<td></td>
<td class="md" nowrap>MESSAGE&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
<b>Value:</b><div class="fragment"><pre>{\
<span class="keywordflow">if</span> (LOGGER)\
{\
<span class="keywordflow">if</span> (LOGGER-&gt;IsActive(LEVEL))\
{\
LOGGER-&gt;LogMsgStringV MESSAGE;\
}\
}\
}</pre></div> </td>
</tr>
</table>
<a name="a36" doxytag="pvlogger.h::PVLOGGER_ENABLE"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> #define PVLOGGER_ENABLE&nbsp;&nbsp;&nbsp;1
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
In case logging is compiled out, there is no need to compile the logger runtime code either. </td>
</tr>
</table>
<a name="a5" doxytag="pvlogger.h::PVLOGGER_INST_LEVEL"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> #define PVLOGGER_INST_LEVEL&nbsp;&nbsp;&nbsp;5
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="a10" doxytag="pvlogger.h::PVLOGGER_INST_LEVEL_SUPPORT"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> #define PVLOGGER_INST_LEVEL_SUPPORT&nbsp;&nbsp;&nbsp;1
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="a35" doxytag="pvlogger.h::PVLOGGER_LOG_USE_ONLY"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> #define PVLOGGER_LOG_USE_ONLY</td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">x&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap>&nbsp;&nbsp;&nbsp;x
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Used to compile in/out lines of code that are used only for <a class="el" href="classPVLogger.html">PVLogger</a> macros.
<p>
This code will be removed at compile time when <a class="el" href="classPVLogger.html">PVLogger</a> is disabled, i.e. Release mode. So do not put in any code that is necessary for correct functionality of the module </td>
</tr>
</table>
<a name="a33" doxytag="pvlogger.h::PVLOGGER_LOGBIN"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> #define PVLOGGER_LOGBIN</td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">IL, <tr>
<td></td>
<td></td>
<td class="md" nowrap>LOGGER, <tr>
<td></td>
<td></td>
<td class="md" nowrap>LEVEL, <tr>
<td></td>
<td></td>
<td class="md" nowrap>MESSAGE&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap>&nbsp;&nbsp;&nbsp;PVLOGGER_LOGBIN_ ## IL (LOGGER, LEVEL, MESSAGE)
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
This is a binary API to log messages<dl compact><dt><b>Parameters: </b></dt><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>IL</em>&nbsp;</td><td>
Instrumentation level. </td></tr>
<tr><td valign=top><em>LOGGER</em>&nbsp;</td><td>
Pointer to the logger object, that acts as the logging control/interface point </td></tr>
<tr><td valign=top><em>LEVEL</em>&nbsp;</td><td>
Log level of the message </td></tr>
<tr><td valign=top><em>MESSAGE</em>&nbsp;</td><td>
Log Message which includes the message id, and message buffers that need to be logged.</td></tr>
</table>
</dl>Example Usage: PVLOGGER_LOGBIN (PVLOGMSG_INST_LLDBG, logger_1, PVLOGMSG_WARNING, (10, 3, msgBuf1Size, msgBuf1, msgBuf2Size, msgBuf2, msgBuf3Size, msgBuf3));
<p>
-This message contains THREE (ptr_len, ptr) pairs. Log level of this msg is PVLOGMSG_WARNING, message id is 10. </td>
</tr>
</table>
<a name="a21" doxytag="pvlogger.h::PVLOGGER_LOGBIN_PVLOGMSG_INST_HLDBG"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> #define PVLOGGER_LOGBIN_PVLOGMSG_INST_HLDBG</td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">LOGGER, <tr>
<td></td>
<td></td>
<td class="md" nowrap>LEVEL, <tr>
<td></td>
<td></td>
<td class="md" nowrap>MESSAGE&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap>&nbsp;&nbsp;&nbsp;_PVLOGGER_LOGBIN(LOGGER, LEVEL, MESSAGE)
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="a29" doxytag="pvlogger.h::PVLOGGER_LOGBIN_PVLOGMSG_INST_LLDBG"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> #define PVLOGGER_LOGBIN_PVLOGMSG_INST_LLDBG</td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">LOGGER, <tr>
<td></td>
<td></td>
<td class="md" nowrap>LEVEL, <tr>
<td></td>
<td></td>
<td class="md" nowrap>MESSAGE&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap>&nbsp;&nbsp;&nbsp;_PVLOGGER_LOGBIN(LOGGER, LEVEL, MESSAGE)
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="a25" doxytag="pvlogger.h::PVLOGGER_LOGBIN_PVLOGMSG_INST_MLDBG"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> #define PVLOGGER_LOGBIN_PVLOGMSG_INST_MLDBG</td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">LOGGER, <tr>
<td></td>
<td></td>
<td class="md" nowrap>LEVEL, <tr>
<td></td>
<td></td>
<td class="md" nowrap>MESSAGE&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap>&nbsp;&nbsp;&nbsp;_PVLOGGER_LOGBIN(LOGGER, LEVEL, MESSAGE)
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="a17" doxytag="pvlogger.h::PVLOGGER_LOGBIN_PVLOGMSG_INST_PROF"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> #define PVLOGGER_LOGBIN_PVLOGMSG_INST_PROF</td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">LOGGER, <tr>
<td></td>
<td></td>
<td class="md" nowrap>LEVEL, <tr>
<td></td>
<td></td>
<td class="md" nowrap>MESSAGE&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap>&nbsp;&nbsp;&nbsp;_PVLOGGER_LOGBIN(LOGGER, LEVEL, MESSAGE)
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="a13" doxytag="pvlogger.h::PVLOGGER_LOGBIN_PVLOGMSG_INST_REL"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> #define PVLOGGER_LOGBIN_PVLOGMSG_INST_REL</td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">LOGGER, <tr>
<td></td>
<td></td>
<td class="md" nowrap>LEVEL, <tr>
<td></td>
<td></td>
<td class="md" nowrap>MESSAGE&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap>&nbsp;&nbsp;&nbsp;_PVLOGGER_LOGBIN(LOGGER, LEVEL, MESSAGE)
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="a34" doxytag="pvlogger.h::PVLOGGER_LOGBIN_V"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> #define PVLOGGER_LOGBIN_V</td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">IL, <tr>
<td></td>
<td></td>
<td class="md" nowrap>LOGGER, <tr>
<td></td>
<td></td>
<td class="md" nowrap>LEVEL, <tr>
<td></td>
<td></td>
<td class="md" nowrap>MESSAGE&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap>&nbsp;&nbsp;&nbsp;PVLOGGER_LOGBIN_V_ ## IL (LOGGER, LEVEL, MESSAGE)
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="a22" doxytag="pvlogger.h::PVLOGGER_LOGBIN_V_PVLOGMSG_INST_HLDBG"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> #define PVLOGGER_LOGBIN_V_PVLOGMSG_INST_HLDBG</td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">LOGGER, <tr>
<td></td>
<td></td>
<td class="md" nowrap>LEVEL, <tr>
<td></td>
<td></td>
<td class="md" nowrap>MESSAGE&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap>&nbsp;&nbsp;&nbsp;_PVLOGGER_LOGBIN_V(LOGGER, LEVEL, MESSAGE)
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="a30" doxytag="pvlogger.h::PVLOGGER_LOGBIN_V_PVLOGMSG_INST_LLDBG"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> #define PVLOGGER_LOGBIN_V_PVLOGMSG_INST_LLDBG</td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">LOGGER, <tr>
<td></td>
<td></td>
<td class="md" nowrap>LEVEL, <tr>
<td></td>
<td></td>
<td class="md" nowrap>MESSAGE&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap>&nbsp;&nbsp;&nbsp;_PVLOGGER_LOGBIN_V(LOGGER, LEVEL, MESSAGE)
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="a18" doxytag="pvlogger.h::PVLOGGER_LOGBIN_V_PVLOGMSG_INST_PROF"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> #define PVLOGGER_LOGBIN_V_PVLOGMSG_INST_PROF</td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">LOGGER, <tr>
<td></td>
<td></td>
<td class="md" nowrap>LEVEL, <tr>
<td></td>
<td></td>
<td class="md" nowrap>MESSAGE&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap>&nbsp;&nbsp;&nbsp;_PVLOGGER_LOGBIN_V(LOGGER, LEVEL, MESSAGE)
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="a14" doxytag="pvlogger.h::PVLOGGER_LOGBIN_V_PVLOGMSG_INST_REL"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> #define PVLOGGER_LOGBIN_V_PVLOGMSG_INST_REL</td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">LOGGER, <tr>
<td></td>
<td></td>
<td class="md" nowrap>LEVEL, <tr>
<td></td>
<td></td>
<td class="md" nowrap>MESSAGE&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap>&nbsp;&nbsp;&nbsp;_PVLOGGER_LOGBIN_V(LOGGER, LEVEL, MESSAGE)
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="a26" doxytag="pvlogger.h::PVLOGGER_LOGBIN_V_PVLOGMSG_V_INST_MLDBG"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> #define PVLOGGER_LOGBIN_V_PVLOGMSG_V_INST_MLDBG</td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">LOGGER, <tr>
<td></td>
<td></td>
<td class="md" nowrap>LEVEL, <tr>
<td></td>
<td></td>
<td class="md" nowrap>MESSAGE&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap>&nbsp;&nbsp;&nbsp;_PVLOGGER_LOGBIN_V(LOGGER, LEVEL, MESSAGE)
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="a31" doxytag="pvlogger.h::PVLOGGER_LOGMSG"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> #define PVLOGGER_LOGMSG</td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">IL, <tr>
<td></td>
<td></td>
<td class="md" nowrap>LOGGER, <tr>
<td></td>
<td></td>
<td class="md" nowrap>LEVEL, <tr>
<td></td>
<td></td>
<td class="md" nowrap>MESSAGE&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap>&nbsp;&nbsp;&nbsp;PVLOGGER_LOGMSG_ ## IL (LOGGER, LEVEL, MESSAGE)
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
This is the text based API to log messages<dl compact><dt><b>Parameters: </b></dt><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>IL</em>&nbsp;</td><td>
Instrumentation level. </td></tr>
<tr><td valign=top><em>LOGGER</em>&nbsp;</td><td>
Pointer to the logger object, that acts as the logging control/interface point </td></tr>
<tr><td valign=top><em>LEVEL</em>&nbsp;</td><td>
Log level of the message </td></tr>
<tr><td valign=top><em>MESSAGE</em>&nbsp;</td><td>
Log Message which includes the message id, and any kind of formatting information</td></tr>
</table>
</dl>Example Usage: PVLOGGER_LOGMSG(PVLOGMSG_INST_LLDBG, logger_1, PVLOGMSG_WARNING, (13, "Test Messsage to Node 1<br>
")); -This message of log level PVLOGMSG_WARNING, and has a message id of 13 </td>
</tr>
</table>
<a name="a19" doxytag="pvlogger.h::PVLOGGER_LOGMSG_PVLOGMSG_INST_HLDBG"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> #define PVLOGGER_LOGMSG_PVLOGMSG_INST_HLDBG</td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">LOGGER, <tr>
<td></td>
<td></td>
<td class="md" nowrap>LEVEL, <tr>
<td></td>
<td></td>
<td class="md" nowrap>MESSAGE&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap>&nbsp;&nbsp;&nbsp;_PVLOGGER_LOGMSG(LOGGER, LEVEL, MESSAGE)
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="a27" doxytag="pvlogger.h::PVLOGGER_LOGMSG_PVLOGMSG_INST_LLDBG"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> #define PVLOGGER_LOGMSG_PVLOGMSG_INST_LLDBG</td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">LOGGER, <tr>
<td></td>
<td></td>
<td class="md" nowrap>LEVEL, <tr>
<td></td>
<td></td>
<td class="md" nowrap>MESSAGE&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap>&nbsp;&nbsp;&nbsp;_PVLOGGER_LOGMSG(LOGGER, LEVEL, MESSAGE)
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="a23" doxytag="pvlogger.h::PVLOGGER_LOGMSG_PVLOGMSG_INST_MLDBG"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> #define PVLOGGER_LOGMSG_PVLOGMSG_INST_MLDBG</td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">LOGGER, <tr>
<td></td>
<td></td>
<td class="md" nowrap>LEVEL, <tr>
<td></td>
<td></td>
<td class="md" nowrap>MESSAGE&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap>&nbsp;&nbsp;&nbsp;_PVLOGGER_LOGMSG(LOGGER, LEVEL, MESSAGE)
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="a15" doxytag="pvlogger.h::PVLOGGER_LOGMSG_PVLOGMSG_INST_PROF"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> #define PVLOGGER_LOGMSG_PVLOGMSG_INST_PROF</td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">LOGGER, <tr>
<td></td>
<td></td>
<td class="md" nowrap>LEVEL, <tr>
<td></td>
<td></td>
<td class="md" nowrap>MESSAGE&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap>&nbsp;&nbsp;&nbsp;_PVLOGGER_LOGMSG(LOGGER, LEVEL, MESSAGE)
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="a11" doxytag="pvlogger.h::PVLOGGER_LOGMSG_PVLOGMSG_INST_REL"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> #define PVLOGGER_LOGMSG_PVLOGMSG_INST_REL</td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">LOGGER, <tr>
<td></td>
<td></td>
<td class="md" nowrap>LEVEL, <tr>
<td></td>
<td></td>
<td class="md" nowrap>MESSAGE&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap>&nbsp;&nbsp;&nbsp;_PVLOGGER_LOGMSG(LOGGER, LEVEL, MESSAGE)
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="a32" doxytag="pvlogger.h::PVLOGGER_LOGMSG_V"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> #define PVLOGGER_LOGMSG_V</td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">IL, <tr>
<td></td>
<td></td>
<td class="md" nowrap>LOGGER, <tr>
<td></td>
<td></td>
<td class="md" nowrap>LEVEL, <tr>
<td></td>
<td></td>
<td class="md" nowrap>MESSAGE&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap>&nbsp;&nbsp;&nbsp;PVLOGGER_LOGMSG_V_ ## IL (LOGGER, LEVEL, MESSAGE)
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="a20" doxytag="pvlogger.h::PVLOGGER_LOGMSG_V_PVLOGMSG_INST_HLDBG"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> #define PVLOGGER_LOGMSG_V_PVLOGMSG_INST_HLDBG</td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">LOGGER, <tr>
<td></td>
<td></td>
<td class="md" nowrap>LEVEL, <tr>
<td></td>
<td></td>
<td class="md" nowrap>MESSAGE&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap>&nbsp;&nbsp;&nbsp;_PVLOGGER_LOGMSG_V(LOGGER, LEVEL, MESSAGE)
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="a28" doxytag="pvlogger.h::PVLOGGER_LOGMSG_V_PVLOGMSG_INST_LLDBG"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> #define PVLOGGER_LOGMSG_V_PVLOGMSG_INST_LLDBG</td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">LOGGER, <tr>
<td></td>
<td></td>
<td class="md" nowrap>LEVEL, <tr>
<td></td>
<td></td>
<td class="md" nowrap>MESSAGE&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap>&nbsp;&nbsp;&nbsp;_PVLOGGER_LOGMSG_V(LOGGER, LEVEL, MESSAGE)
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="a24" doxytag="pvlogger.h::PVLOGGER_LOGMSG_V_PVLOGMSG_INST_MLDBG"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> #define PVLOGGER_LOGMSG_V_PVLOGMSG_INST_MLDBG</td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">LOGGER, <tr>
<td></td>
<td></td>
<td class="md" nowrap>LEVEL, <tr>
<td></td>
<td></td>
<td class="md" nowrap>MESSAGE&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap>&nbsp;&nbsp;&nbsp;_PVLOGGER_LOGMSG_V(LOGGER, LEVEL, MESSAGE)
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="a16" doxytag="pvlogger.h::PVLOGGER_LOGMSG_V_PVLOGMSG_INST_PROF"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> #define PVLOGGER_LOGMSG_V_PVLOGMSG_INST_PROF</td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">LOGGER, <tr>
<td></td>
<td></td>
<td class="md" nowrap>LEVEL, <tr>
<td></td>
<td></td>
<td class="md" nowrap>MESSAGE&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap>&nbsp;&nbsp;&nbsp;_PVLOGGER_LOGMSG_V(LOGGER, LEVEL, MESSAGE)
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="a12" doxytag="pvlogger.h::PVLOGGER_LOGMSG_V_PVLOGMSG_INST_REL"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> #define PVLOGGER_LOGMSG_V_PVLOGMSG_INST_REL</td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">LOGGER, <tr>
<td></td>
<td></td>
<td class="md" nowrap>LEVEL, <tr>
<td></td>
<td></td>
<td class="md" nowrap>MESSAGE&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap>&nbsp;&nbsp;&nbsp;_PVLOGGER_LOGMSG_V(LOGGER, LEVEL, MESSAGE)
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="a2" doxytag="pvlogger.h::PVLOGMSG_INST_HLDBG"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> #define PVLOGMSG_INST_HLDBG&nbsp;&nbsp;&nbsp;2
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
High Level Debug Layer
<p>
This layer should contain messages that have very minimal impact on performance, but are at lower level (i.e., provide more information) than would be appropriate in a shipping product. The messages are probably used to gather information and validate proper functionality at a high level as might be appropriate for IOT, stress testing, or QA testing. </td>
</tr>
</table>
<a name="a4" doxytag="pvlogger.h::PVLOGMSG_INST_LLDBG"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> #define PVLOGMSG_INST_LLDBG&nbsp;&nbsp;&nbsp;4
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Low Level Debug Layer
<p>
This layer should contain messages for early functional testing. The messages are typically at a very low-level and allow testing the functionality of individual modules and components. Messages at this layer will typically have a performance impact (sometimes significant) due to the fact that they are at such a low level. </td>
</tr>
</table>
<a name="a3" doxytag="pvlogger.h::PVLOGMSG_INST_MLDBG"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> #define PVLOGMSG_INST_MLDBG&nbsp;&nbsp;&nbsp;3
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Mid Level Debug Layer
<p>
This layer should contain messages that are useful in the middle stages of the development cycle where major components are being integrated. The components themselves should already be well-tested so the emphasis is on interfaces between these components and integration testing. Messages at this layer may have some performance impact. </td>
</tr>
</table>
<a name="a1" doxytag="pvlogger.h::PVLOGMSG_INST_PROF"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> #define PVLOGMSG_INST_PROF&nbsp;&nbsp;&nbsp;1
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Profile Layer
<p>
The profile layer is used for messages and information related to messuring and reporting performance-related information. </td>
</tr>
</table>
<a name="a0" doxytag="pvlogger.h::PVLOGMSG_INST_REL"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> #define PVLOGMSG_INST_REL&nbsp;&nbsp;&nbsp;0
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Release Layer
<p>
The release layer should only be used for messages that should remain in the final release. In certain cases all messaging may be disabled depending on customer requirements. However, when allowed the release layer should contain information that will be useful diagnosing problems in a released product (perhaps after entering a diagnostic mode), but with absolutely minimal performance impact when disabled at runtime. </td>
</tr>
</table>
<hr><h2>Variable Documentation</h2>
<a name="a37" doxytag="pvlogger.h::PVLOGGER_LEVEL_UNINTIALIZED"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> const int32 PVLOGGER_LEVEL_UNINTIALIZED = -1
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="a39" doxytag="pvlogger.h::PVLOGMSG_ALERT"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> const <a class="el" href="classPVLogger.html#s0">PVLogger::log_level_type</a> PVLOGMSG_ALERT = 1
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
action must be taken immediately </td>
</tr>
</table>
<a name="a40" doxytag="pvlogger.h::PVLOGMSG_CRIT"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> const <a class="el" href="classPVLogger.html#s0">PVLogger::log_level_type</a> PVLOGMSG_CRIT = 2
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
critical conditions </td>
</tr>
</table>
<a name="a46" doxytag="pvlogger.h::PVLOGMSG_DEBUG"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> const <a class="el" href="classPVLogger.html#s0">PVLogger::log_level_type</a> PVLOGMSG_DEBUG = 8
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
debug-level messages </td>
</tr>
</table>
<a name="a38" doxytag="pvlogger.h::PVLOGMSG_EMERG"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> const <a class="el" href="classPVLogger.html#s0">PVLogger::log_level_type</a> PVLOGMSG_EMERG = 0
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
system is unusable </td>
</tr>
</table>
<a name="a41" doxytag="pvlogger.h::PVLOGMSG_ERR"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> const <a class="el" href="classPVLogger.html#s0">PVLogger::log_level_type</a> PVLOGMSG_ERR = 3
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
error conditions </td>
</tr>
</table>
<a name="a47" doxytag="pvlogger.h::PVLOGMSG_FATAL_ERROR"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> const <a class="el" href="classPVLogger.html#s0">PVLogger::log_level_type</a> PVLOGMSG_FATAL_ERROR = <a class="el" href="pvlogger_8h.html#a38">PVLOGMSG_EMERG</a>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="a44" doxytag="pvlogger.h::PVLOGMSG_INFO"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> const <a class="el" href="classPVLogger.html#s0">PVLogger::log_level_type</a> PVLOGMSG_INFO = 6
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
informational </td>
</tr>
</table>
<a name="a48" doxytag="pvlogger.h::PVLOGMSG_NONFATAL_ERROR"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> const <a class="el" href="classPVLogger.html#s0">PVLogger::log_level_type</a> PVLOGMSG_NONFATAL_ERROR = <a class="el" href="pvlogger_8h.html#a41">PVLOGMSG_ERR</a>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="a43" doxytag="pvlogger.h::PVLOGMSG_NOTICE"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> const <a class="el" href="classPVLogger.html#s0">PVLogger::log_level_type</a> PVLOGMSG_NOTICE = 5
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
normal but significant condition </td>
</tr>
</table>
<a name="a45" doxytag="pvlogger.h::PVLOGMSG_STACK_TRACE"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> const <a class="el" href="classPVLogger.html#s0">PVLogger::log_level_type</a> PVLOGMSG_STACK_TRACE = 7
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
function enter and exit </td>
</tr>
</table>
<a name="a49" doxytag="pvlogger.h::PVLOGMSG_STATISTIC"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> const <a class="el" href="classPVLogger.html#s0">PVLogger::log_level_type</a> PVLOGMSG_STATISTIC = <a class="el" href="pvlogger_8h.html#a44">PVLOGMSG_INFO</a>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="a50" doxytag="pvlogger.h::PVLOGMSG_VERBOSE"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> const <a class="el" href="classPVLogger.html#s0">PVLogger::log_level_type</a> PVLOGMSG_VERBOSE = <a class="el" href="pvlogger_8h.html#a46">PVLOGMSG_DEBUG</a>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="a42" doxytag="pvlogger.h::PVLOGMSG_WARNING"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> const <a class="el" href="classPVLogger.html#s0">PVLogger::log_level_type</a> PVLOGMSG_WARNING = 4
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
warning conditions </td>
</tr>
</table>
<hr size="1"><img src="pvlogo_small.jpg"><address style="align: right;"><small>OSCL API</small>
<address style="align: left;"><small>Posting Version: OPENCORE_20090310 </small>
</small></address>
</body>
</html>