blob: 6a195cbe7cd187148c9d596b954f4c4180318a71 [file] [log] [blame] [edit]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.12.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>lwIP: src/apps/snmp/snmp_msg.c File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="clipboard.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="cookie.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">lwIP<span id="projectnumber">&#160;2.1.3</span>
</div>
<div id="projectbrief">Lightweight IP stack</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.12.0 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search',true);
$(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){initNavTree('snmp__msg_8c.html',''); initResizable(true); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> &#124;
<a href="#var-members">Variables</a> </div>
<div class="headertitle"><div class="title">snmp_msg.c File Reference</div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &quot;<a class="el" href="snmp__opts_8h.html">lwip/apps/snmp_opts.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="snmp__msg_8h.html">snmp_msg.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="snmp__asn1_8h.html">snmp_asn1.h</a>&quot;</code><br />
<code>#include &quot;snmp_core_priv.h&quot;</code><br />
<code>#include &quot;<a class="el" href="ip__addr_8h.html">lwip/ip_addr.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="stats_8h.html">lwip/stats.h</a>&quot;</code><br />
<code>#include &lt;string.h&gt;</code><br />
</div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga1fe737c1371a3ed3bb515d451ef3eea8" id="r_ga1fe737c1371a3ed3bb515d451ef3eea8"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__snmp__core.html#ga1fe737c1371a3ed3bb515d451ef3eea8">snmp_get_community</a> (void)</td></tr>
<tr class="separator:ga1fe737c1371a3ed3bb515d451ef3eea8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga30cc587a260757fdb2b81d462f430ef1" id="r_ga30cc587a260757fdb2b81d462f430ef1"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__snmp__core.html#ga30cc587a260757fdb2b81d462f430ef1">snmp_set_community</a> (const char *const community)</td></tr>
<tr class="separator:ga30cc587a260757fdb2b81d462f430ef1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga6654521b83f35c600b689b950dcc2c4e" id="r_ga6654521b83f35c600b689b950dcc2c4e"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__snmp__core.html#ga6654521b83f35c600b689b950dcc2c4e">snmp_get_community_write</a> (void)</td></tr>
<tr class="separator:ga6654521b83f35c600b689b950dcc2c4e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga566aa7aeaf5fb75ca0a2af58486f4cba" id="r_ga566aa7aeaf5fb75ca0a2af58486f4cba"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__snmp__traps.html#ga566aa7aeaf5fb75ca0a2af58486f4cba">snmp_get_community_trap</a> (void)</td></tr>
<tr class="separator:ga566aa7aeaf5fb75ca0a2af58486f4cba"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga341461766863cff46a44e5f431f2da01" id="r_ga341461766863cff46a44e5f431f2da01"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__snmp__core.html#ga341461766863cff46a44e5f431f2da01">snmp_set_community_write</a> (const char *const community)</td></tr>
<tr class="separator:ga341461766863cff46a44e5f431f2da01"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga5631711f357b6610be7e93b1c6d87760" id="r_ga5631711f357b6610be7e93b1c6d87760"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__snmp__traps.html#ga5631711f357b6610be7e93b1c6d87760">snmp_set_community_trap</a> (const char *const community)</td></tr>
<tr class="separator:ga5631711f357b6610be7e93b1c6d87760"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaff6a6b39322e92862ab55cfcddfe254b" id="r_gaff6a6b39322e92862ab55cfcddfe254b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__snmp__core.html#gaff6a6b39322e92862ab55cfcddfe254b">snmp_set_write_callback</a> (snmp_write_callback_fct write_callback, void *callback_arg)</td></tr>
<tr class="separator:gaff6a6b39322e92862ab55cfcddfe254b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac1f684dada963f68b71a04a702f28fe5" id="r_ac1f684dada963f68b71a04a702f28fe5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__infrastructure__errors.html#gaf02d9da80fd66b4f986d2c53d7231ddb">err_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ac1f684dada963f68b71a04a702f28fe5">snmp_varbind_length</a> (struct <a class="el" href="structsnmp__varbind.html">snmp_varbind</a> *varbind, struct <a class="el" href="structsnmp__varbind__len.html">snmp_varbind_len</a> *len)</td></tr>
<tr class="separator:ac1f684dada963f68b71a04a702f28fe5"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="var-members" name="var-members"></a>
Variables</h2></td></tr>
<tr class="memitem:ac6f810ab812c44c6ca1df1fdf926a9f6" id="r_ac6f810ab812c44c6ca1df1fdf926a9f6"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ac6f810ab812c44c6ca1df1fdf926a9f6">snmp_community</a> = &quot;public&quot;</td></tr>
<tr class="separator:ac6f810ab812c44c6ca1df1fdf926a9f6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2d77485bb0b640c8e5f569ca756d3b04" id="r_a2d77485bb0b640c8e5f569ca756d3b04"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a2d77485bb0b640c8e5f569ca756d3b04">snmp_community_write</a> = &quot;private&quot;</td></tr>
<tr class="separator:a2d77485bb0b640c8e5f569ca756d3b04"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2e2007343d9492b8e31d363d2c6ad79b" id="r_a2e2007343d9492b8e31d363d2c6ad79b"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a2e2007343d9492b8e31d363d2c6ad79b">snmp_community_trap</a> = &quot;public&quot;</td></tr>
<tr class="separator:a2e2007343d9492b8e31d363d2c6ad79b"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>SNMP message processing (RFC1157). </p>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="ac1f684dada963f68b71a04a702f28fe5" name="ac1f684dada963f68b71a04a702f28fe5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac1f684dada963f68b71a04a702f28fe5">&#9670;&#160;</a></span>snmp_varbind_length()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__infrastructure__errors.html#gaf02d9da80fd66b4f986d2c53d7231ddb">err_t</a> snmp_varbind_length </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structsnmp__varbind.html">snmp_varbind</a> *</td> <td class="paramname"><span class="paramname"><em>varbind</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">struct <a class="el" href="structsnmp__varbind__len.html">snmp_varbind_len</a> *</td> <td class="paramname"><span class="paramname"><em>len</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Calculate the length of a varbind list </p>
</div>
</div>
<h2 class="groupheader">Variable Documentation</h2>
<a id="ac6f810ab812c44c6ca1df1fdf926a9f6" name="ac6f810ab812c44c6ca1df1fdf926a9f6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac6f810ab812c44c6ca1df1fdf926a9f6">&#9670;&#160;</a></span>snmp_community</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* snmp_community = &quot;public&quot;</td>
</tr>
</table>
</div><div class="memdoc">
<p>SNMP community string </p>
</div>
</div>
<a id="a2e2007343d9492b8e31d363d2c6ad79b" name="a2e2007343d9492b8e31d363d2c6ad79b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2e2007343d9492b8e31d363d2c6ad79b">&#9670;&#160;</a></span>snmp_community_trap</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* snmp_community_trap = &quot;public&quot;</td>
</tr>
</table>
</div><div class="memdoc">
<p>SNMP community string for sending traps </p>
</div>
</div>
<a id="a2d77485bb0b640c8e5f569ca756d3b04" name="a2d77485bb0b640c8e5f569ca756d3b04"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2d77485bb0b640c8e5f569ca756d3b04">&#9670;&#160;</a></span>snmp_community_write</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* snmp_community_write = &quot;private&quot;</td>
</tr>
</table>
</div><div class="memdoc">
<p>SNMP community string for write access </p>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_53adf0b982dc8545998aae3f283a5a58.html">apps</a></li><li class="navelem"><a class="el" href="dir_fb3f7e43f39ddb210bd1444e66d055f1.html">snmp</a></li><li class="navelem"><a class="el" href="snmp__msg_8c.html">snmp_msg.c</a></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.12.0 </li>
</ul>
</div>
</body>
</html>