| Current File : //usr/share/doc/net-snmp/html/group__scalar.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: scalar</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="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">scalar</div> </div>
<div class="ingroups"><a class="el" href="group__leaf.html">leaf_handlers</a></div></div><!--header-->
<div class="contents">
<p>Process scalars easily.
<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> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__scalar.html#ga667f2bdbbc51e546741a97cc81c3ad75">netsnmp_get_scalar_handler</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Creates a scalar handler calling netsnmp_create_handler with a handler name defaulted to "scalar" and access method, netsnmp_scalar_helper_handler. <a href="#ga667f2bdbbc51e546741a97cc81c3ad75"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__scalar.html#ga6704e7c5174af3bd65042b61afeaa02f">netsnmp_register_scalar</a> (<a class="el" href="group__handler.html#gac475ff73806c2d76ebfc78a87d921b8b">netsnmp_handler_registration</a> *reginfo)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">This function registers a scalar helper handler. <a href="#ga6704e7c5174af3bd65042b61afeaa02f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__scalar.html#gadfce062daa63840e2a4c9ba396148aef">netsnmp_register_read_only_scalar</a> (<a class="el" href="group__handler.html#gac475ff73806c2d76ebfc78a87d921b8b">netsnmp_handler_registration</a> *reginfo)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">This function registers a read only scalar helper handler. <a href="#gadfce062daa63840e2a4c9ba396148aef"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gac617d32b753514f2fa617332988ff2ac"></a><!-- doxytag: member="scalar::netsnmp_scalar_helper_handler" ref="gac617d32b753514f2fa617332988ff2ac" args="(netsnmp_mib_handler *handler, netsnmp_handler_registration *reginfo, netsnmp_agent_request_info *reqinfo, netsnmp_request_info *requests)" -->
int </td><td class="memItemRight" valign="bottom"><b>netsnmp_scalar_helper_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>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<p>Process scalars easily. </p>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="ga667f2bdbbc51e546741a97cc81c3ad75"></a><!-- doxytag: member="scalar.c::netsnmp_get_scalar_handler" ref="ga667f2bdbbc51e546741a97cc81c3ad75" 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__scalar.html#ga667f2bdbbc51e546741a97cc81c3ad75">netsnmp_get_scalar_handler</a> </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Creates a scalar handler calling netsnmp_create_handler with a handler name defaulted to "scalar" and access method, netsnmp_scalar_helper_handler. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>Returns a pointer to a netsnmp_mib_handler struct which contains the handler's name and the access method</dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="group__scalar.html#ga667f2bdbbc51e546741a97cc81c3ad75" title="Creates a scalar handler calling netsnmp_create_handler with a handler name defaulted to "scalar" and...">netsnmp_get_scalar_handler</a> </dd>
<dd>
<a class="el" href="group__scalar.html#ga6704e7c5174af3bd65042b61afeaa02f" title="This function registers a scalar helper handler.">netsnmp_register_scalar</a> </dd></dl>
<p>Definition at line <a class="el" href="scalar_8c_source.html#l00046">46</a> of file <a class="el" href="scalar_8c_source.html">scalar.c</a>.</p>
</div>
</div>
<a class="anchor" id="gadfce062daa63840e2a4c9ba396148aef"></a><!-- doxytag: member="scalar.c::netsnmp_register_read_only_scalar" ref="gadfce062daa63840e2a4c9ba396148aef" args="(netsnmp_handler_registration *reginfo)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="group__scalar.html#gadfce062daa63840e2a4c9ba396148aef">netsnmp_register_read_only_scalar</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>This function registers a read only scalar helper handler. </p>
<p>This function is very similar to netsnmp_register_scalar the only addition is that the "read_only" handler is injected into the handler chain prior to injecting the serialize handler and registering reginfo.</p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">reginfo</td><td>a handler registration structure which could get created using netsnmp_create_handler_registration. Used to register a read only scalar helper handler.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>MIB_REGISTERED_OK is returned if the registration was a success. Failures are MIB_REGISTRATION_FAILURE and MIB_DUPLICATE_REGISTRATION.</dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="group__scalar.html#ga6704e7c5174af3bd65042b61afeaa02f" title="This function registers a scalar helper handler.">netsnmp_register_scalar</a> </dd>
<dd>
<a class="el" href="group__scalar.html#ga667f2bdbbc51e546741a97cc81c3ad75" title="Creates a scalar handler calling netsnmp_create_handler with a handler name defaulted to "scalar" and...">netsnmp_get_scalar_handler</a> </dd></dl>
<p>Definition at line <a class="el" href="scalar_8c_source.html#l00109">109</a> of file <a class="el" href="scalar_8c_source.html">scalar.c</a>.</p>
</div>
</div>
<a class="anchor" id="ga6704e7c5174af3bd65042b61afeaa02f"></a><!-- doxytag: member="scalar.c::netsnmp_register_scalar" ref="ga6704e7c5174af3bd65042b61afeaa02f" args="(netsnmp_handler_registration *reginfo)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="group__scalar.html#ga6704e7c5174af3bd65042b61afeaa02f">netsnmp_register_scalar</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>This function registers a scalar helper handler. </p>
<p>The registered OID, reginfo->rootoid, space is extended for the instance subid using realloc() but the reginfo->rootoid_len length is not extended just yet. .This function subsequently injects the instance, scalar, and serialize helper handlers before actually registering reginfo.</p>
<p>Each handler is injected/pushed to the top of the handler chain list and will be processed last in first out, LIFO.</p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">reginfo</td><td>a handler registration structure which could get created using netsnmp_create_handler_registration. Used to register a scalar helper handler.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>MIB_REGISTERED_OK is returned if the registration was a success. Failures are MIB_REGISTRATION_FAILURE and MIB_DUPLICATE_REGISTRATION.</dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="group__scalar.html#gadfce062daa63840e2a4c9ba396148aef" title="This function registers a read only scalar helper handler.">netsnmp_register_read_only_scalar</a> </dd>
<dd>
<a class="el" href="group__scalar.html#ga667f2bdbbc51e546741a97cc81c3ad75" title="Creates a scalar handler calling netsnmp_create_handler with a handler name defaulted to "scalar" and...">netsnmp_get_scalar_handler</a> </dd></dl>
<p>Definition at line <a class="el" href="scalar_8c_source.html#l00074">74</a> of file <a class="el" href="scalar_8c_source.html">scalar.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>