Current File : //usr/share/doc/net-snmp/html/group__debug.html
<!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"/>
<title>net-snmp: debug</title>

<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />



</head>
<body>
<div id="top"><!-- do not remove this div! -->


<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  
  
  <td style="padding-left: 0.5em;">
   <div id="projectname">net-snmp
   &#160;<span id="projectnumber">5.4.1</span>
   </div>
   
  </td>
  
  
  
 </tr>
 </tbody>
</table>
</div>

<!-- Generated by Doxygen 1.7.6.1 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li><a href="examples.html"><span>Examples</span></a></li>
    </ul>
  </div>
</div>
<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">debug</div>  </div>
<div class="ingroups"><a class="el" href="group__utilities.html">utility_handlers</a></div></div><!--header-->
<div class="contents">

<p>Print out debugging information about the handler chain being called.  
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__handler.html#ga77f4225c0e0c1d549e634f58dba3de3d">netsnmp_mib_handler</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__debug.html#ga80c3e76c83986cbd7155c31b75b2e3ac">netsnmp_get_debug_handler</a> (void)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">returns a debug handler that can be injected into a given handler chain.  <a href="#ga80c3e76c83986cbd7155c31b75b2e3ac"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga10358f14464c59d8cc3a63750620a91c"></a><!-- doxytag: member="debug::debug_print_requests" ref="ga10358f14464c59d8cc3a63750620a91c" args="(netsnmp_request_info *requests)" -->
void&#160;</td><td class="memItemRight" valign="bottom"><b>debug_print_requests</b> (<a class="el" href="structnetsnmp__request__info__s.html">netsnmp_request_info</a> *requests)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga8f739cb947ea9efd8cf09a59ac6ae262"></a><!-- doxytag: member="debug::netsnmp_debug_helper" ref="ga8f739cb947ea9efd8cf09a59ac6ae262" args="(netsnmp_mib_handler *handler, netsnmp_handler_registration *reginfo, netsnmp_agent_request_info *reqinfo, netsnmp_request_info *requests)" -->
int&#160;</td><td class="memItemRight" valign="bottom"><b>netsnmp_debug_helper</b> (<a class="el" href="group__handler.html#ga77f4225c0e0c1d549e634f58dba3de3d">netsnmp_mib_handler</a> *handler, <a class="el" href="group__handler.html#gac475ff73806c2d76ebfc78a87d921b8b">netsnmp_handler_registration</a> *reginfo, <a class="el" href="structnetsnmp__agent__request__info__s.html">netsnmp_agent_request_info</a> *reqinfo, <a class="el" href="structnetsnmp__request__info__s.html">netsnmp_request_info</a> *requests)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__debug.html#gad033abfa995d7a5beff5a20b2f84ff79">netsnmp_init_debug_helper</a> (void)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">initializes the debug helper which then registers a debug handler as a run-time injectable handler for configuration file use.  <a href="#gad033abfa995d7a5beff5a20b2f84ff79"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="member-group"></a>
handler</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__debug.html#gae710ab1626d53847843f1821b298b6ea">netsnmp_init_serialize</a> (void)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">initializes the serialize helper which then registers a serialize handler as a run-time injectable handler for configuration file use.  <a href="#gae710ab1626d53847843f1821b298b6ea"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__debug.html#gac479f08800aaba23977924cbd79cbfce">netsnmp_init_read_only_helper</a> (void)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">initializes the read_only helper which then registers a read_only handler as a run-time injectable handler for configuration file use.  <a href="#gac479f08800aaba23977924cbd79cbfce"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__debug.html#ga132518a145cc899b0c4f785d49b58b41">netsnmp_init_bulk_to_next_helper</a> (void)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">initializes the bulk_to_next helper which then registers a bulk_to_next handler as a run-time injectable handler for configuration file use.  <a href="#ga132518a145cc899b0c4f785d49b58b41"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga95140740535ca78b06513e68cbb00621"></a><!-- doxytag: member="debug::netsnmp_init_table_dataset" ref="ga95140740535ca78b06513e68cbb00621" args="(void)" -->
void&#160;</td><td class="memItemRight" valign="bottom"><b>netsnmp_init_table_dataset</b> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__debug.html#ga1c63c8751fa6b9faa28bddc990d6c42a">netsnmp_init_stash_cache_helper</a> (void)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">initializes the stash_cache helper which then registers a stash_cache handler as a run-time injectable handler for configuration file use.  <a href="#ga1c63c8751fa6b9faa28bddc990d6c42a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__debug.html#gaca84eec8edeb29ec39b9f519bb675b98">netsnmp_init_helpers</a> (void)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">call the initialization sequence for all handlers with init_ routines.  <a href="#gaca84eec8edeb29ec39b9f519bb675b98"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<p>Print out debugging information about the handler chain being called. </p>
<p>This is a useful module for run-time debugging of requests as the pass this handler in a calling chain. All debugging output is done via the standard debugging routines with a token name of "helper:debug", so use the -Dhelper:debug command line flag to see the output when running the snmpd demon. It's not recommended you compile this into a handler chain during compile time, but instead use the "injectHandler" token in the snmpd.conf file (or similar) to add it to the chain later:</p>
<p>injectHandler debug my_module_name</p>
<p>to see an example output, try:</p>
<p>injectHandler debug mibII/system</p>
<p>and then run snmpwalk on the "system" group. </p>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="ga80c3e76c83986cbd7155c31b75b2e3ac"></a><!-- doxytag: member="debug_handler.c::netsnmp_get_debug_handler" ref="ga80c3e76c83986cbd7155c31b75b2e3ac" args="(void)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__handler.html#ga77f4225c0e0c1d549e634f58dba3de3d">netsnmp_mib_handler</a>* <a class="el" href="group__debug.html#ga80c3e76c83986cbd7155c31b75b2e3ac">netsnmp_get_debug_handler</a> </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>returns a debug handler that can be injected into a given handler chain. </p>

<p>Definition at line <a class="el" href="debug__handler_8c_source.html#l00051">51</a> of file <a class="el" href="debug__handler_8c_source.html">debug_handler.c</a>.</p>

</div>
</div>
<a class="anchor" id="ga132518a145cc899b0c4f785d49b58b41"></a><!-- doxytag: member="all_helpers.c::netsnmp_init_bulk_to_next_helper" ref="ga132518a145cc899b0c4f785d49b58b41" args="(void)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="group__bulk__to__next.html#ga132518a145cc899b0c4f785d49b58b41">netsnmp_init_bulk_to_next_helper</a> </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>initializes the bulk_to_next helper which then registers a bulk_to_next handler as a run-time injectable handler for configuration file use. </p>

<p>Definition at line <a class="el" href="bulk__to__next_8c_source.html#l00139">139</a> of file <a class="el" href="bulk__to__next_8c_source.html">bulk_to_next.c</a>.</p>

</div>
</div>
<a class="anchor" id="gad033abfa995d7a5beff5a20b2f84ff79"></a><!-- doxytag: member="debug_handler.c::netsnmp_init_debug_helper" ref="gad033abfa995d7a5beff5a20b2f84ff79" args="(void)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="group__debug.html#gad033abfa995d7a5beff5a20b2f84ff79">netsnmp_init_debug_helper</a> </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>initializes the debug helper which then registers a debug handler as a run-time injectable handler for configuration file use. </p>

<p>Definition at line <a class="el" href="debug__handler_8c_source.html#l00155">155</a> of file <a class="el" href="debug__handler_8c_source.html">debug_handler.c</a>.</p>

</div>
</div>
<a class="anchor" id="gaca84eec8edeb29ec39b9f519bb675b98"></a><!-- doxytag: member="all_helpers.c::netsnmp_init_helpers" ref="gaca84eec8edeb29ec39b9f519bb675b98" args="(void)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="group__debug.html#gaca84eec8edeb29ec39b9f519bb675b98">netsnmp_init_helpers</a> </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>call the initialization sequence for all handlers with init_ routines. </p>

<p>Definition at line <a class="el" href="all__helpers_8c_source.html#l00036">36</a> of file <a class="el" href="all__helpers_8c_source.html">all_helpers.c</a>.</p>

</div>
</div>
<a class="anchor" id="gac479f08800aaba23977924cbd79cbfce"></a><!-- doxytag: member="all_helpers.c::netsnmp_init_read_only_helper" ref="gac479f08800aaba23977924cbd79cbfce" args="(void)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="group__read__only.html#gac479f08800aaba23977924cbd79cbfce">netsnmp_init_read_only_helper</a> </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>initializes the read_only helper which then registers a read_only handler as a run-time injectable handler for configuration file use. </p>

<p>Definition at line <a class="el" href="read__only_8c_source.html#l00081">81</a> of file <a class="el" href="read__only_8c_source.html">read_only.c</a>.</p>

</div>
</div>
<a class="anchor" id="gae710ab1626d53847843f1821b298b6ea"></a><!-- doxytag: member="all_helpers.c::netsnmp_init_serialize" ref="gae710ab1626d53847843f1821b298b6ea" args="(void)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="group__serialize.html#gae710ab1626d53847843f1821b298b6ea">netsnmp_init_serialize</a> </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>initializes the serialize helper which then registers a serialize handler as a run-time injectable handler for configuration file use. </p>

<p>Definition at line <a class="el" href="serialize_8c_source.html#l00093">93</a> of file <a class="el" href="serialize_8c_source.html">serialize.c</a>.</p>

</div>
</div>
<a class="anchor" id="ga1c63c8751fa6b9faa28bddc990d6c42a"></a><!-- doxytag: member="all_helpers.c::netsnmp_init_stash_cache_helper" ref="ga1c63c8751fa6b9faa28bddc990d6c42a" args="(void)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="group__stash__cache.html#ga1c63c8751fa6b9faa28bddc990d6c42a">netsnmp_init_stash_cache_helper</a> </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>initializes the stash_cache helper which then registers a stash_cache handler as a run-time injectable handler for configuration file use. </p>

<p>Definition at line <a class="el" href="stash__cache_8c_source.html#l00233">233</a> of file <a class="el" href="stash__cache_8c_source.html">stash_cache.c</a>.</p>

</div>
</div>
</div><!-- contents -->


<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.7.6.1
</small></address>

</body>
</html>