| <!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"/> |
| <meta name="generator" content="Doxygen 1.8.13"/> |
| <meta name="viewport" content="width=device-width, initial-scale=1"/> |
| <title>lwIP: src/include/lwip/icmp.h 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> |
| <link href="navtree.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="resize.js"></script> |
| <script type="text/javascript" src="navtreedata.js"></script> |
| <script type="text/javascript" src="navtree.js"></script> |
| <script type="text/javascript"> |
| $(document).ready(initResizable); |
| </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 style="height: 56px;"> |
| <td id="projectalign" style="padding-left: 0.5em;"> |
| <div id="projectname">lwIP |
|  <span id="projectnumber">2.1.2</span> |
| </div> |
| <div id="projectbrief">Lightweight IP stack</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.8.13 --> |
| <script type="text/javascript"> |
| var searchBox = new SearchBox("searchBox", "search",false,'Search'); |
| </script> |
| <script type="text/javascript" src="menudata.js"></script> |
| <script type="text/javascript" src="menu.js"></script> |
| <script type="text/javascript"> |
| $(function() { |
| initMenu('',true,false,'search.php','Search'); |
| $(document).ready(function() { init_search(); }); |
| }); |
| </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"> |
| $(document).ready(function(){initNavTree('icmp_8h.html','');}); |
| </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"> |
| <iframe src="javascript:void(0)" frameborder="0" |
| name="MSearchResults" id="MSearchResults"> |
| </iframe> |
| </div> |
| |
| <div class="header"> |
| <div class="summary"> |
| <a href="#enum-members">Enumerations</a> | |
| <a href="#func-members">Functions</a> </div> |
| <div class="headertitle"> |
| <div class="title">icmp.h File Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| <div class="textblock"><code>#include "<a class="el" href="opt_8h.html">lwip/opt.h</a>"</code><br /> |
| <code>#include "<a class="el" href="pbuf_8h.html">lwip/pbuf.h</a>"</code><br /> |
| <code>#include "<a class="el" href="ip__addr_8h.html">lwip/ip_addr.h</a>"</code><br /> |
| <code>#include "<a class="el" href="netif_8h.html">lwip/netif.h</a>"</code><br /> |
| <code>#include "<a class="el" href="prot_2icmp_8h.html">lwip/prot/icmp.h</a>"</code><br /> |
| <code>#include "<a class="el" href="icmp6_8h.html">lwip/icmp6.h</a>"</code><br /> |
| </div><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a> |
| Enumerations</h2></td></tr> |
| <tr class="memitem:a17637465f209385e5d19ef47fd9266a5"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="icmp_8h.html#a17637465f209385e5d19ef47fd9266a5">icmp_dur_type</a> { <br /> |
|   <a class="el" href="icmp_8h.html#a17637465f209385e5d19ef47fd9266a5a3cc3714544e123bdef2eadb1a4d320e3">ICMP_DUR_NET</a> = 0, |
| <a class="el" href="icmp_8h.html#a17637465f209385e5d19ef47fd9266a5a648ab915a76dfb7b9568e94de00da1e7">ICMP_DUR_HOST</a> = 1, |
| <a class="el" href="icmp_8h.html#a17637465f209385e5d19ef47fd9266a5a3c7bbd13b613990413ef167017dfbcef">ICMP_DUR_PROTO</a> = 2, |
| <a class="el" href="icmp_8h.html#a17637465f209385e5d19ef47fd9266a5ac973dd9b04e094043ccc4cf875ef5644">ICMP_DUR_PORT</a> = 3, |
| <br /> |
|   <a class="el" href="icmp_8h.html#a17637465f209385e5d19ef47fd9266a5a8be2bc49d42aa1a6ee1da93a8700ef5f">ICMP_DUR_FRAG</a> = 4, |
| <a class="el" href="icmp_8h.html#a17637465f209385e5d19ef47fd9266a5af63296fc25f79e56946a56a8da132c13">ICMP_DUR_SR</a> = 5 |
| <br /> |
| }</td></tr> |
| <tr class="separator:a17637465f209385e5d19ef47fd9266a5"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a058d0a0769bd38db99fc6fd1dad1324a"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="icmp_8h.html#a058d0a0769bd38db99fc6fd1dad1324a">icmp_te_type</a> { <a class="el" href="icmp_8h.html#a058d0a0769bd38db99fc6fd1dad1324aa827a1f8705826a6cc3c22e2571acf02c">ICMP_TE_TTL</a> = 0, |
| <a class="el" href="icmp_8h.html#a058d0a0769bd38db99fc6fd1dad1324aa4d351874c3e2d4a4cf46569df28cd796">ICMP_TE_FRAG</a> = 1 |
| }</td></tr> |
| <tr class="separator:a058d0a0769bd38db99fc6fd1dad1324a"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> |
| Functions</h2></td></tr> |
| <tr class="memitem:ac929e48a1dddf98050b73a2633fcaef1"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="icmp_8h.html#ac929e48a1dddf98050b73a2633fcaef1">icmp_input</a> (struct <a class="el" href="structpbuf.html">pbuf</a> *p, struct <a class="el" href="structnetif.html">netif</a> *inp)</td></tr> |
| <tr class="separator:ac929e48a1dddf98050b73a2633fcaef1"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ae26c59eab4ce553964a0c9d43f534d06"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="icmp_8h.html#ae26c59eab4ce553964a0c9d43f534d06">icmp_dest_unreach</a> (struct <a class="el" href="structpbuf.html">pbuf</a> *p, enum <a class="el" href="icmp_8h.html#a17637465f209385e5d19ef47fd9266a5">icmp_dur_type</a> t)</td></tr> |
| <tr class="separator:ae26c59eab4ce553964a0c9d43f534d06"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a49723e5e11c4bbc86197e58fdca7c119"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="icmp_8h.html#a49723e5e11c4bbc86197e58fdca7c119">icmp_time_exceeded</a> (struct <a class="el" href="structpbuf.html">pbuf</a> *p, enum <a class="el" href="icmp_8h.html#a058d0a0769bd38db99fc6fd1dad1324a">icmp_te_type</a> t)</td></tr> |
| <tr class="separator:a49723e5e11c4bbc86197e58fdca7c119"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>ICMP API </p> |
| </div><h2 class="groupheader">Enumeration Type Documentation</h2> |
| <a id="a17637465f209385e5d19ef47fd9266a5"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a17637465f209385e5d19ef47fd9266a5">◆ </a></span>icmp_dur_type</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">enum <a class="el" href="icmp_8h.html#a17637465f209385e5d19ef47fd9266a5">icmp_dur_type</a></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>ICMP destination unreachable codes </p> |
| <table class="fieldtable"> |
| <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a17637465f209385e5d19ef47fd9266a5a3cc3714544e123bdef2eadb1a4d320e3"></a>ICMP_DUR_NET </td><td class="fielddoc"><p>net unreachable </p> |
| </td></tr> |
| <tr><td class="fieldname"><a id="a17637465f209385e5d19ef47fd9266a5a648ab915a76dfb7b9568e94de00da1e7"></a>ICMP_DUR_HOST </td><td class="fielddoc"><p>host unreachable </p> |
| </td></tr> |
| <tr><td class="fieldname"><a id="a17637465f209385e5d19ef47fd9266a5a3c7bbd13b613990413ef167017dfbcef"></a>ICMP_DUR_PROTO </td><td class="fielddoc"><p>protocol unreachable </p> |
| </td></tr> |
| <tr><td class="fieldname"><a id="a17637465f209385e5d19ef47fd9266a5ac973dd9b04e094043ccc4cf875ef5644"></a>ICMP_DUR_PORT </td><td class="fielddoc"><p>port unreachable </p> |
| </td></tr> |
| <tr><td class="fieldname"><a id="a17637465f209385e5d19ef47fd9266a5a8be2bc49d42aa1a6ee1da93a8700ef5f"></a>ICMP_DUR_FRAG </td><td class="fielddoc"><p>fragmentation needed and DF set </p> |
| </td></tr> |
| <tr><td class="fieldname"><a id="a17637465f209385e5d19ef47fd9266a5af63296fc25f79e56946a56a8da132c13"></a>ICMP_DUR_SR </td><td class="fielddoc"><p>source route failed </p> |
| </td></tr> |
| </table> |
| |
| </div> |
| </div> |
| <a id="a058d0a0769bd38db99fc6fd1dad1324a"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a058d0a0769bd38db99fc6fd1dad1324a">◆ </a></span>icmp_te_type</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">enum <a class="el" href="icmp_8h.html#a058d0a0769bd38db99fc6fd1dad1324a">icmp_te_type</a></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>ICMP time exceeded codes </p> |
| <table class="fieldtable"> |
| <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a058d0a0769bd38db99fc6fd1dad1324aa827a1f8705826a6cc3c22e2571acf02c"></a>ICMP_TE_TTL </td><td class="fielddoc"><p>time to live exceeded in transit </p> |
| </td></tr> |
| <tr><td class="fieldname"><a id="a058d0a0769bd38db99fc6fd1dad1324aa4d351874c3e2d4a4cf46569df28cd796"></a>ICMP_TE_FRAG </td><td class="fielddoc"><p>fragment reassembly time exceeded </p> |
| </td></tr> |
| </table> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Function Documentation</h2> |
| <a id="ae26c59eab4ce553964a0c9d43f534d06"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ae26c59eab4ce553964a0c9d43f534d06">◆ </a></span>icmp_dest_unreach()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void icmp_dest_unreach </td> |
| <td>(</td> |
| <td class="paramtype">struct <a class="el" href="structpbuf.html">pbuf</a> * </td> |
| <td class="paramname"><em>p</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">enum <a class="el" href="icmp_8h.html#a17637465f209385e5d19ef47fd9266a5">icmp_dur_type</a> </td> |
| <td class="paramname"><em>t</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Send an icmp 'destination unreachable' packet, called from <a class="el" href="group__lwip__nosys.html#ga3c420dab0c6760df099a2d688fa42a26">ip_input()</a> if the transport layer protocol is unknown and from <a class="el" href="udp_8c.html#a7b338a5515606bd51976fbc5bcec9611">udp_input()</a> if the local port is not bound.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">p</td><td>the input packet for which the 'unreachable' should be sent, p->payload pointing to the IP header </td></tr> |
| <tr><td class="paramname">t</td><td>type of the 'unreachable' packet </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="ac929e48a1dddf98050b73a2633fcaef1"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ac929e48a1dddf98050b73a2633fcaef1">◆ </a></span>icmp_input()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void icmp_input </td> |
| <td>(</td> |
| <td class="paramtype">struct <a class="el" href="structpbuf.html">pbuf</a> * </td> |
| <td class="paramname"><em>p</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">struct <a class="el" href="structnetif.html">netif</a> * </td> |
| <td class="paramname"><em>inp</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Processes ICMP input packets, called from <a class="el" href="group__lwip__nosys.html#ga3c420dab0c6760df099a2d688fa42a26">ip_input()</a>.</p> |
| <p>Currently only processes icmp echo requests and sends out the echo response.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">p</td><td>the icmp echo request packet, p->payload pointing to the icmp header </td></tr> |
| <tr><td class="paramname">inp</td><td>the netif on which this packet was received </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="a49723e5e11c4bbc86197e58fdca7c119"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a49723e5e11c4bbc86197e58fdca7c119">◆ </a></span>icmp_time_exceeded()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void icmp_time_exceeded </td> |
| <td>(</td> |
| <td class="paramtype">struct <a class="el" href="structpbuf.html">pbuf</a> * </td> |
| <td class="paramname"><em>p</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">enum <a class="el" href="icmp_8h.html#a058d0a0769bd38db99fc6fd1dad1324a">icmp_te_type</a> </td> |
| <td class="paramname"><em>t</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Send a 'time exceeded' packet, called from ip_forward() if TTL is 0.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">p</td><td>the input packet for which the 'time exceeded' should be sent, p->payload pointing to the IP header </td></tr> |
| <tr><td class="paramname">t</td><td>type of the 'time exceeded' packet </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </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_b0856f6b0d80ccb263b2f415c91f9e17.html">include</a></li><li class="navelem"><a class="el" href="dir_4e6b3cf33a61b6caac9c8ac30c866f37.html">lwip</a></li><li class="navelem"><a class="el" href="icmp_8h.html">icmp.h</a></li> |
| <li class="footer">Generated by |
| <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li> |
| </ul> |
| </div> |
| </body> |
| </html> |
