| Current File : //usr/share/doc/net-snmp/html/group__handler.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: Net-SNMP Agent handler and extensibility API</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
 <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 Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data 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="#nested-classes">Data Structures</a> |
<a href="#groups">Modules</a> |
<a href="#define-members">Defines</a> |
<a href="#typedef-members">Typedefs</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Net-SNMP Agent handler and extensibility API</div> </div>
<div class="ingroups"><a class="el" href="group__agent.html">The Net-SNMP agent</a></div></div><!--header-->
<div class="contents">
<p>The basic theory goes something like this: In the past, with the original mib module api (which derived from the original CMU SNMP code) the underlying mib modules were passed very little information (only the truly most basic information about a request).
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structnetsnmp__mib__handler__s.html">netsnmp_mib_handler_s</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">the mib handler structure to be registered <a href="structnetsnmp__mib__handler__s.html#details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structnetsnmp__handler__registration__s.html">netsnmp_handler_registration_s</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Root registration info. <a href="structnetsnmp__handler__registration__s.html#details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structnetsnmp__handler__args__s.html">netsnmp_handler_args_s</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structnetsnmp__delegated__cache__s.html">netsnmp_delegated_cache_s</a></td></tr>
<tr><td colspan="2"><h2><a name="groups"></a>
Modules</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__utilities.html">utility_handlers</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><p>Simplify request processing A group of handlers intended to simplify certain aspects of processing a request for a MIB object. </p>
<br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__leaf.html">leaf_handlers</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><p>Process individual leaf objects A group of handlers to implement individual leaf objects and instances (both scalar objects, and individual objects and instances within a table). </p>
<br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__baby__steps.html">baby_steps</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><p>Calls your handler in baby_steps for set processing. </p>
<br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__old__api.html">old_api</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><p>Calls mib module code written in the old style of code. </p>
<br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__stash__cache.html">stash_cache</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><p>Automatically caches data for certain handlers. </p>
<br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__table.html">table</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><p>Helps you implement a table. </p>
<br/></td></tr>
<tr><td colspan="2"><h2><a name="define-members"></a>
Defines</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga164274e46962ce0e69a4ef5a35c3ddf8"></a><!-- doxytag: member="handler::MIB_HANDLER_AUTO_NEXT" ref="ga164274e46962ce0e69a4ef5a35c3ddf8" args="" -->
#define </td><td class="memItemRight" valign="bottom"><b>MIB_HANDLER_AUTO_NEXT</b>   0x00000001</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gac6769b9ef1064bc496da0a10cebeec3b"></a><!-- doxytag: member="handler::MIB_HANDLER_AUTO_NEXT_OVERRIDE_ONCE" ref="gac6769b9ef1064bc496da0a10cebeec3b" args="" -->
#define </td><td class="memItemRight" valign="bottom"><b>MIB_HANDLER_AUTO_NEXT_OVERRIDE_ONCE</b>   0x00000002</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga6f5e150bfd131f036b2add3fc7f7be73"></a><!-- doxytag: member="handler::MIB_HANDLER_INSTANCE" ref="ga6f5e150bfd131f036b2add3fc7f7be73" args="" -->
#define </td><td class="memItemRight" valign="bottom"><b>MIB_HANDLER_INSTANCE</b>   0x00000004</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga2ce7c5e66b8efe7e5a79ef147ff3eea1"></a><!-- doxytag: member="handler::MIB_HANDLER_CUSTOM4" ref="ga2ce7c5e66b8efe7e5a79ef147ff3eea1" args="" -->
#define </td><td class="memItemRight" valign="bottom"><b>MIB_HANDLER_CUSTOM4</b>   0x10000000</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga7592b7402d7184242e132416eaa96b70"></a><!-- doxytag: member="handler::MIB_HANDLER_CUSTOM3" ref="ga7592b7402d7184242e132416eaa96b70" args="" -->
#define </td><td class="memItemRight" valign="bottom"><b>MIB_HANDLER_CUSTOM3</b>   0x20000000</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaf509fadc999e7ebb1f2f6413cbc1f1a1"></a><!-- doxytag: member="handler::MIB_HANDLER_CUSTOM2" ref="gaf509fadc999e7ebb1f2f6413cbc1f1a1" args="" -->
#define </td><td class="memItemRight" valign="bottom"><b>MIB_HANDLER_CUSTOM2</b>   0x40000000</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga88b8effeaf40cbccf66838a0bdaf47d6"></a><!-- doxytag: member="handler::MIB_HANDLER_CUSTOM1" ref="ga88b8effeaf40cbccf66838a0bdaf47d6" args="" -->
#define </td><td class="memItemRight" valign="bottom"><b>MIB_HANDLER_CUSTOM1</b>   0x80000000</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga9f5bef4022d9998d9755959fd7ccf662"></a><!-- doxytag: member="handler::HANDLER_CAN_GETANDGETNEXT" ref="ga9f5bef4022d9998d9755959fd7ccf662" args="" -->
#define </td><td class="memItemRight" valign="bottom"><b>HANDLER_CAN_GETANDGETNEXT</b>   0x01 /* must be able to do both */</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gab40590598eab2ee6ce2bce87a8619ce5"></a><!-- doxytag: member="handler::HANDLER_CAN_SET" ref="gab40590598eab2ee6ce2bce87a8619ce5" args="" -->
#define </td><td class="memItemRight" valign="bottom"><b>HANDLER_CAN_SET</b>   0x02 /* implies create, too */</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga8270faef505ac7cb1d7b75f0cfe8da35"></a><!-- doxytag: member="handler::HANDLER_CAN_GETBULK" ref="ga8270faef505ac7cb1d7b75f0cfe8da35" args="" -->
#define </td><td class="memItemRight" valign="bottom"><b>HANDLER_CAN_GETBULK</b>   0x04</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga975e839a9b896909c16212e62deb3e8f"></a><!-- doxytag: member="handler::HANDLER_CAN_NOT_CREATE" ref="ga975e839a9b896909c16212e62deb3e8f" args="" -->
#define </td><td class="memItemRight" valign="bottom"><b>HANDLER_CAN_NOT_CREATE</b>   0x08 /* auto set if ! CAN_SET */</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gae02917cb1c4f228b7aa511e8fbe8e736"></a><!-- doxytag: member="handler::HANDLER_CAN_BABY_STEP" ref="gae02917cb1c4f228b7aa511e8fbe8e736" args="" -->
#define </td><td class="memItemRight" valign="bottom"><b>HANDLER_CAN_BABY_STEP</b>   0x10</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga0319a7dadb4e95ea1f11c1eb8e8eced7"></a><!-- doxytag: member="handler::HANDLER_CAN_STASH" ref="ga0319a7dadb4e95ea1f11c1eb8e8eced7" args="" -->
#define </td><td class="memItemRight" valign="bottom"><b>HANDLER_CAN_STASH</b>   0x20</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga7ddb8691abb4248a63cfc38f0392c4bc"></a><!-- doxytag: member="handler::HANDLER_CAN_RONLY" ref="ga7ddb8691abb4248a63cfc38f0392c4bc" args="" -->
#define </td><td class="memItemRight" valign="bottom"><b>HANDLER_CAN_RONLY</b>   (HANDLER_CAN_GETANDGETNEXT)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga03c1b4a8a0446dcfb1c8effc432ea91e"></a><!-- doxytag: member="handler::HANDLER_CAN_RWRITE" ref="ga03c1b4a8a0446dcfb1c8effc432ea91e" args="" -->
#define </td><td class="memItemRight" valign="bottom"><b>HANDLER_CAN_RWRITE</b>   (HANDLER_CAN_GETANDGETNEXT | HANDLER_CAN_SET)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga1cdf4e84d36c3d904c9e6f4eb9e9c444"></a><!-- doxytag: member="handler::HANDLER_CAN_SET_ONLY" ref="ga1cdf4e84d36c3d904c9e6f4eb9e9c444" args="" -->
#define </td><td class="memItemRight" valign="bottom"><b>HANDLER_CAN_SET_ONLY</b>   (HANDLER_CAN_SET | HANDLER_CAN_NOT_CREATE)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga28a5329a4d48ce4af25b9876e8343595"></a><!-- doxytag: member="handler::HANDLER_CAN_DEFAULT" ref="ga28a5329a4d48ce4af25b9876e8343595" args="" -->
#define </td><td class="memItemRight" valign="bottom"><b>HANDLER_CAN_DEFAULT</b>   (HANDLER_CAN_RONLY | HANDLER_CAN_NOT_CREATE)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaa6a6bf0ae2b150b658022bf133f928f9"></a><!-- doxytag: member="handler::REQUEST_IS_DELEGATED" ref="gaa6a6bf0ae2b150b658022bf133f928f9" args="" -->
#define </td><td class="memItemRight" valign="bottom"><b>REQUEST_IS_DELEGATED</b>   1</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gad572b091d6840c12089315bda715ffe7"></a><!-- doxytag: member="handler::REQUEST_IS_NOT_DELEGATED" ref="gad572b091d6840c12089315bda715ffe7" args="" -->
#define </td><td class="memItemRight" valign="bottom"><b>REQUEST_IS_NOT_DELEGATED</b>   0</td></tr>
<tr><td colspan="2"><h2><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef struct <br class="typebreak"/>
<a class="el" href="structnetsnmp__mib__handler__s.html">netsnmp_mib_handler_s</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__handler.html#ga77f4225c0e0c1d549e634f58dba3de3d">netsnmp_mib_handler</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Typedefs the <a class="el" href="structnetsnmp__mib__handler__s.html" title="the mib handler structure to be registered">netsnmp_mib_handler_s</a> struct into netsnmp_mib_handler. <a href="#ga77f4225c0e0c1d549e634f58dba3de3d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef struct <br class="typebreak"/>
<a class="el" href="structnetsnmp__handler__registration__s.html">netsnmp_handler_registration_s</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__handler.html#gac475ff73806c2d76ebfc78a87d921b8b">netsnmp_handler_registration</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Typedefs the <a class="el" href="structnetsnmp__handler__registration__s.html" title="Root registration info.">netsnmp_handler_registration_s</a> struct into netsnmp_handler_registration. <a href="#gac475ff73806c2d76ebfc78a87d921b8b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga3869cb145f61a81ad7a835adc3f33bf0"></a><!-- doxytag: member="handler::Netsnmp_Node_Handler" ref="ga3869cb145f61a81ad7a835adc3f33bf0" args=")(netsnmp_mib_handler *handler, netsnmp_handler_registration *reginfo, netsnmp_agent_request_info *reqinfo, netsnmp_request_info *requests)" -->
typedef int( </td><td class="memItemRight" valign="bottom"><b>Netsnmp_Node_Handler</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"><a class="anchor" id="ga5437f5d545d0034d060323fdebfa0b61"></a><!-- doxytag: member="handler::netsnmp_handler_args" ref="ga5437f5d545d0034d060323fdebfa0b61" args="" -->
typedef struct <br class="typebreak"/>
<a class="el" href="structnetsnmp__handler__args__s.html">netsnmp_handler_args_s</a> </td><td class="memItemRight" valign="bottom"><b>netsnmp_handler_args</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga092d18ed86d78b2e24c49a76b30662e9"></a><!-- doxytag: member="handler::netsnmp_delegated_cache" ref="ga092d18ed86d78b2e24c49a76b30662e9" args="" -->
typedef struct <br class="typebreak"/>
<a class="el" href="structnetsnmp__delegated__cache__s.html">netsnmp_delegated_cache_s</a> </td><td class="memItemRight" valign="bottom"><b>netsnmp_delegated_cache</b></td></tr>
<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> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__handler.html#ga169c1653d481ed3d7df0c1795d99ca0c">netsnmp_create_handler</a> (const char *name, Netsnmp_Node_Handler *handler_access_method)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">creates a netsnmp_mib_handler structure given a name and a access method. <a href="#ga169c1653d481ed3d7df0c1795d99ca0c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__handler.html#gac475ff73806c2d76ebfc78a87d921b8b">netsnmp_handler_registration</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__handler.html#ga8eaf73ee8eefb4bd26d0a3e89d8d4740">netsnmp_handler_registration_create</a> (const char *name, <a class="el" href="group__handler.html#ga77f4225c0e0c1d549e634f58dba3de3d">netsnmp_mib_handler</a> *handler, oid *reg_oid, size_t reg_oid_len, int modes)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">creates a handler registration structure given a name, a access_method function, a registration location oid and the modes the handler supports. <a href="#ga8eaf73ee8eefb4bd26d0a3e89d8d4740"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaa739c8b1dbc3f43cb763fff902830dfb"></a><!-- doxytag: member="handler::netsnmp_create_handler_registration" ref="gaa739c8b1dbc3f43cb763fff902830dfb" args="(const char *name, Netsnmp_Node_Handler *handler_access_method, oid *reg_oid, size_t reg_oid_len, int modes)" -->
<a class="el" href="group__handler.html#gac475ff73806c2d76ebfc78a87d921b8b">netsnmp_handler_registration</a> * </td><td class="memItemRight" valign="bottom"><b>netsnmp_create_handler_registration</b> (const char *name, Netsnmp_Node_Handler *handler_access_method, oid *reg_oid, size_t reg_oid_len, int modes)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__handler.html#gacdbdb9d74898a5bf04b0992ea0316aa4">netsnmp_register_handler</a> (<a class="el" href="group__handler.html#gac475ff73806c2d76ebfc78a87d921b8b">netsnmp_handler_registration</a> *reginfo)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">register a handler, as defined by the netsnmp_handler_registration pointer. <a href="#gacdbdb9d74898a5bf04b0992ea0316aa4"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__handler.html#ga62639943d2328300a27a196205fe88de">netsnmp_unregister_handler</a> (<a class="el" href="group__handler.html#gac475ff73806c2d76ebfc78a87d921b8b">netsnmp_handler_registration</a> *reginfo)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">unregister a handler, as defined by the netsnmp_handler_registration pointer. <a href="#ga62639943d2328300a27a196205fe88de"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__handler.html#gab05fc800c46b5bd81125ed623d0d989c">netsnmp_register_handler_nocallback</a> (<a class="el" href="group__handler.html#gac475ff73806c2d76ebfc78a87d921b8b">netsnmp_handler_registration</a> *reginfo)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">register a handler, as defined by the netsnmp_handler_registration pointer. <a href="#gab05fc800c46b5bd81125ed623d0d989c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__handler.html#ga1dea0606678b435440ac3267a9f36f6b">netsnmp_inject_handler_before</a> (<a class="el" href="group__handler.html#gac475ff73806c2d76ebfc78a87d921b8b">netsnmp_handler_registration</a> *reginfo, <a class="el" href="group__handler.html#ga77f4225c0e0c1d549e634f58dba3de3d">netsnmp_mib_handler</a> *handler, const char *before_what)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">inject a new handler into the calling chain of the handlers definedy by the netsnmp_handler_registration pointer. <a href="#ga1dea0606678b435440ac3267a9f36f6b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__handler.html#ga6649d75b3eaf98d70704754d3d8235f3">netsnmp_inject_handler</a> (<a class="el" href="group__handler.html#gac475ff73806c2d76ebfc78a87d921b8b">netsnmp_handler_registration</a> *reginfo, <a class="el" href="group__handler.html#ga77f4225c0e0c1d549e634f58dba3de3d">netsnmp_mib_handler</a> *handler)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">inject a new handler into the calling chain of the handlers definedy by the netsnmp_handler_registration pointer. <a href="#ga6649d75b3eaf98d70704754d3d8235f3"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">NETSNMP_INLINE int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__handler.html#gad9c9c2c88fc86c2838bfab9fd87270cb">netsnmp_call_handler</a> (<a class="el" href="group__handler.html#ga77f4225c0e0c1d549e634f58dba3de3d">netsnmp_mib_handler</a> *next_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="mdescLeft"> </td><td class="mdescRight">calls a handler with with appropriate NULL checking of arguments, etc. <a href="#gad9c9c2c88fc86c2838bfab9fd87270cb"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga719a047016e729ac8c6dad617085ccd7"></a><!-- doxytag: member="handler::netsnmp_call_handlers" ref="ga719a047016e729ac8c6dad617085ccd7" args="(netsnmp_handler_registration *reginfo, netsnmp_agent_request_info *reqinfo, netsnmp_request_info *requests)" -->
int </td><td class="memItemRight" valign="bottom"><b>netsnmp_call_handlers</b> (<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">NETSNMP_INLINE int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__handler.html#gae45d1dbf0999b242f4f45714c7a63c1b">netsnmp_call_next_handler</a> (<a class="el" href="group__handler.html#ga77f4225c0e0c1d549e634f58dba3de3d">netsnmp_mib_handler</a> *current, <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="mdescLeft"> </td><td class="mdescRight">calls the next handler in the chain after the current one with with appropriate NULL checking, etc. <a href="#gae45d1dbf0999b242f4f45714c7a63c1b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">NETSNMP_INLINE int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__handler.html#gaaeff27bbb82fdebde534d9ba2b8a1543">netsnmp_call_next_handler_one_request</a> (<a class="el" href="group__handler.html#ga77f4225c0e0c1d549e634f58dba3de3d">netsnmp_mib_handler</a> *current, <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="mdescLeft"> </td><td class="mdescRight">calls the next handler in the chain after the current one with with appropriate NULL checking, etc. <a href="#gaaeff27bbb82fdebde534d9ba2b8a1543"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__handler.html#gac0eb7f89dee961df2d09084fd7925952">netsnmp_handler_free</a> (<a class="el" href="group__handler.html#ga77f4225c0e0c1d549e634f58dba3de3d">netsnmp_mib_handler</a> *handler)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">free's the resourceses associated with a given handler <a href="#gac0eb7f89dee961df2d09084fd7925952"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__handler.html#ga77f4225c0e0c1d549e634f58dba3de3d">netsnmp_mib_handler</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__handler.html#ga6e129a4e26986e07d1b65f2be6e79a97">netsnmp_handler_dup</a> (<a class="el" href="group__handler.html#ga77f4225c0e0c1d549e634f58dba3de3d">netsnmp_mib_handler</a> *handler)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">dulpicates a handler and all subsequent handlers see also _clone_handler <a href="#ga6e129a4e26986e07d1b65f2be6e79a97"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__handler.html#ga8335082f0d99bb6cf19771ae75725c58">netsnmp_handler_registration_free</a> (<a class="el" href="group__handler.html#gac475ff73806c2d76ebfc78a87d921b8b">netsnmp_handler_registration</a> *reginfo)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">free the resources associated with a handler registration object <a href="#ga8335082f0d99bb6cf19771ae75725c58"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__handler.html#gac475ff73806c2d76ebfc78a87d921b8b">netsnmp_handler_registration</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__handler.html#ga448ff32b31b535f1772012e58744e00f">netsnmp_handler_registration_dup</a> (<a class="el" href="group__handler.html#gac475ff73806c2d76ebfc78a87d921b8b">netsnmp_handler_registration</a> *reginfo)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">duplicates the handler registration object <a href="#ga448ff32b31b535f1772012e58744e00f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">NETSNMP_INLINE <br class="typebreak"/>
<a class="el" href="structnetsnmp__delegated__cache__s.html">netsnmp_delegated_cache</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__handler.html#gac15d1df69792dd4a89ae90325754ff14">netsnmp_create_delegated_cache</a> (<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, void *localinfo)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">creates a cache of information which can be saved for future reference. <a href="#gac15d1df69792dd4a89ae90325754ff14"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">NETSNMP_INLINE <br class="typebreak"/>
<a class="el" href="structnetsnmp__delegated__cache__s.html">netsnmp_delegated_cache</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__handler.html#gaf8e4e4f38f887dde15bd6f1a0dcb2867">netsnmp_handler_check_cache</a> (<a class="el" href="structnetsnmp__delegated__cache__s.html">netsnmp_delegated_cache</a> *dcache)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">check's a given cache and returns it if it is still valid (ie, the agent still considers it to be an outstanding request. <a href="#gaf8e4e4f38f887dde15bd6f1a0dcb2867"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">NETSNMP_INLINE void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__handler.html#ga10a62170050ec4f9daed5947cc5a7c81">netsnmp_free_delegated_cache</a> (<a class="el" href="structnetsnmp__delegated__cache__s.html">netsnmp_delegated_cache</a> *dcache)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">frees a cache once you're finished using it <a href="#ga10a62170050ec4f9daed5947cc5a7c81"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__handler.html#ga4a4542018f162f3929a4bf0d90d3fe76">netsnmp_handler_mark_requests_as_delegated</a> (<a class="el" href="structnetsnmp__request__info__s.html">netsnmp_request_info</a> *requests, int isdelegated)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">marks a list of requests as delegated (or not if isdelegaded = 0) <a href="#ga4a4542018f162f3929a4bf0d90d3fe76"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">NETSNMP_INLINE void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__handler.html#ga4ae3a042dd44f903a42314910aa7e396">netsnmp_request_add_list_data</a> (<a class="el" href="structnetsnmp__request__info__s.html">netsnmp_request_info</a> *request, <a class="el" href="structnetsnmp__data__list__s.html">netsnmp_data_list</a> *<a class="el" href="structnode.html">node</a>)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">add data to a request that can be extracted later by submodules <a href="#ga4ae3a042dd44f903a42314910aa7e396"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">NETSNMP_INLINE int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__handler.html#gaeba0170db8f63826a734d83adba83a49">netsnmp_request_remove_list_data</a> (<a class="el" href="structnetsnmp__request__info__s.html">netsnmp_request_info</a> *request, const char *name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">remove data from a request <a href="#gaeba0170db8f63826a734d83adba83a49"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">NETSNMP_INLINE void * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__handler.html#ga7e710ceaced994ee73e3a2601a4bd7c9">netsnmp_request_get_list_data</a> (<a class="el" href="structnetsnmp__request__info__s.html">netsnmp_request_info</a> *request, const char *name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">extract data from a request that was added previously by a parent module <a href="#ga7e710ceaced994ee73e3a2601a4bd7c9"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">NETSNMP_INLINE void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__handler.html#ga6b049ef6f1346b637b6955fe75de8e8e">netsnmp_free_request_data_set</a> (<a class="el" href="structnetsnmp__request__info__s.html">netsnmp_request_info</a> *request)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Free the extra data stored in a request. <a href="#ga6b049ef6f1346b637b6955fe75de8e8e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">NETSNMP_INLINE void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__handler.html#ga507c06bd7b54b2423e71c2bf740c6816">netsnmp_free_request_data_sets</a> (<a class="el" href="structnetsnmp__request__info__s.html">netsnmp_request_info</a> *request)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Free the extra data stored in a bunch of requests (all data in the chain) <a href="#ga507c06bd7b54b2423e71c2bf740c6816"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__handler.html#ga77f4225c0e0c1d549e634f58dba3de3d">netsnmp_mib_handler</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__handler.html#ga2b0f905c6ac5a8a51ff68623cd2f7327">netsnmp_find_handler_by_name</a> (<a class="el" href="group__handler.html#gac475ff73806c2d76ebfc78a87d921b8b">netsnmp_handler_registration</a> *reginfo, const char *name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a handler from a chain based on the name. <a href="#ga2b0f905c6ac5a8a51ff68623cd2f7327"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__handler.html#ga6b85cb5b40f357ae415c44a1f3e50f5a">netsnmp_find_handler_data_by_name</a> (<a class="el" href="group__handler.html#gac475ff73806c2d76ebfc78a87d921b8b">netsnmp_handler_registration</a> *reginfo, const char *name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a handler's void * pointer from a chain based on the name. <a href="#ga6b85cb5b40f357ae415c44a1f3e50f5a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga7981f39101f01e1ecfa0903cb386e264"></a><!-- doxytag: member="handler::handler_free_callback" ref="ga7981f39101f01e1ecfa0903cb386e264" args="(void *free)" -->
void </td><td class="memItemRight" valign="bottom"><b>handler_free_callback</b> (void *free)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__handler.html#gacbb642ff9ceefcd591d455e0c9295bc5">netsnmp_register_handler_by_name</a> (const char *name, <a class="el" href="group__handler.html#ga77f4225c0e0c1d549e634f58dba3de3d">netsnmp_mib_handler</a> *handler)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">registers a given handler by name so that it can be found easily later. <a href="#gacbb642ff9ceefcd591d455e0c9295bc5"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__handler.html#ga51fb49d72729dac64d3a781a86e397d9">netsnmp_clear_handler_list</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">clears the entire handler-registration list <a href="#ga51fb49d72729dac64d3a781a86e397d9"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga102ac2cf04edce3781d4fd436ae35f4f"></a><!-- doxytag: member="handler::netsnmp_inject_handler_into_subtree" ref="ga102ac2cf04edce3781d4fd436ae35f4f" args="(netsnmp_subtree *tp, const char *name, netsnmp_mib_handler *handler, const char *before_what)" -->
void </td><td class="memItemRight" valign="bottom"><b>netsnmp_inject_handler_into_subtree</b> (<a class="el" href="structnetsnmp__subtree__s.html">netsnmp_subtree</a> *tp, const char *name, <a class="el" href="group__handler.html#ga77f4225c0e0c1d549e634f58dba3de3d">netsnmp_mib_handler</a> *handler, const char *before_what)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga5cc45ef18e44effdb18dc01e0ac5ca32"></a><!-- doxytag: member="handler::parse_injectHandler_conf" ref="ga5cc45ef18e44effdb18dc01e0ac5ca32" args="(const char *token, char *cptr)" -->
void </td><td class="memItemRight" valign="bottom"><b>parse_injectHandler_conf</b> (const char *token, char *cptr)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga754fb60e40eeae69b639176c85c21e33"></a><!-- doxytag: member="handler::netsnmp_init_handler_conf" ref="ga754fb60e40eeae69b639176c85c21e33" args="(void)" -->
void </td><td class="memItemRight" valign="bottom"><b>netsnmp_init_handler_conf</b> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga6fc0f2b801066c8076b0bc6891483cea"></a><!-- doxytag: member="handler::netsnmp_handler_get_parent_data" ref="ga6fc0f2b801066c8076b0bc6891483cea" args="(netsnmp_request_info *, const char *)" -->
void * </td><td class="memItemRight" valign="bottom"><b>netsnmp_handler_get_parent_data</b> (<a class="el" href="structnetsnmp__request__info__s.html">netsnmp_request_info</a> *, const char *)</td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<p>The basic theory goes something like this: In the past, with the original mib module api (which derived from the original CMU SNMP code) the underlying mib modules were passed very little information (only the truly most basic information about a request). </p>
<p>This worked well at the time but in todays world of subagents, device instrumentation, low resource consumption, etc, it just isn't flexible enough. "handlers" are here to fix all that.</p>
<p>With the rewrite of the agent internals for the net-snmp 5.0 release, we introduce a modular calling scheme that allows agent modules to be written in a very flexible manner, and more importantly allows reuse of code in a decent way (and without the memory and speed overheads of OO languages like C++).</p>
<p>Functionally, the notion of what a handler does is the same as the older api: A handler is <a class="el" href="group__handler.html#ga169c1653d481ed3d7df0c1795d99ca0c">created</a> and then <a class="el" href="group__handler.html#gacdbdb9d74898a5bf04b0992ea0316aa4">registered</a> with the main agent at a given OID in the OID tree and gets called any time a request is made that it should respond to. You probably should use one of the convenience helpers instead of doing anything else yourself though:</p>
<p>Most importantly, though, is that the handlers are built on the notion of modularity and reuse. Specifically, rather than do all the really hard work (like parsing table indexes out of an incoming oid request) in each module, the API is designed to make it easy to write "helper" handlers that merely process some aspect of the request before passing it along to the final handler that returns the real answer. Most people will want to make use of the <a class="el" href="group__instance.html">instance</a>, <a class="el" href="group__table.html">table</a>, <a class="el" href="group__table__iterator.html">table_iterator</a>, <a class="el" href="group__table__data.html">table_data</a>, or <a class="el" href="group__table__dataset.html">table_dataset</a> helpers to make their life easier. These "helpers" interpert important aspects of the request and pass them on to you.</p>
<p>For instance, the <a class="el" href="group__table.html">table</a> helper is designed to hand you a list of extracted index values from an incoming request. THe <a class="el" href="group__table__iterator.html">table_iterator</a> helper is built on top of the table helper, and is designed to help you iterate through data stored elsewhere (like in a kernel) that is not in OID lexographical order (ie, don't write your own index/oid sorting routine, use this helper instead). The beauty of the <a class="el" href="group__table__iterator.html">table_iterator helper</a>, as well as the <a class="el" href="group__instance.html">instance</a> helper is that they take care of the complex GETNEXT processing entirely for you and hand you everything you need to merely return the data as if it was a GET request. Much less code and hair pulling. I've pulled all my hair out to help you so that only one of us has to be bald. </p>
<hr/><h2>Typedef Documentation</h2>
<a class="anchor" id="gac475ff73806c2d76ebfc78a87d921b8b"></a><!-- doxytag: member="agent_handler.h::netsnmp_handler_registration" ref="gac475ff73806c2d76ebfc78a87d921b8b" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct <a class="el" href="structnetsnmp__handler__registration__s.html">netsnmp_handler_registration_s</a> <a class="el" href="group__handler.html#gac475ff73806c2d76ebfc78a87d921b8b">netsnmp_handler_registration</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Typedefs the <a class="el" href="structnetsnmp__handler__registration__s.html" title="Root registration info.">netsnmp_handler_registration_s</a> struct into netsnmp_handler_registration. </p>
</div>
</div>
<a class="anchor" id="ga77f4225c0e0c1d549e634f58dba3de3d"></a><!-- doxytag: member="agent_handler.h::netsnmp_mib_handler" ref="ga77f4225c0e0c1d549e634f58dba3de3d" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct <a class="el" href="structnetsnmp__mib__handler__s.html">netsnmp_mib_handler_s</a> <a class="el" href="group__handler.html#ga77f4225c0e0c1d549e634f58dba3de3d">netsnmp_mib_handler</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Typedefs the <a class="el" href="structnetsnmp__mib__handler__s.html" title="the mib handler structure to be registered">netsnmp_mib_handler_s</a> struct into netsnmp_mib_handler. </p>
</div>
</div>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="gad9c9c2c88fc86c2838bfab9fd87270cb"></a><!-- doxytag: member="agent_handler.c::netsnmp_call_handler" ref="gad9c9c2c88fc86c2838bfab9fd87270cb" args="(netsnmp_mib_handler *next_handler, netsnmp_handler_registration *reginfo, netsnmp_agent_request_info *reqinfo, netsnmp_request_info *requests)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="group__handler.html#gad9c9c2c88fc86c2838bfab9fd87270cb">netsnmp_call_handler</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__handler.html#ga77f4225c0e0c1d549e634f58dba3de3d">netsnmp_mib_handler</a> * </td>
<td class="paramname"><em>next_handler</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__handler.html#gac475ff73806c2d76ebfc78a87d921b8b">netsnmp_handler_registration</a> * </td>
<td class="paramname"><em>reginfo</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structnetsnmp__agent__request__info__s.html">netsnmp_agent_request_info</a> * </td>
<td class="paramname"><em>reqinfo</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structnetsnmp__request__info__s.html">netsnmp_request_info</a> * </td>
<td class="paramname"><em>requests</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>calls a handler with with appropriate NULL checking of arguments, etc. </p>
<p>Definition at line <a class="el" href="agent__handler_8c_source.html#l00394">394</a> of file <a class="el" href="agent__handler_8c_source.html">agent_handler.c</a>.</p>
</div>
</div>
<a class="anchor" id="gae45d1dbf0999b242f4f45714c7a63c1b"></a><!-- doxytag: member="agent_handler.c::netsnmp_call_next_handler" ref="gae45d1dbf0999b242f4f45714c7a63c1b" args="(netsnmp_mib_handler *current, netsnmp_handler_registration *reginfo, netsnmp_agent_request_info *reqinfo, netsnmp_request_info *requests)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="group__handler.html#gae45d1dbf0999b242f4f45714c7a63c1b">netsnmp_call_next_handler</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__handler.html#ga77f4225c0e0c1d549e634f58dba3de3d">netsnmp_mib_handler</a> * </td>
<td class="paramname"><em>current</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__handler.html#gac475ff73806c2d76ebfc78a87d921b8b">netsnmp_handler_registration</a> * </td>
<td class="paramname"><em>reginfo</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structnetsnmp__agent__request__info__s.html">netsnmp_agent_request_info</a> * </td>
<td class="paramname"><em>reqinfo</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structnetsnmp__request__info__s.html">netsnmp_request_info</a> * </td>
<td class="paramname"><em>requests</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>calls the next handler in the chain after the current one with with appropriate NULL checking, etc. </p>
<p>Definition at line <a class="el" href="agent__handler_8c_source.html#l00524">524</a> of file <a class="el" href="agent__handler_8c_source.html">agent_handler.c</a>.</p>
</div>
</div>
<a class="anchor" id="gaaeff27bbb82fdebde534d9ba2b8a1543"></a><!-- doxytag: member="agent_handler.c::netsnmp_call_next_handler_one_request" ref="gaaeff27bbb82fdebde534d9ba2b8a1543" args="(netsnmp_mib_handler *current, netsnmp_handler_registration *reginfo, netsnmp_agent_request_info *reqinfo, netsnmp_request_info *requests)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="group__handler.html#gaaeff27bbb82fdebde534d9ba2b8a1543">netsnmp_call_next_handler_one_request</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__handler.html#ga77f4225c0e0c1d549e634f58dba3de3d">netsnmp_mib_handler</a> * </td>
<td class="paramname"><em>current</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__handler.html#gac475ff73806c2d76ebfc78a87d921b8b">netsnmp_handler_registration</a> * </td>
<td class="paramname"><em>reginfo</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structnetsnmp__agent__request__info__s.html">netsnmp_agent_request_info</a> * </td>
<td class="paramname"><em>reqinfo</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structnetsnmp__request__info__s.html">netsnmp_request_info</a> * </td>
<td class="paramname"><em>requests</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>calls the next handler in the chain after the current one with with appropriate NULL checking, etc. </p>
<p>Definition at line <a class="el" href="agent__handler_8c_source.html#l00546">546</a> of file <a class="el" href="agent__handler_8c_source.html">agent_handler.c</a>.</p>
</div>
</div>
<a class="anchor" id="ga51fb49d72729dac64d3a781a86e397d9"></a><!-- doxytag: member="agent_handler.c::netsnmp_clear_handler_list" ref="ga51fb49d72729dac64d3a781a86e397d9" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="group__handler.html#ga51fb49d72729dac64d3a781a86e397d9">netsnmp_clear_handler_list</a> </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>clears the entire handler-registration list </p>
<p>Definition at line <a class="el" href="agent__handler_8c_source.html#l00905">905</a> of file <a class="el" href="agent__handler_8c_source.html">agent_handler.c</a>.</p>
</div>
</div>
<a class="anchor" id="gac15d1df69792dd4a89ae90325754ff14"></a><!-- doxytag: member="agent_handler.c::netsnmp_create_delegated_cache" ref="gac15d1df69792dd4a89ae90325754ff14" args="(netsnmp_mib_handler *handler, netsnmp_handler_registration *reginfo, netsnmp_agent_request_info *reqinfo, netsnmp_request_info *requests, void *localinfo)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">NETSNMP_INLINE <a class="el" href="structnetsnmp__delegated__cache__s.html">netsnmp_delegated_cache</a> * <a class="el" href="group__handler.html#gac15d1df69792dd4a89ae90325754ff14">netsnmp_create_delegated_cache</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__handler.html#ga77f4225c0e0c1d549e634f58dba3de3d">netsnmp_mib_handler</a> * </td>
<td class="paramname"><em>handler</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__handler.html#gac475ff73806c2d76ebfc78a87d921b8b">netsnmp_handler_registration</a> * </td>
<td class="paramname"><em>reginfo</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structnetsnmp__agent__request__info__s.html">netsnmp_agent_request_info</a> * </td>
<td class="paramname"><em>reqinfo</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structnetsnmp__request__info__s.html">netsnmp_request_info</a> * </td>
<td class="paramname"><em>requests</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>localinfo</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>creates a cache of information which can be saved for future reference. </p>
<p>Use <a class="el" href="group__handler.html#gaf8e4e4f38f887dde15bd6f1a0dcb2867" title="check's a given cache and returns it if it is still valid (ie, the agent still considers it to be an ...">netsnmp_handler_check_cache()</a> later to make sure it's still valid before referencing it in the future. </p>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="delayed_instance_8c-example.html#a8">delayed_instance.c</a>.</dd>
</dl>
<p>Definition at line <a class="el" href="agent__handler_8c_source.html#l00696">696</a> of file <a class="el" href="agent__handler_8c_source.html">agent_handler.c</a>.</p>
</div>
</div>
<a class="anchor" id="ga169c1653d481ed3d7df0c1795d99ca0c"></a><!-- doxytag: member="agent_handler.c::netsnmp_create_handler" ref="ga169c1653d481ed3d7df0c1795d99ca0c" args="(const char *name, Netsnmp_Node_Handler *handler_access_method)" -->
<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__handler.html#ga169c1653d481ed3d7df0c1795d99ca0c">netsnmp_create_handler</a> </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Netsnmp_Node_Handler * </td>
<td class="paramname"><em>handler_access_method</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>creates a netsnmp_mib_handler structure given a name and a access method. </p>
<p>The returned handler should then be <a class="el" href="group__handler.html#gacdbdb9d74898a5bf04b0992ea0316aa4">registered.</a></p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td>is the handler name and is copied then assigned to netsnmp_mib_handler->handler_name</td></tr>
<tr><td class="paramname">handler_access_method</td><td>is a function pointer used as the access method for this handler registration instance for whatever required needs.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>a pointer to a populated netsnmp_mib_handler struct to be registered</dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd>netsnmp_create_handler_registration() </dd>
<dd>
<a class="el" href="group__handler.html#gacdbdb9d74898a5bf04b0992ea0316aa4" title="register a handler, as defined by the netsnmp_handler_registration pointer.">netsnmp_register_handler()</a> </dd></dl>
<p>Definition at line <a class="el" href="agent__handler_8c_source.html#l00105">105</a> of file <a class="el" href="agent__handler_8c_source.html">agent_handler.c</a>.</p>
</div>
</div>
<a class="anchor" id="ga2b0f905c6ac5a8a51ff68623cd2f7327"></a><!-- doxytag: member="agent_handler.c::netsnmp_find_handler_by_name" ref="ga2b0f905c6ac5a8a51ff68623cd2f7327" args="(netsnmp_handler_registration *reginfo, const char *name)" -->
<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__handler.html#ga2b0f905c6ac5a8a51ff68623cd2f7327">netsnmp_find_handler_by_name</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__handler.html#gac475ff73806c2d76ebfc78a87d921b8b">netsnmp_handler_registration</a> * </td>
<td class="paramname"><em>reginfo</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>name</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns a handler from a chain based on the name. </p>
<p>Definition at line <a class="el" href="agent__handler_8c_source.html#l00838">838</a> of file <a class="el" href="agent__handler_8c_source.html">agent_handler.c</a>.</p>
</div>
</div>
<a class="anchor" id="ga6b85cb5b40f357ae415c44a1f3e50f5a"></a><!-- doxytag: member="agent_handler.c::netsnmp_find_handler_data_by_name" ref="ga6b85cb5b40f357ae415c44a1f3e50f5a" args="(netsnmp_handler_registration *reginfo, const char *name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void * <a class="el" href="group__handler.html#ga6b85cb5b40f357ae415c44a1f3e50f5a">netsnmp_find_handler_data_by_name</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__handler.html#gac475ff73806c2d76ebfc78a87d921b8b">netsnmp_handler_registration</a> * </td>
<td class="paramname"><em>reginfo</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>name</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns a handler's void * pointer from a chain based on the name. </p>
<p>This probably shouldn't be used by the general public as the void * data may change as a handler evolves. Handlers should really advertise some function for you to use instead. </p>
<p>Definition at line <a class="el" href="agent__handler_8c_source.html#l00855">855</a> of file <a class="el" href="agent__handler_8c_source.html">agent_handler.c</a>.</p>
</div>
</div>
<a class="anchor" id="ga10a62170050ec4f9daed5947cc5a7c81"></a><!-- doxytag: member="agent_handler.c::netsnmp_free_delegated_cache" ref="ga10a62170050ec4f9daed5947cc5a7c81" args="(netsnmp_delegated_cache *dcache)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">NETSNMP_INLINE void <a class="el" href="group__handler.html#ga10a62170050ec4f9daed5947cc5a7c81">netsnmp_free_delegated_cache</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structnetsnmp__delegated__cache__s.html">netsnmp_delegated_cache</a> * </td>
<td class="paramname"><em>dcache</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>frees a cache once you're finished using it </p>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="delayed_instance_8c-example.html#a18">delayed_instance.c</a>.</dd>
</dl>
<p>Definition at line <a class="el" href="agent__handler_8c_source.html#l00734">734</a> of file <a class="el" href="agent__handler_8c_source.html">agent_handler.c</a>.</p>
</div>
</div>
<a class="anchor" id="ga6b049ef6f1346b637b6955fe75de8e8e"></a><!-- doxytag: member="agent_handler.c::netsnmp_free_request_data_set" ref="ga6b049ef6f1346b637b6955fe75de8e8e" args="(netsnmp_request_info *request)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">NETSNMP_INLINE void <a class="el" href="group__handler.html#ga6b049ef6f1346b637b6955fe75de8e8e">netsnmp_free_request_data_set</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structnetsnmp__request__info__s.html">netsnmp_request_info</a> * </td>
<td class="paramname"><em>request</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Free the extra data stored in a request. </p>
<p>Definition at line <a class="el" href="agent__handler_8c_source.html#l00820">820</a> of file <a class="el" href="agent__handler_8c_source.html">agent_handler.c</a>.</p>
</div>
</div>
<a class="anchor" id="ga507c06bd7b54b2423e71c2bf740c6816"></a><!-- doxytag: member="agent_handler.c::netsnmp_free_request_data_sets" ref="ga507c06bd7b54b2423e71c2bf740c6816" args="(netsnmp_request_info *request)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">NETSNMP_INLINE void <a class="el" href="group__handler.html#ga507c06bd7b54b2423e71c2bf740c6816">netsnmp_free_request_data_sets</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structnetsnmp__request__info__s.html">netsnmp_request_info</a> * </td>
<td class="paramname"><em>request</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Free the extra data stored in a bunch of requests (all data in the chain) </p>
<p>Definition at line <a class="el" href="agent__handler_8c_source.html#l00828">828</a> of file <a class="el" href="agent__handler_8c_source.html">agent_handler.c</a>.</p>
</div>
</div>
<a class="anchor" id="gaf8e4e4f38f887dde15bd6f1a0dcb2867"></a><!-- doxytag: member="agent_handler.c::netsnmp_handler_check_cache" ref="gaf8e4e4f38f887dde15bd6f1a0dcb2867" args="(netsnmp_delegated_cache *dcache)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">NETSNMP_INLINE <a class="el" href="structnetsnmp__delegated__cache__s.html">netsnmp_delegated_cache</a> * <a class="el" href="group__handler.html#gaf8e4e4f38f887dde15bd6f1a0dcb2867">netsnmp_handler_check_cache</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structnetsnmp__delegated__cache__s.html">netsnmp_delegated_cache</a> * </td>
<td class="paramname"><em>dcache</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>check's a given cache and returns it if it is still valid (ie, the agent still considers it to be an outstanding request. </p>
<p>Returns NULL if it's no longer valid. </p>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="delayed_instance_8c-example.html#a10">delayed_instance.c</a>.</dd>
</dl>
<p>Definition at line <a class="el" href="agent__handler_8c_source.html#l00720">720</a> of file <a class="el" href="agent__handler_8c_source.html">agent_handler.c</a>.</p>
</div>
</div>
<a class="anchor" id="ga6e129a4e26986e07d1b65f2be6e79a97"></a><!-- doxytag: member="agent_handler.c::netsnmp_handler_dup" ref="ga6e129a4e26986e07d1b65f2be6e79a97" args="(netsnmp_mib_handler *handler)" -->
<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__handler.html#ga6e129a4e26986e07d1b65f2be6e79a97">netsnmp_handler_dup</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__handler.html#ga77f4225c0e0c1d549e634f58dba3de3d">netsnmp_mib_handler</a> * </td>
<td class="paramname"><em>handler</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>dulpicates a handler and all subsequent handlers see also _clone_handler </p>
<p>Definition at line <a class="el" href="agent__handler_8c_source.html#l00591">591</a> of file <a class="el" href="agent__handler_8c_source.html">agent_handler.c</a>.</p>
</div>
</div>
<a class="anchor" id="gac0eb7f89dee961df2d09084fd7925952"></a><!-- doxytag: member="agent_handler.c::netsnmp_handler_free" ref="gac0eb7f89dee961df2d09084fd7925952" args="(netsnmp_mib_handler *handler)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="group__handler.html#gac0eb7f89dee961df2d09084fd7925952">netsnmp_handler_free</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__handler.html#ga77f4225c0e0c1d549e634f58dba3de3d">netsnmp_mib_handler</a> * </td>
<td class="paramname"><em>handler</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>free's the resourceses associated with a given handler </p>
<p>make sure we aren't pointing to ourselves.</p>
<p>XXX : segv here at shutdown if SHUTDOWN_AGENT_CLEANLY defined. About 30 functions down the stack, starting in clear_context() -> clear_subtree()</p>
<p>Definition at line <a class="el" href="agent__handler_8c_source.html#l00569">569</a> of file <a class="el" href="agent__handler_8c_source.html">agent_handler.c</a>.</p>
</div>
</div>
<a class="anchor" id="ga4a4542018f162f3929a4bf0d90d3fe76"></a><!-- doxytag: member="agent_handler.c::netsnmp_handler_mark_requests_as_delegated" ref="ga4a4542018f162f3929a4bf0d90d3fe76" args="(netsnmp_request_info *requests, int isdelegated)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="group__handler.html#ga4a4542018f162f3929a4bf0d90d3fe76">netsnmp_handler_mark_requests_as_delegated</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structnetsnmp__request__info__s.html">netsnmp_request_info</a> * </td>
<td class="paramname"><em>requests</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>isdelegated</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>marks a list of requests as delegated (or not if isdelegaded = 0) </p>
<p>Definition at line <a class="el" href="agent__handler_8c_source.html#l00748">748</a> of file <a class="el" href="agent__handler_8c_source.html">agent_handler.c</a>.</p>
</div>
</div>
<a class="anchor" id="ga8eaf73ee8eefb4bd26d0a3e89d8d4740"></a><!-- doxytag: member="agent_handler.c::netsnmp_handler_registration_create" ref="ga8eaf73ee8eefb4bd26d0a3e89d8d4740" args="(const char *name, netsnmp_mib_handler *handler, oid *reg_oid, size_t reg_oid_len, int modes)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__handler.html#gac475ff73806c2d76ebfc78a87d921b8b">netsnmp_handler_registration</a> * <a class="el" href="group__handler.html#ga8eaf73ee8eefb4bd26d0a3e89d8d4740">netsnmp_handler_registration_create</a> </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__handler.html#ga77f4225c0e0c1d549e634f58dba3de3d">netsnmp_mib_handler</a> * </td>
<td class="paramname"><em>handler</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">oid * </td>
<td class="paramname"><em>reg_oid</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>reg_oid_len</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>modes</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>creates a handler registration structure given a name, a access_method function, a registration location oid and the modes the handler supports. </p>
<p>If modes == 0, then modes will automatically be set to the default value of only HANDLER_CAN_DEFAULT, which is by default read-only GET and GETNEXT requests. A hander which supports sets but not row creation should set us a mode of HANDLER_CAN_SET_ONLY. </p>
<dl class="note"><dt><b>Note:</b></dt><dd>This ends up calling netsnmp_create_handler(name, handler_access_method) </dd></dl>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td>is the handler name and is copied then assigned to netsnmp_handler_registration->handlerName.</td></tr>
<tr><td class="paramname">handler</td><td>is a function pointer used as the access method for this handler registration instance for whatever required needs.</td></tr>
<tr><td class="paramname">reg_oid</td><td>is the registration location oid.</td></tr>
<tr><td class="paramname">reg_oid_len</td><td>is the length of reg_oid, can use the macro, OID_LENGTH</td></tr>
<tr><td class="paramname">modes</td><td>is used to configure read/write access. If modes == 0, then modes will automatically be set to the default value of only HANDLER_CAN_DEFAULT, which is by default read-only GET and GETNEXT requests. The other two mode options are read only, HANDLER_CAN_RONLY, and read/write, HANDLER_CAN_RWRITE.</td></tr>
</table>
</dd>
</dl>
<ul>
<li>HANDLER_CAN_GETANDGETNEXT</li>
<li>HANDLER_CAN_SET</li>
<li>HANDLER_CAN_GETBULK</li>
</ul>
<ul>
<li>HANDLER_CAN_RONLY (HANDLER_CAN_GETANDGETNEXT)</li>
<li>HANDLER_CAN_RWRITE (HANDLER_CAN_GETANDGETNEXT | HANDLER_CAN_SET)</li>
<li>HANDLER_CAN_DEFAULT HANDLER_CAN_RONLY</li>
</ul>
<dl class="return"><dt><b>Returns:</b></dt><dd>Returns a pointer to a netsnmp_handler_registration struct. NULL is returned only when memory could not be allocated for the netsnmp_handler_registration struct.</dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="group__handler.html#ga169c1653d481ed3d7df0c1795d99ca0c" title="creates a netsnmp_mib_handler structure given a name and a access method.">netsnmp_create_handler()</a> </dd>
<dd>
<a class="el" href="group__handler.html#gacdbdb9d74898a5bf04b0992ea0316aa4" title="register a handler, as defined by the netsnmp_handler_registration pointer.">netsnmp_register_handler()</a> </dd></dl>
<p>Definition at line <a class="el" href="agent__handler_8c_source.html#l00163">163</a> of file <a class="el" href="agent__handler_8c_source.html">agent_handler.c</a>.</p>
</div>
</div>
<a class="anchor" id="ga448ff32b31b535f1772012e58744e00f"></a><!-- doxytag: member="agent_handler.c::netsnmp_handler_registration_dup" ref="ga448ff32b31b535f1772012e58744e00f" args="(netsnmp_handler_registration *reginfo)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__handler.html#gac475ff73806c2d76ebfc78a87d921b8b">netsnmp_handler_registration</a> * <a class="el" href="group__handler.html#ga448ff32b31b535f1772012e58744e00f">netsnmp_handler_registration_dup</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__handler.html#gac475ff73806c2d76ebfc78a87d921b8b">netsnmp_handler_registration</a> * </td>
<td class="paramname"><em>reginfo</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>duplicates the handler registration object </p>
<p>Definition at line <a class="el" href="agent__handler_8c_source.html#l00634">634</a> of file <a class="el" href="agent__handler_8c_source.html">agent_handler.c</a>.</p>
</div>
</div>
<a class="anchor" id="ga8335082f0d99bb6cf19771ae75725c58"></a><!-- doxytag: member="agent_handler.c::netsnmp_handler_registration_free" ref="ga8335082f0d99bb6cf19771ae75725c58" args="(netsnmp_handler_registration *reginfo)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="group__handler.html#ga8335082f0d99bb6cf19771ae75725c58">netsnmp_handler_registration_free</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__handler.html#gac475ff73806c2d76ebfc78a87d921b8b">netsnmp_handler_registration</a> * </td>
<td class="paramname"><em>reginfo</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>free the resources associated with a handler registration object </p>
<p>Definition at line <a class="el" href="agent__handler_8c_source.html#l00620">620</a> of file <a class="el" href="agent__handler_8c_source.html">agent_handler.c</a>.</p>
</div>
</div>
<a class="anchor" id="ga6649d75b3eaf98d70704754d3d8235f3"></a><!-- doxytag: member="agent_handler.c::netsnmp_inject_handler" ref="ga6649d75b3eaf98d70704754d3d8235f3" args="(netsnmp_handler_registration *reginfo, netsnmp_mib_handler *handler)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="group__handler.html#ga6649d75b3eaf98d70704754d3d8235f3">netsnmp_inject_handler</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__handler.html#gac475ff73806c2d76ebfc78a87d921b8b">netsnmp_handler_registration</a> * </td>
<td class="paramname"><em>reginfo</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__handler.html#ga77f4225c0e0c1d549e634f58dba3de3d">netsnmp_mib_handler</a> * </td>
<td class="paramname"><em>handler</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>inject a new handler into the calling chain of the handlers definedy by the netsnmp_handler_registration pointer. </p>
<p>The new handler is injected at the top of the list and hence will be the new handler to be called first. </p>
<p>Definition at line <a class="el" href="agent__handler_8c_source.html#l00386">386</a> of file <a class="el" href="agent__handler_8c_source.html">agent_handler.c</a>.</p>
</div>
</div>
<a class="anchor" id="ga1dea0606678b435440ac3267a9f36f6b"></a><!-- doxytag: member="agent_handler.c::netsnmp_inject_handler_before" ref="ga1dea0606678b435440ac3267a9f36f6b" args="(netsnmp_handler_registration *reginfo, netsnmp_mib_handler *handler, const char *before_what)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="group__handler.html#ga1dea0606678b435440ac3267a9f36f6b">netsnmp_inject_handler_before</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__handler.html#gac475ff73806c2d76ebfc78a87d921b8b">netsnmp_handler_registration</a> * </td>
<td class="paramname"><em>reginfo</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__handler.html#ga77f4225c0e0c1d549e634f58dba3de3d">netsnmp_mib_handler</a> * </td>
<td class="paramname"><em>handler</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>before_what</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>inject a new handler into the calling chain of the handlers definedy by the netsnmp_handler_registration pointer. </p>
<p>The new handler is injected after the before_what handler, or if NULL at the top of the list and hence will be the new handler to be called first. </p>
<p>Definition at line <a class="el" href="agent__handler_8c_source.html#l00329">329</a> of file <a class="el" href="agent__handler_8c_source.html">agent_handler.c</a>.</p>
</div>
</div>
<a class="anchor" id="gacdbdb9d74898a5bf04b0992ea0316aa4"></a><!-- doxytag: member="agent_handler.c::netsnmp_register_handler" ref="gacdbdb9d74898a5bf04b0992ea0316aa4" args="(netsnmp_handler_registration *reginfo)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="group__handler.html#gacdbdb9d74898a5bf04b0992ea0316aa4">netsnmp_register_handler</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__handler.html#gac475ff73806c2d76ebfc78a87d921b8b">netsnmp_handler_registration</a> * </td>
<td class="paramname"><em>reginfo</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>register a handler, as defined by the netsnmp_handler_registration pointer. </p>
<p>Definition at line <a class="el" href="agent__handler_8c_source.html#l00202">202</a> of file <a class="el" href="agent__handler_8c_source.html">agent_handler.c</a>.</p>
</div>
</div>
<a class="anchor" id="gacbb642ff9ceefcd591d455e0c9295bc5"></a><!-- doxytag: member="agent_handler.c::netsnmp_register_handler_by_name" ref="gacbb642ff9ceefcd591d455e0c9295bc5" args="(const char *name, netsnmp_mib_handler *handler)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="group__handler.html#gacbb642ff9ceefcd591d455e0c9295bc5">netsnmp_register_handler_by_name</a> </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__handler.html#ga77f4225c0e0c1d549e634f58dba3de3d">netsnmp_mib_handler</a> * </td>
<td class="paramname"><em>handler</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>registers a given handler by name so that it can be found easily later. </p>
<p>Definition at line <a class="el" href="agent__handler_8c_source.html#l00893">893</a> of file <a class="el" href="agent__handler_8c_source.html">agent_handler.c</a>.</p>
</div>
</div>
<a class="anchor" id="gab05fc800c46b5bd81125ed623d0d989c"></a><!-- doxytag: member="agent_handler.c::netsnmp_register_handler_nocallback" ref="gab05fc800c46b5bd81125ed623d0d989c" args="(netsnmp_handler_registration *reginfo)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="group__handler.html#gab05fc800c46b5bd81125ed623d0d989c">netsnmp_register_handler_nocallback</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__handler.html#gac475ff73806c2d76ebfc78a87d921b8b">netsnmp_handler_registration</a> * </td>
<td class="paramname"><em>reginfo</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>register a handler, as defined by the netsnmp_handler_registration pointer. </p>
<p>Definition at line <a class="el" href="agent__handler_8c_source.html#l00277">277</a> of file <a class="el" href="agent__handler_8c_source.html">agent_handler.c</a>.</p>
</div>
</div>
<a class="anchor" id="ga4ae3a042dd44f903a42314910aa7e396"></a><!-- doxytag: member="agent_handler.c::netsnmp_request_add_list_data" ref="ga4ae3a042dd44f903a42314910aa7e396" args="(netsnmp_request_info *request, netsnmp_data_list *node)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">NETSNMP_INLINE void <a class="el" href="group__handler.html#ga4ae3a042dd44f903a42314910aa7e396">netsnmp_request_add_list_data</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structnetsnmp__request__info__s.html">netsnmp_request_info</a> * </td>
<td class="paramname"><em>request</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structnetsnmp__data__list__s.html">netsnmp_data_list</a> * </td>
<td class="paramname"><em>node</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>add data to a request that can be extracted later by submodules </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">request</td><td>the netsnmp request info structure</td></tr>
<tr><td class="paramname">node</td><td>this is the data to be added to the linked list request->parent_data</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>void </dd></dl>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="delayed_instance_8c-example.html#a20">delayed_instance.c</a>.</dd>
</dl>
<p>Definition at line <a class="el" href="agent__handler_8c_source.html#l00768">768</a> of file <a class="el" href="agent__handler_8c_source.html">agent_handler.c</a>.</p>
</div>
</div>
<a class="anchor" id="ga7e710ceaced994ee73e3a2601a4bd7c9"></a><!-- doxytag: member="agent_handler.c::netsnmp_request_get_list_data" ref="ga7e710ceaced994ee73e3a2601a4bd7c9" args="(netsnmp_request_info *request, const char *name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">NETSNMP_INLINE void * <a class="el" href="group__handler.html#ga7e710ceaced994ee73e3a2601a4bd7c9">netsnmp_request_get_list_data</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structnetsnmp__request__info__s.html">netsnmp_request_info</a> * </td>
<td class="paramname"><em>request</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>name</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>extract data from a request that was added previously by a parent module </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">request</td><td>the netsnmp request info function</td></tr>
<tr><td class="paramname">name</td><td>used to compare against the request->parent_data->name value, if a match is found request->parent_data->data is returned</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>a void pointer(request->parent_data->data), otherwise NULL is returned if request is NULL or request->parent_data is NULL or request->parent_data object is not found. </dd></dl>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="delayed_instance_8c-example.html#a24">delayed_instance.c</a>.</dd>
</dl>
<p>Definition at line <a class="el" href="agent__handler_8c_source.html#l00810">810</a> of file <a class="el" href="agent__handler_8c_source.html">agent_handler.c</a>.</p>
</div>
</div>
<a class="anchor" id="gaeba0170db8f63826a734d83adba83a49"></a><!-- doxytag: member="agent_handler.c::netsnmp_request_remove_list_data" ref="gaeba0170db8f63826a734d83adba83a49" args="(netsnmp_request_info *request, const char *name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">NETSNMP_INLINE int <a class="el" href="group__handler.html#gaeba0170db8f63826a734d83adba83a49">netsnmp_request_remove_list_data</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structnetsnmp__request__info__s.html">netsnmp_request_info</a> * </td>
<td class="paramname"><em>request</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>name</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>remove data from a request </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">request</td><td>the netsnmp request info structure</td></tr>
<tr><td class="paramname">name</td><td>this is the name of the previously added data</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 on successful find-and-delete, 1 otherwise. </dd></dl>
<p>Definition at line <a class="el" href="agent__handler_8c_source.html#l00789">789</a> of file <a class="el" href="agent__handler_8c_source.html">agent_handler.c</a>.</p>
</div>
</div>
<a class="anchor" id="ga62639943d2328300a27a196205fe88de"></a><!-- doxytag: member="agent_handler.c::netsnmp_unregister_handler" ref="ga62639943d2328300a27a196205fe88de" args="(netsnmp_handler_registration *reginfo)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="group__handler.html#ga62639943d2328300a27a196205fe88de">netsnmp_unregister_handler</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__handler.html#gac475ff73806c2d76ebfc78a87d921b8b">netsnmp_handler_registration</a> * </td>
<td class="paramname"><em>reginfo</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>unregister a handler, as defined by the netsnmp_handler_registration pointer. </p>
<p>Definition at line <a class="el" href="agent__handler_8c_source.html#l00267">267</a> of file <a class="el" href="agent__handler_8c_source.html">agent_handler.c</a>.</p>
</div>
</div>
</div><!-- contents -->
<hr class="footer"/><address class="footer"><small>
Generated by  <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>