<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> <title>rlog: RLogMacros</title> <link href="doxygen.css" rel="stylesheet" type="text/css"> <link href="tabs.css" rel="stylesheet" type="text/css"> </head><body> <!-- Generated by Doxygen 1.5.0 --> <div class="tabs"> <ul> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="modules.html"><span>Modules</span></a></li> <li><a href="annotated.html"><span>Classes</span></a></li> <li><a href="files.html"><span>Files</span></a></li> <li><a href="pages.html"><span>Related Pages</span></a></li> </ul></div> <h1>RLogMacros</h1><table border="0" cellpadding="0" cellspacing="0"> <tr><td></td></tr> <tr><td colspan="2"><br><h2>Defines</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__RLogMacros.html#ge8be8a2d2e9da76cb70e2f29e0801f73">rDebug</a>(...) _rMessage( LOGID, rlog::_RLDebugChannel, ##__VA_ARGS__ )</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Log a message to the "debug" channel. Takes printf style arguments. <a href="#ge8be8a2d2e9da76cb70e2f29e0801f73"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__RLogMacros.html#gde5451e41b9de65e87bf114a90a38155">rInfo</a>(...) _rMessage( LOGID, rlog::_RLInfoChannel, ##__VA_ARGS__ )</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Log a message to the "debug" channel. Takes printf style arguments. <a href="#gde5451e41b9de65e87bf114a90a38155"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__RLogMacros.html#gd62ee67e7f1de16d4f71b1d8699cfac8">rWarning</a>(...) _rMessage( LOGID, rlog::_RLWarningChannel, ##__VA_ARGS__ )</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Log a message to the "warning" channel. Takes printf style arguments. <a href="#gd62ee67e7f1de16d4f71b1d8699cfac8"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__RLogMacros.html#gc31d5e1de248b22df42a34e58a2b7349">rError</a>(...) _rMessage( LOGID, rlog::_RLErrorChannel, ##__VA_ARGS__ )</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Log a message to the "error" channel. Takes printf style arguments. <a href="#gc31d5e1de248b22df42a34e58a2b7349"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__RLogMacros.html#g95004cecec660f509c3e9af03608aa7d">rLog</a>(channel,...) _rMessage( LOGID, channel, ##__VA_ARGS__ )</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Log a message to a user defined channel. Takes a channel and printf style arguments. <a href="#g95004cecec660f509c3e9af03608aa7d"></a><br></td></tr> </table> <hr><a name="_details"></a><h2>Detailed Description</h2> These macros are the primary interface for logging messages:<ul> <li>rDebug(format, ...)</li><li>rInfo(format, ...)</li><li>rWarning(format, ...)</li><li>rError(format, ...)</li><li>rLog(channel, format, ...)</li><li><a class="el" href="rlog_8h.html#964127b894c48e2d41a5e6bdbcc3455b">rAssert( condition )</a> </li></ul> <hr><h2>Define Documentation</h2> <a class="anchor" name="ge8be8a2d2e9da76cb70e2f29e0801f73"></a><!-- doxytag: member="rlog-c99.h::rDebug" ref="ge8be8a2d2e9da76cb70e2f29e0801f73" args="(...)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define rDebug </td> <td>(</td> <td class="paramtype"> <em>...</em> </td> <td class="paramname"> </td> <td> ) </td> <td width="100%"> _rMessage( LOGID, rlog::_RLDebugChannel, ##__VA_ARGS__ )</td> </tr> </table> </div> <div class="memdoc"> <p> Log a message to the "debug" channel. Takes printf style arguments. <p> Format is ala printf, eg: <div class="fragment"><pre class="fragment"> <a class="code" href="group__RLogMacros.html#ge8be8a2d2e9da76cb70e2f29e0801f73">rDebug</a>(<span class="stringliteral">"I'm sorry %s, I can't do %s"</span>, name, request); </pre></div><p> When using a recent GNU compiler, it should automatically detect format string / argument mismatch just like it would with printf.<p> Note that unless there are subscribers to this message, it will do nothing. </div> </div><p> <a class="anchor" name="gc31d5e1de248b22df42a34e58a2b7349"></a><!-- doxytag: member="rlog-c99.h::rError" ref="gc31d5e1de248b22df42a34e58a2b7349" args="(...)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define rError </td> <td>(</td> <td class="paramtype"> <em>...</em> </td> <td class="paramname"> </td> <td> ) </td> <td width="100%"> _rMessage( LOGID, rlog::_RLErrorChannel, ##__VA_ARGS__ )</td> </tr> </table> </div> <div class="memdoc"> <p> Log a message to the "error" channel. Takes printf style arguments. <p> An error indicates that something has definately gone wrong.<p> Format is ala printf, eg: <div class="fragment"><pre class="fragment"> <a class="code" href="group__RLogMacros.html#gc31d5e1de248b22df42a34e58a2b7349">rError</a>(<span class="stringliteral">"bad input %s, aborting request"</span>, input); </pre></div><p> When using a recent GNU compiler, it should automatically detect format string / argument mismatch just like it would with printf.<p> Note that unless there are subscribers to this message, it will do nothing. </div> </div><p> <a class="anchor" name="gde5451e41b9de65e87bf114a90a38155"></a><!-- doxytag: member="rlog-c99.h::rInfo" ref="gde5451e41b9de65e87bf114a90a38155" args="(...)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define rInfo </td> <td>(</td> <td class="paramtype"> <em>...</em> </td> <td class="paramname"> </td> <td> ) </td> <td width="100%"> _rMessage( LOGID, rlog::_RLInfoChannel, ##__VA_ARGS__ )</td> </tr> </table> </div> <div class="memdoc"> <p> Log a message to the "debug" channel. Takes printf style arguments. <p> Format is ala printf, eg: <div class="fragment"><pre class="fragment"> <a class="code" href="group__RLogMacros.html#gde5451e41b9de65e87bf114a90a38155">rInfo</a>(<span class="stringliteral">"I'm sorry %s, I can't do %s"</span>, name, request); </pre></div><p> When using a recent GNU compiler, it should automatically detect format string / argument mismatch just like it would with printf.<p> Note that unless there are subscribers to this message, it will do nothing. </div> </div><p> <a class="anchor" name="g95004cecec660f509c3e9af03608aa7d"></a><!-- doxytag: member="rlog-c99.h::rLog" ref="g95004cecec660f509c3e9af03608aa7d" args="(channel,...)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define rLog </td> <td>(</td> <td class="paramtype">channel, <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"> <em>...</em> </td> <td class="paramname"> </td> <td> ) </td> <td width="100%"> _rMessage( LOGID, channel, ##__VA_ARGS__ )</td> </tr> </table> </div> <div class="memdoc"> <p> Log a message to a user defined channel. Takes a channel and printf style arguments. <p> An error indicates that something has definately gone wrong.<p> Format is ala printf, eg: <div class="fragment"><pre class="fragment"> <span class="keyword">static</span> RLogChannel * MyChannel = RLOG_CHANNEL( <span class="stringliteral">"debug/mine"</span> ); <a class="code" href="group__RLogMacros.html#g95004cecec660f509c3e9af03608aa7d">rLog</a>(MyChannel, <span class="stringliteral">"happy happy, joy joy"</span>); </pre></div><p> When using a recent GNU compiler, it should automatically detect format string / argument mismatch just like it would with printf.<p> Note that unless there are subscribers to this message, it will do nothing. </div> </div><p> <a class="anchor" name="gd62ee67e7f1de16d4f71b1d8699cfac8"></a><!-- doxytag: member="rlog-c99.h::rWarning" ref="gd62ee67e7f1de16d4f71b1d8699cfac8" args="(...)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define rWarning </td> <td>(</td> <td class="paramtype"> <em>...</em> </td> <td class="paramname"> </td> <td> ) </td> <td width="100%"> _rMessage( LOGID, rlog::_RLWarningChannel, ##__VA_ARGS__ )</td> </tr> </table> </div> <div class="memdoc"> <p> Log a message to the "warning" channel. Takes printf style arguments. <p> Output a warning message - meant to indicate that something doesn't seem right.<p> Format is ala printf, eg: <div class="fragment"><pre class="fragment"> <a class="code" href="group__RLogMacros.html#gd62ee67e7f1de16d4f71b1d8699cfac8">rWarning</a>(<span class="stringliteral">"passed %i, expected %i, continuing"</span>, foo, bar); </pre></div><p> When using a recent GNU compiler, it should automatically detect format string / argument mismatch just like it would with printf.<p> Note that unless there are subscribers to this message, it will do nothing. </div> </div><p> <hr size="1"><address style="align: right;"><small>Generated on Mon Nov 20 22:57:44 2006 for rlog by <a href="http://www.doxygen.org/index.html"> <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.0 </small></address> </body> </html>