Current File : //usr/share/doc/net-snmp/html/instance_8h_source.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: instance.h Source File</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 class="current"><a href="files.html"><span>Files</span></a></li>
      <li><a href="examples.html"><span>Examples</span></a></li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="globals.html"><span>Globals</span></a></li>
    </ul>
  </div>
</div>
<div class="header">
  <div class="headertitle">
<div class="title">instance.h</div>  </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
<a name="l00002"></a>00002 <span class="comment"> * testhandler.h </span>
<a name="l00003"></a>00003 <span class="comment"> */</span>
<a name="l00004"></a>00004 <span class="preprocessor">#ifndef NETSNMP_INSTANCE_H</span>
<a name="l00005"></a>00005 <span class="preprocessor"></span><span class="preprocessor">#define NETSNMP_INSTANCE_H</span>
<a name="l00006"></a>00006 <span class="preprocessor"></span>
<a name="l00007"></a>00007 <span class="preprocessor">#ifdef __cplusplus</span>
<a name="l00008"></a>00008 <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">&quot;C&quot;</span> {
<a name="l00009"></a>00009 <span class="preprocessor">#endif</span>
<a name="l00010"></a>00010 <span class="preprocessor"></span>
<a name="l00011"></a>00011 <span class="comment">/*</span>
<a name="l00012"></a>00012 <span class="comment"> * The instance helper is designed to simplify the task of adding simple</span>
<a name="l00013"></a>00013 <span class="comment"> * * instances to the mib tree.</span>
<a name="l00014"></a>00014 <span class="comment"> */</span>
<a name="l00015"></a>00015 
<a name="l00016"></a>00016 <span class="comment">/*</span>
<a name="l00017"></a>00017 <span class="comment"> * GETNEXTs are auto-converted to a GET.</span>
<a name="l00018"></a>00018 <span class="comment"> * * non-valid GETs are dropped.</span>
<a name="l00019"></a>00019 <span class="comment"> * * The client can assume that if you&#39;re called for a GET, it shouldn&#39;t</span>
<a name="l00020"></a>00020 <span class="comment"> * * have to check the oid at all.  Just answer.</span>
<a name="l00021"></a>00021 <span class="comment"> */</span>
<a name="l00022"></a>00022 
<a name="l00023"></a>00023 <span class="keywordtype">int</span>             <a class="code" href="group__instance.html#ga9f743af6acf477e9030b789dadb63f5c" title="This function registers an instance helper handler, which is a way of registering an exact OID such t...">netsnmp_register_instance</a>(<a class="code" href="structnetsnmp__handler__registration__s.html" title="Root registration info.">netsnmp_handler_registration</a>
<a name="l00024"></a>00024                                           *reginfo);
<a name="l00025"></a>00025 <span class="keywordtype">int</span>            
<a name="l00026"></a>00026 <a class="code" href="group__instance.html#gaaa79ea1c23761ce383c2a7726556be8c" title="This function injects a &quot;read only&quot; handler into the handler chain prior to serializing/registering t...">netsnmp_register_read_only_instance</a>(<a class="code" href="structnetsnmp__handler__registration__s.html" title="Root registration info.">netsnmp_handler_registration</a> *reginfo);
<a name="l00027"></a>00027 
<a name="l00028"></a>00028 <span class="preprocessor">#define INSTANCE_HANDLER_NAME &quot;instance&quot;</span>
<a name="l00029"></a>00029 <span class="preprocessor"></span>
<a name="l00030"></a>00030 <a class="code" href="structnetsnmp__mib__handler__s.html" title="the mib handler structure to be registered">netsnmp_mib_handler</a> *<a class="code" href="group__instance.html#gad2180b5fcf3d54213ad1b34e6913e198" title="Creates an instance helper handler, calls netsnmp_create_handler, which then could be registered...">netsnmp_get_instance_handler</a>(<span class="keywordtype">void</span>);
<a name="l00031"></a>00031 
<a name="l00032"></a>00032 <span class="keywordtype">int</span>             netsnmp_register_read_only_ulong_instance(<span class="keyword">const</span> <span class="keywordtype">char</span> *name,
<a name="l00033"></a>00033                                                           oid * reg_oid,
<a name="l00034"></a>00034                                                           <span class="keywordtype">size_t</span>
<a name="l00035"></a>00035                                                           reg_oid_len,
<a name="l00036"></a>00036                                                           u_long * it,
<a name="l00037"></a>00037                                                           Netsnmp_Node_Handler
<a name="l00038"></a>00038                                                           * subhandler);
<a name="l00039"></a>00039 <span class="keywordtype">int</span>             netsnmp_register_ulong_instance(<span class="keyword">const</span> <span class="keywordtype">char</span> *name,
<a name="l00040"></a>00040                                                 oid * reg_oid,
<a name="l00041"></a>00041                                                 <span class="keywordtype">size_t</span> reg_oid_len,
<a name="l00042"></a>00042                                                 u_long * it,
<a name="l00043"></a>00043                                                 Netsnmp_Node_Handler *
<a name="l00044"></a>00044                                                 subhandler);
<a name="l00045"></a>00045 <span class="keywordtype">int</span>             netsnmp_register_read_only_counter32_instance(<span class="keyword">const</span> <span class="keywordtype">char</span>
<a name="l00046"></a>00046                                                               *name,
<a name="l00047"></a>00047                                                               oid *
<a name="l00048"></a>00048                                                               reg_oid,
<a name="l00049"></a>00049                                                               <span class="keywordtype">size_t</span>
<a name="l00050"></a>00050                                                               reg_oid_len,
<a name="l00051"></a>00051                                                               u_long * it,
<a name="l00052"></a>00052                                                               Netsnmp_Node_Handler
<a name="l00053"></a>00053                                                               *
<a name="l00054"></a>00054                                                               subhandler);
<a name="l00055"></a>00055 <span class="keywordtype">int</span>             netsnmp_register_read_only_long_instance(<span class="keyword">const</span> <span class="keywordtype">char</span> *name,
<a name="l00056"></a>00056                                                          oid * reg_oid,
<a name="l00057"></a>00057                                                          <span class="keywordtype">size_t</span>
<a name="l00058"></a>00058                                                          reg_oid_len,
<a name="l00059"></a>00059                                                          <span class="keywordtype">long</span> *it,
<a name="l00060"></a>00060                                                          Netsnmp_Node_Handler
<a name="l00061"></a>00061                                                          * subhandler);
<a name="l00062"></a>00062 <span class="keywordtype">int</span>             netsnmp_register_long_instance(<span class="keyword">const</span> <span class="keywordtype">char</span> *name,
<a name="l00063"></a>00063                                                oid * reg_oid,
<a name="l00064"></a>00064                                                <span class="keywordtype">size_t</span> reg_oid_len,
<a name="l00065"></a>00065                                                <span class="keywordtype">long</span> *it,
<a name="l00066"></a>00066                                                Netsnmp_Node_Handler *
<a name="l00067"></a>00067                                                subhandler);
<a name="l00068"></a>00068 
<a name="l00069"></a>00069 <span class="keywordtype">int</span>             netsnmp_register_read_only_int_instance(<span class="keyword">const</span> <span class="keywordtype">char</span> *name,
<a name="l00070"></a>00070                                               oid * reg_oid,
<a name="l00071"></a>00071                                               <span class="keywordtype">size_t</span> reg_oid_len, <span class="keywordtype">int</span> *it,
<a name="l00072"></a>00072                                               Netsnmp_Node_Handler *
<a name="l00073"></a>00073                                               subhandler);
<a name="l00074"></a>00074 
<a name="l00075"></a>00075 <span class="keywordtype">int</span>             <a class="code" href="group__instance.html#ga6e82ee68061075178336bc5f4b77278c" title="This function registers an int helper handler to a specified OID.">netsnmp_register_int_instance</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *name,
<a name="l00076"></a>00076                                               oid * reg_oid,
<a name="l00077"></a>00077                                               <span class="keywordtype">size_t</span> reg_oid_len, <span class="keywordtype">int</span> *it,
<a name="l00078"></a>00078                                               Netsnmp_Node_Handler *
<a name="l00079"></a>00079                                               subhandler);
<a name="l00080"></a>00080 
<a name="l00081"></a>00081 <span class="comment">/* identical functions that register a in a particular context */</span>
<a name="l00082"></a>00082 <span class="keywordtype">int</span>  netsnmp_register_read_only_ulong_instance_context(<span class="keyword">const</span> <span class="keywordtype">char</span> *name,
<a name="l00083"></a>00083                                                        oid * reg_oid,
<a name="l00084"></a>00084                                                        <span class="keywordtype">size_t</span>
<a name="l00085"></a>00085                                                        reg_oid_len,
<a name="l00086"></a>00086                                                        u_long * it,
<a name="l00087"></a>00087                                                        Netsnmp_Node_Handler
<a name="l00088"></a>00088                                                        * subhandler,
<a name="l00089"></a>00089                                                        <span class="keyword">const</span> <span class="keywordtype">char</span> *contextName);
<a name="l00090"></a>00090 <span class="keywordtype">int</span>  netsnmp_register_ulong_instance_context(<span class="keyword">const</span> <span class="keywordtype">char</span> *name,
<a name="l00091"></a>00091                                              oid * reg_oid,
<a name="l00092"></a>00092                                              <span class="keywordtype">size_t</span> reg_oid_len,
<a name="l00093"></a>00093                                              u_long * it,
<a name="l00094"></a>00094                                              Netsnmp_Node_Handler *
<a name="l00095"></a>00095                                              subhandler,
<a name="l00096"></a>00096                                              <span class="keyword">const</span> <span class="keywordtype">char</span> *contextName);
<a name="l00097"></a>00097 <span class="keywordtype">int</span>  netsnmp_register_read_only_counter32_instance_context(<span class="keyword">const</span> <span class="keywordtype">char</span>
<a name="l00098"></a>00098                                                            *name,
<a name="l00099"></a>00099                                                            oid *
<a name="l00100"></a>00100                                                            reg_oid,
<a name="l00101"></a>00101                                                            <span class="keywordtype">size_t</span>
<a name="l00102"></a>00102                                                            reg_oid_len,
<a name="l00103"></a>00103                                                            u_long * it,
<a name="l00104"></a>00104                                                            Netsnmp_Node_Handler
<a name="l00105"></a>00105                                                            *
<a name="l00106"></a>00106                                                            subhandler,
<a name="l00107"></a>00107                                                            <span class="keyword">const</span> <span class="keywordtype">char</span> *contextName);
<a name="l00108"></a>00108 <span class="keywordtype">int</span>  netsnmp_register_read_only_long_instance_context(<span class="keyword">const</span> <span class="keywordtype">char</span> *name,
<a name="l00109"></a>00109                                                       oid * reg_oid,
<a name="l00110"></a>00110                                                       <span class="keywordtype">size_t</span>
<a name="l00111"></a>00111                                                       reg_oid_len,
<a name="l00112"></a>00112                                                       <span class="keywordtype">long</span> *it,
<a name="l00113"></a>00113                                                       Netsnmp_Node_Handler
<a name="l00114"></a>00114                                                       * subhandler,
<a name="l00115"></a>00115                                                       <span class="keyword">const</span> <span class="keywordtype">char</span> *contextName);
<a name="l00116"></a>00116 <span class="keywordtype">int</span>  netsnmp_register_long_instance_context(<span class="keyword">const</span> <span class="keywordtype">char</span> *name,
<a name="l00117"></a>00117                                             oid * reg_oid,
<a name="l00118"></a>00118                                             <span class="keywordtype">size_t</span> reg_oid_len,
<a name="l00119"></a>00119                                             <span class="keywordtype">long</span> *it,
<a name="l00120"></a>00120                                             Netsnmp_Node_Handler *
<a name="l00121"></a>00121                                             subhandler,
<a name="l00122"></a>00122                                             <span class="keyword">const</span> <span class="keywordtype">char</span> *contextName);
<a name="l00123"></a>00123 
<a name="l00124"></a>00124 <span class="keywordtype">int</span>  netsnmp_register_read_only_int_instance_context(<span class="keyword">const</span> <span class="keywordtype">char</span> *name,
<a name="l00125"></a>00125                                                      oid * reg_oid,
<a name="l00126"></a>00126                                                      <span class="keywordtype">size_t</span> reg_oid_len, <span class="keywordtype">int</span> *it,
<a name="l00127"></a>00127                                                      Netsnmp_Node_Handler *
<a name="l00128"></a>00128                                                      subhandler,
<a name="l00129"></a>00129                                                      <span class="keyword">const</span> <span class="keywordtype">char</span> *contextName);
<a name="l00130"></a>00130 
<a name="l00131"></a>00131 <span class="keywordtype">int</span>  netsnmp_register_int_instance_context(<span class="keyword">const</span> <span class="keywordtype">char</span> *name,
<a name="l00132"></a>00132                                            oid * reg_oid,
<a name="l00133"></a>00133                                            <span class="keywordtype">size_t</span> reg_oid_len, <span class="keywordtype">int</span> *it,
<a name="l00134"></a>00134                                            Netsnmp_Node_Handler *
<a name="l00135"></a>00135                                            subhandler,
<a name="l00136"></a>00136                                            <span class="keyword">const</span> <span class="keywordtype">char</span> *contextName);
<a name="l00137"></a>00137 
<a name="l00138"></a>00138 <span class="keywordtype">int</span>  netsnmp_register_num_file_instance(<span class="keyword">const</span> <span class="keywordtype">char</span> *name,
<a name="l00139"></a>00139                                         oid * reg_oid, <span class="keywordtype">size_t</span> reg_oid_len,
<a name="l00140"></a>00140                                         <span class="keywordtype">char</span> *file_name, <span class="keywordtype">int</span> asn_type, <span class="keywordtype">int</span> mode,
<a name="l00141"></a>00141                                         Netsnmp_Node_Handler * subhandler,
<a name="l00142"></a>00142                                         <span class="keyword">const</span> <span class="keywordtype">char</span> *contextName);
<a name="l00143"></a>00143 
<a name="l00144"></a>00144 Netsnmp_Node_Handler netsnmp_instance_helper_handler;
<a name="l00145"></a>00145 Netsnmp_Node_Handler netsnmp_instance_ulong_handler;
<a name="l00146"></a>00146 Netsnmp_Node_Handler netsnmp_instance_long_handler;
<a name="l00147"></a>00147 Netsnmp_Node_Handler netsnmp_instance_int_handler;
<a name="l00148"></a>00148 Netsnmp_Node_Handler netsnmp_instance_uint_handler;
<a name="l00149"></a>00149 Netsnmp_Node_Handler netsnmp_instance_counter32_handler;
<a name="l00150"></a>00150 Netsnmp_Node_Handler <a class="code" href="group__instance.html#ga362ca299f09fa111fa5e39663f6ddaab">netsnmp_instance_num_file_handler</a>;
<a name="l00151"></a>00151 
<a name="l00152"></a>00152 <span class="preprocessor">#ifdef __cplusplus</span>
<a name="l00153"></a>00153 <span class="preprocessor"></span>}
<a name="l00154"></a>00154 <span class="preprocessor">#endif</span>
<a name="l00155"></a>00155 <span class="preprocessor"></span>
<a name="l00156"></a>00156 <span class="preprocessor">#endif </span>
</pre></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>