<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <title>Crypto++: Tracer Class Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <link href="doxygen.css" rel="stylesheet" type="text/css"/> </head> <body> <!-- Generated by Doxygen 1.7.3 --> <div id="top"> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td style="padding-left: 0.5em;"> <div id="projectname">Crypto++</div> </td> </tr> </tbody> </table> </div> <div id="navrow1" class="tabs"> <ul class="tablist"> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="namespaces.html"><span>Namespaces</span></a></li> <li class="current"><a href="annotated.html"><span>Classes</span></a></li> <li><a href="files.html"><span>Files</span></a></li> </ul> </div> <div id="navrow2" class="tabs2"> <ul class="tablist"> <li><a href="annotated.html"><span>Class List</span></a></li> <li><a href="classes.html"><span>Class Index</span></a></li> <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Class Members</span></a></li> </ul> </div> </div> <div class="header"> <div class="summary"> <a href="#pub-methods">Public Member Functions</a> | <a href="#pro-methods">Protected Member Functions</a> | <a href="#pro-attribs">Protected Attributes</a> </div> <div class="headertitle"> <h1>Tracer Class Reference</h1> </div> </div> <div class="contents"> <!-- doxytag: class="Tracer" --><div class="dynheader"> Inheritance diagram for Tracer:</div> <div class="dyncontent"> <div class="center"> <img src="class_tracer.png" usemap="#Tracer_map" alt=""/> <map id="Tracer_map" name="Tracer_map"> <area href="class_wait_objects_tracer.html" alt="WaitObjectsTracer" shape="rect" coords="0,56,117,80"/> </map> </div></div> <p><a href="class_tracer-members.html">List of all members.</a></p> <table class="memberdecls"> <tr><td colspan="2"><h2><a name="pub-methods"></a> Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a07a52099be1d105b1cac45c65e5c9d43"></a><!-- doxytag: member="Tracer::Tracer" ref="a07a52099be1d105b1cac45c65e5c9d43" args="(unsigned int level)" -->  </td><td class="memItemRight" valign="bottom"><b>Tracer</b> (unsigned int level)</td></tr> <tr><td colspan="2"><h2><a name="pro-methods"></a> Protected Member Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a577e1a605659cb8e5bfaf8e6f6210920"></a><!-- doxytag: member="Tracer::Trace" ref="a577e1a605659cb8e5bfaf8e6f6210920" args="(unsigned int n, std::string const &s)=0" --> virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tracer.html#a577e1a605659cb8e5bfaf8e6f6210920">Trace</a> (unsigned int n, std::string const &s)=0</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Override this in your most-derived tracer to do the actual tracing. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tracer.html#ab7dae4ba53ba558f539cf9557eefe674">UsingDefaults</a> () const </td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8be0f7b5bcdf614e8da200ad3432bb8a"></a><!-- doxytag: member="Tracer::TraceIf" ref="a8be0f7b5bcdf614e8da200ad3432bb8a" args="(unsigned int n, std::string const &s)" --> void </td><td class="memItemRight" valign="bottom"><b>TraceIf</b> (unsigned int n, std::string const &s)</td></tr> <tr><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tracer.html#a16231a01310048495bcd1bd9a52ccd84">Tracing</a> (unsigned int nr, unsigned int minLevel) const </td></tr> <tr><td colspan="2"><h2><a name="pro-attribs"></a> Protected Attributes</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3d8de9648adbedb2224fd6d44a8171fa"></a><!-- doxytag: member="Tracer::m_level" ref="a3d8de9648adbedb2224fd6d44a8171fa" args="" --> unsigned int </td><td class="memItemRight" valign="bottom"><b>m_level</b></td></tr> </table> <hr/><a name="_details"></a><h2>Detailed Description</h2> <div class="textblock"> <p>Definition at line <a class="el" href="wait_8h_source.html#l00022">22</a> of file <a class="el" href="wait_8h_source.html">wait.h</a>.</p> </div><hr/><h2>Member Function Documentation</h2> <a class="anchor" id="ab7dae4ba53ba558f539cf9557eefe674"></a><!-- doxytag: member="Tracer::UsingDefaults" ref="ab7dae4ba53ba558f539cf9557eefe674" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual bool Tracer::UsingDefaults </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const<code> [inline, protected, virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p>By default, tracers will decide which trace messages to trace according to a trace level mechanism. If your most-derived tracer uses a different mechanism, override this to return false. If this method returns false, the default TraceXxxx(void) methods will all return 0 and must be overridden explicitly by your tracer for trace messages you want. </p> <p>Definition at line <a class="el" href="wait_8h_source.html#l00036">36</a> of file <a class="el" href="wait_8h_source.html">wait.h</a>.</p> </div> </div> <a class="anchor" id="a16231a01310048495bcd1bd9a52ccd84"></a><!-- doxytag: member="Tracer::Tracing" ref="a16231a01310048495bcd1bd9a52ccd84" args="(unsigned int nr, unsigned int minLevel) const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">unsigned int Tracer::Tracing </td> <td>(</td> <td class="paramtype">unsigned int </td> <td class="paramname"><em>nr</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">unsigned int </td> <td class="paramname"><em>minLevel</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td> const<code> [inline, protected]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Returns nr if, according to the default log settings mechanism (using log levels), the message should be traced. Returns 0 if the default trace level mechanism is not in use, or if it is in use but the event should not be traced. Provided as a utility method for easier and shorter coding of default TraceXxxx(void) implementations. </p> <p>Definition at line <a class="el" href="wait_8h_source.html#l00048">48</a> of file <a class="el" href="wait_8h_source.html">wait.h</a>.</p> </div> </div> <hr/>The documentation for this class was generated from the following file:<ul> <li><a class="el" href="wait_8h_source.html">wait.h</a></li> </ul> </div> <hr class="footer"/><address class="footer"><small>Generated on Tue Feb 8 2011 for Crypto++ by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </small></address> </body> </html>