1627 lines
166 KiB
HTML
1627 lines
166 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
|
|
<title>uIP 1.0: uip/uip.h Source File</title>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css">
|
|
<link href="tabs.css" rel="stylesheet" type="text/css">
|
|
</head><body>
|
|
<!-- Generated by Doxygen 1.4.6 -->
|
|
<div class="tabs">
|
|
<ul>
|
|
<li><a href="main.html"><span>Main Page</span></a></li>
|
|
<li><a href="modules.html"><span>Modules</span></a></li>
|
|
<li><a href="classes.html"><span>Data Structures</span></a></li>
|
|
<li id="current"><a href="files.html"><span>Files</span></a></li>
|
|
<li><a href="examples.html"><span>Examples</span></a></li>
|
|
</ul></div>
|
|
<div class="tabs">
|
|
<ul>
|
|
<li><a href="files.html"><span>File List</span></a></li>
|
|
<li><a href="globals.html"><span>Globals</span></a></li>
|
|
</ul></div>
|
|
<h1>uip/uip.h</h1><a href="a00136.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment"></span>
|
|
<a name="l00002"></a>00002 <span class="comment">/**</span>
|
|
<a name="l00003"></a>00003 <span class="comment"> * \addtogroup uip</span>
|
|
<a name="l00004"></a>00004 <span class="comment"> * @{</span>
|
|
<a name="l00005"></a>00005 <span class="comment"> */</span>
|
|
<a name="l00006"></a>00006 <span class="comment"></span>
|
|
<a name="l00007"></a>00007 <span class="comment">/**</span>
|
|
<a name="l00008"></a>00008 <span class="comment"> * \file</span>
|
|
<a name="l00009"></a>00009 <span class="comment"> * Header file for the uIP TCP/IP stack.</span>
|
|
<a name="l00010"></a>00010 <span class="comment"> * \author Adam Dunkels <adam@dunkels.com></span>
|
|
<a name="l00011"></a>00011 <span class="comment"> *</span>
|
|
<a name="l00012"></a>00012 <span class="comment"> * The uIP TCP/IP stack header file contains definitions for a number</span>
|
|
<a name="l00013"></a>00013 <span class="comment"> * of C macros that are used by uIP programs as well as internal uIP</span>
|
|
<a name="l00014"></a>00014 <span class="comment"> * structures, TCP/IP header structures and function declarations.</span>
|
|
<a name="l00015"></a>00015 <span class="comment"> *</span>
|
|
<a name="l00016"></a>00016 <span class="comment"> */</span>
|
|
<a name="l00017"></a>00017
|
|
<a name="l00018"></a>00018
|
|
<a name="l00019"></a>00019 <span class="comment">/*</span>
|
|
<a name="l00020"></a>00020 <span class="comment"> * Copyright (c) 2001-2003, Adam Dunkels.</span>
|
|
<a name="l00021"></a>00021 <span class="comment"> * All rights reserved.</span>
|
|
<a name="l00022"></a>00022 <span class="comment"> *</span>
|
|
<a name="l00023"></a>00023 <span class="comment"> * Redistribution and use in source and binary forms, with or without</span>
|
|
<a name="l00024"></a>00024 <span class="comment"> * modification, are permitted provided that the following conditions</span>
|
|
<a name="l00025"></a>00025 <span class="comment"> * are met:</span>
|
|
<a name="l00026"></a>00026 <span class="comment"> * 1. Redistributions of source code must retain the above copyright</span>
|
|
<a name="l00027"></a>00027 <span class="comment"> * notice, this list of conditions and the following disclaimer.</span>
|
|
<a name="l00028"></a>00028 <span class="comment"> * 2. Redistributions in binary form must reproduce the above copyright</span>
|
|
<a name="l00029"></a>00029 <span class="comment"> * notice, this list of conditions and the following disclaimer in the</span>
|
|
<a name="l00030"></a>00030 <span class="comment"> * documentation and/or other materials provided with the distribution.</span>
|
|
<a name="l00031"></a>00031 <span class="comment"> * 3. The name of the author may not be used to endorse or promote</span>
|
|
<a name="l00032"></a>00032 <span class="comment"> * products derived from this software without specific prior</span>
|
|
<a name="l00033"></a>00033 <span class="comment"> * written permission.</span>
|
|
<a name="l00034"></a>00034 <span class="comment"> *</span>
|
|
<a name="l00035"></a>00035 <span class="comment"> * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS</span>
|
|
<a name="l00036"></a>00036 <span class="comment"> * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED</span>
|
|
<a name="l00037"></a>00037 <span class="comment"> * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE</span>
|
|
<a name="l00038"></a>00038 <span class="comment"> * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY</span>
|
|
<a name="l00039"></a>00039 <span class="comment"> * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL</span>
|
|
<a name="l00040"></a>00040 <span class="comment"> * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE</span>
|
|
<a name="l00041"></a>00041 <span class="comment"> * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS</span>
|
|
<a name="l00042"></a>00042 <span class="comment"> * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,</span>
|
|
<a name="l00043"></a>00043 <span class="comment"> * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING</span>
|
|
<a name="l00044"></a>00044 <span class="comment"> * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS</span>
|
|
<a name="l00045"></a>00045 <span class="comment"> * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.</span>
|
|
<a name="l00046"></a>00046 <span class="comment"> *</span>
|
|
<a name="l00047"></a>00047 <span class="comment"> * This file is part of the uIP TCP/IP stack.</span>
|
|
<a name="l00048"></a>00048 <span class="comment"> *</span>
|
|
<a name="l00049"></a>00049 <span class="comment"> * $Id: uip.h,v 1.40 2006/06/08 07:12:07 adam Exp $</span>
|
|
<a name="l00050"></a>00050 <span class="comment"> *</span>
|
|
<a name="l00051"></a>00051 <span class="comment"> */</span>
|
|
<a name="l00052"></a>00052
|
|
<a name="l00053"></a>00053 <span class="preprocessor">#ifndef __UIP_H__</span>
|
|
<a name="l00054"></a>00054 <span class="preprocessor"></span><span class="preprocessor">#define __UIP_H__</span>
|
|
<a name="l00055"></a>00055 <span class="preprocessor"></span>
|
|
<a name="l00056"></a>00056 <span class="preprocessor">#include "<a class="code" href="a00140.html">uipopt.h</a>"</span>
|
|
<a name="l00057"></a>00057 <span class="comment"></span>
|
|
<a name="l00058"></a>00058 <span class="comment">/**</span>
|
|
<a name="l00059"></a>00059 <span class="comment"> * Repressentation of an IP address.</span>
|
|
<a name="l00060"></a>00060 <span class="comment"> *</span>
|
|
<a name="l00061"></a>00061 <span class="comment"> */</span>
|
|
<a name="l00062"></a><a class="code" href="a00150.html#g20ceef9d0868d391c2f33041b02cb1f1">00062</a> <span class="keyword">typedef</span> <a class="code" href="a00153.html#g77570ac4fcab86864fa1916e55676da2">u16_t</a> <a class="code" href="a00150.html#g20ceef9d0868d391c2f33041b02cb1f1">uip_ip4addr_t</a>[2];
|
|
<a name="l00063"></a><a class="code" href="a00150.html#g9ebb4dac683163840eab9c6c41ad61f7">00063</a> <span class="keyword">typedef</span> <a class="code" href="a00153.html#g77570ac4fcab86864fa1916e55676da2">u16_t</a> <a class="code" href="a00150.html#g9ebb4dac683163840eab9c6c41ad61f7">uip_ip6addr_t</a>[8];
|
|
<a name="l00064"></a>00064 <span class="preprocessor">#if UIP_CONF_IPV6</span>
|
|
<a name="l00065"></a>00065 <span class="preprocessor"></span><span class="keyword">typedef</span> <a class="code" href="a00150.html#g9ebb4dac683163840eab9c6c41ad61f7">uip_ip6addr_t</a> <a class="code" href="a00150.html#g1ef35301f43a5bbb9f89f07b5a36b9a0">uip_ipaddr_t</a>;
|
|
<a name="l00066"></a>00066 <span class="preprocessor">#else </span><span class="comment">/* UIP_CONF_IPV6 */</span>
|
|
<a name="l00067"></a><a class="code" href="a00150.html#g1ef35301f43a5bbb9f89f07b5a36b9a0">00067</a> <span class="keyword">typedef</span> <a class="code" href="a00150.html#g20ceef9d0868d391c2f33041b02cb1f1">uip_ip4addr_t</a> <a class="code" href="a00150.html#g1ef35301f43a5bbb9f89f07b5a36b9a0">uip_ipaddr_t</a>;
|
|
<a name="l00068"></a>00068 <span class="preprocessor">#endif </span><span class="comment">/* UIP_CONF_IPV6 */</span>
|
|
<a name="l00069"></a>00069
|
|
<a name="l00070"></a>00070 <span class="comment">/*---------------------------------------------------------------------------*/</span>
|
|
<a name="l00071"></a>00071 <span class="comment">/* First, the functions that should be called from the</span>
|
|
<a name="l00072"></a>00072 <span class="comment"> * system. Initialization, the periodic timer and incoming packets are</span>
|
|
<a name="l00073"></a>00073 <span class="comment"> * handled by the following three functions.</span>
|
|
<a name="l00074"></a>00074 <span class="comment"> */</span>
|
|
<a name="l00075"></a>00075 <span class="comment"></span>
|
|
<a name="l00076"></a>00076 <span class="comment">/**</span>
|
|
<a name="l00077"></a>00077 <span class="comment"> * \defgroup uipconffunc uIP configuration functions</span>
|
|
<a name="l00078"></a>00078 <span class="comment"> * @{</span>
|
|
<a name="l00079"></a>00079 <span class="comment"> *</span>
|
|
<a name="l00080"></a>00080 <span class="comment"> * The uIP configuration functions are used for setting run-time</span>
|
|
<a name="l00081"></a>00081 <span class="comment"> * parameters in uIP such as IP addresses.</span>
|
|
<a name="l00082"></a>00082 <span class="comment"> */</span>
|
|
<a name="l00083"></a>00083 <span class="comment"></span>
|
|
<a name="l00084"></a>00084 <span class="comment">/**</span>
|
|
<a name="l00085"></a>00085 <span class="comment"> * Set the IP address of this host.</span>
|
|
<a name="l00086"></a>00086 <span class="comment"> *</span>
|
|
<a name="l00087"></a>00087 <span class="comment"> * The IP address is represented as a 4-byte array where the first</span>
|
|
<a name="l00088"></a>00088 <span class="comment"> * octet of the IP address is put in the first member of the 4-byte</span>
|
|
<a name="l00089"></a>00089 <span class="comment"> * array.</span>
|
|
<a name="l00090"></a>00090 <span class="comment"> *</span>
|
|
<a name="l00091"></a>00091 <span class="comment"> * Example:</span>
|
|
<a name="l00092"></a>00092 <span class="comment"> \code</span>
|
|
<a name="l00093"></a>00093 <span class="comment"></span>
|
|
<a name="l00094"></a>00094 <span class="comment"> uip_ipaddr_t addr;</span>
|
|
<a name="l00095"></a>00095 <span class="comment"></span>
|
|
<a name="l00096"></a>00096 <span class="comment"> uip_ipaddr(&addr, 192,168,1,2);</span>
|
|
<a name="l00097"></a>00097 <span class="comment"> uip_sethostaddr(&addr);</span>
|
|
<a name="l00098"></a>00098 <span class="comment"> </span>
|
|
<a name="l00099"></a>00099 <span class="comment"> \endcode</span>
|
|
<a name="l00100"></a>00100 <span class="comment"> * \param addr A pointer to an IP address of type uip_ipaddr_t;</span>
|
|
<a name="l00101"></a>00101 <span class="comment"> *</span>
|
|
<a name="l00102"></a>00102 <span class="comment"> * \sa uip_ipaddr()</span>
|
|
<a name="l00103"></a>00103 <span class="comment"> *</span>
|
|
<a name="l00104"></a>00104 <span class="comment"> * \hideinitializer</span>
|
|
<a name="l00105"></a>00105 <span class="comment"> */</span>
|
|
<a name="l00106"></a><a class="code" href="a00144.html#g12b467f314489259dd718228d0827a51">00106</a> <span class="preprocessor">#define uip_sethostaddr(addr) uip_ipaddr_copy(uip_hostaddr, (addr))</span>
|
|
<a name="l00107"></a>00107 <span class="preprocessor"></span><span class="comment"></span>
|
|
<a name="l00108"></a>00108 <span class="comment">/**</span>
|
|
<a name="l00109"></a>00109 <span class="comment"> * Get the IP address of this host.</span>
|
|
<a name="l00110"></a>00110 <span class="comment"> *</span>
|
|
<a name="l00111"></a>00111 <span class="comment"> * The IP address is represented as a 4-byte array where the first</span>
|
|
<a name="l00112"></a>00112 <span class="comment"> * octet of the IP address is put in the first member of the 4-byte</span>
|
|
<a name="l00113"></a>00113 <span class="comment"> * array.</span>
|
|
<a name="l00114"></a>00114 <span class="comment"> *</span>
|
|
<a name="l00115"></a>00115 <span class="comment"> * Example:</span>
|
|
<a name="l00116"></a>00116 <span class="comment"> \code</span>
|
|
<a name="l00117"></a>00117 <span class="comment"> uip_ipaddr_t hostaddr;</span>
|
|
<a name="l00118"></a>00118 <span class="comment"></span>
|
|
<a name="l00119"></a>00119 <span class="comment"> uip_gethostaddr(&hostaddr);</span>
|
|
<a name="l00120"></a>00120 <span class="comment"> \endcode</span>
|
|
<a name="l00121"></a>00121 <span class="comment"> * \param addr A pointer to a uip_ipaddr_t variable that will be</span>
|
|
<a name="l00122"></a>00122 <span class="comment"> * filled in with the currently configured IP address.</span>
|
|
<a name="l00123"></a>00123 <span class="comment"> *</span>
|
|
<a name="l00124"></a>00124 <span class="comment"> * \hideinitializer</span>
|
|
<a name="l00125"></a>00125 <span class="comment"> */</span>
|
|
<a name="l00126"></a><a class="code" href="a00144.html#g20bc87e5c063c3f4b01547be6e5a0148">00126</a> <span class="preprocessor">#define uip_gethostaddr(addr) uip_ipaddr_copy((addr), uip_hostaddr)</span>
|
|
<a name="l00127"></a>00127 <span class="preprocessor"></span><span class="comment"></span>
|
|
<a name="l00128"></a>00128 <span class="comment">/**</span>
|
|
<a name="l00129"></a>00129 <span class="comment"> * Set the default router's IP address.</span>
|
|
<a name="l00130"></a>00130 <span class="comment"> *</span>
|
|
<a name="l00131"></a>00131 <span class="comment"> * \param addr A pointer to a uip_ipaddr_t variable containing the IP</span>
|
|
<a name="l00132"></a>00132 <span class="comment"> * address of the default router.</span>
|
|
<a name="l00133"></a>00133 <span class="comment"> *</span>
|
|
<a name="l00134"></a>00134 <span class="comment"> * \sa uip_ipaddr()</span>
|
|
<a name="l00135"></a>00135 <span class="comment"> *</span>
|
|
<a name="l00136"></a>00136 <span class="comment"> * \hideinitializer</span>
|
|
<a name="l00137"></a>00137 <span class="comment"> */</span>
|
|
<a name="l00138"></a><a class="code" href="a00144.html#g41d37ea1e3bd24f7b51e9409aceaaa80">00138</a> <span class="preprocessor">#define uip_setdraddr(addr) uip_ipaddr_copy(uip_draddr, (addr))</span>
|
|
<a name="l00139"></a>00139 <span class="preprocessor"></span><span class="comment"></span>
|
|
<a name="l00140"></a>00140 <span class="comment">/**</span>
|
|
<a name="l00141"></a>00141 <span class="comment"> * Set the netmask.</span>
|
|
<a name="l00142"></a>00142 <span class="comment"> *</span>
|
|
<a name="l00143"></a>00143 <span class="comment"> * \param addr A pointer to a uip_ipaddr_t variable containing the IP</span>
|
|
<a name="l00144"></a>00144 <span class="comment"> * address of the netmask.</span>
|
|
<a name="l00145"></a>00145 <span class="comment"> *</span>
|
|
<a name="l00146"></a>00146 <span class="comment"> * \sa uip_ipaddr()</span>
|
|
<a name="l00147"></a>00147 <span class="comment"> *</span>
|
|
<a name="l00148"></a>00148 <span class="comment"> * \hideinitializer</span>
|
|
<a name="l00149"></a>00149 <span class="comment"> */</span>
|
|
<a name="l00150"></a><a class="code" href="a00144.html#geb79c914cf137e6d27fd7583e5a66679">00150</a> <span class="preprocessor">#define uip_setnetmask(addr) uip_ipaddr_copy(uip_netmask, (addr))</span>
|
|
<a name="l00151"></a>00151 <span class="preprocessor"></span>
|
|
<a name="l00152"></a>00152 <span class="comment"></span>
|
|
<a name="l00153"></a>00153 <span class="comment">/**</span>
|
|
<a name="l00154"></a>00154 <span class="comment"> * Get the default router's IP address.</span>
|
|
<a name="l00155"></a>00155 <span class="comment"> *</span>
|
|
<a name="l00156"></a>00156 <span class="comment"> * \param addr A pointer to a uip_ipaddr_t variable that will be</span>
|
|
<a name="l00157"></a>00157 <span class="comment"> * filled in with the IP address of the default router.</span>
|
|
<a name="l00158"></a>00158 <span class="comment"> *</span>
|
|
<a name="l00159"></a>00159 <span class="comment"> * \hideinitializer</span>
|
|
<a name="l00160"></a>00160 <span class="comment"> */</span>
|
|
<a name="l00161"></a><a class="code" href="a00144.html#gd8e8bc9bc0e2ea4a24a8a024fd3a7f7c">00161</a> <span class="preprocessor">#define uip_getdraddr(addr) uip_ipaddr_copy((addr), uip_draddr)</span>
|
|
<a name="l00162"></a>00162 <span class="preprocessor"></span><span class="comment"></span>
|
|
<a name="l00163"></a>00163 <span class="comment">/**</span>
|
|
<a name="l00164"></a>00164 <span class="comment"> * Get the netmask.</span>
|
|
<a name="l00165"></a>00165 <span class="comment"> *</span>
|
|
<a name="l00166"></a>00166 <span class="comment"> * \param addr A pointer to a uip_ipaddr_t variable that will be</span>
|
|
<a name="l00167"></a>00167 <span class="comment"> * filled in with the value of the netmask.</span>
|
|
<a name="l00168"></a>00168 <span class="comment"> *</span>
|
|
<a name="l00169"></a>00169 <span class="comment"> * \hideinitializer</span>
|
|
<a name="l00170"></a>00170 <span class="comment"> */</span>
|
|
<a name="l00171"></a><a class="code" href="a00144.html#g5323320b7316647042016f17c4e881be">00171</a> <span class="preprocessor">#define uip_getnetmask(addr) uip_ipaddr_copy((addr), uip_netmask)</span>
|
|
<a name="l00172"></a>00172 <span class="preprocessor"></span><span class="comment"></span>
|
|
<a name="l00173"></a>00173 <span class="comment">/** @} */</span>
|
|
<a name="l00174"></a>00174 <span class="comment"></span>
|
|
<a name="l00175"></a>00175 <span class="comment">/**</span>
|
|
<a name="l00176"></a>00176 <span class="comment"> * \defgroup uipinit uIP initialization functions</span>
|
|
<a name="l00177"></a>00177 <span class="comment"> * @{</span>
|
|
<a name="l00178"></a>00178 <span class="comment"> *</span>
|
|
<a name="l00179"></a>00179 <span class="comment"> * The uIP initialization functions are used for booting uIP.</span>
|
|
<a name="l00180"></a>00180 <span class="comment"> */</span>
|
|
<a name="l00181"></a>00181 <span class="comment"></span>
|
|
<a name="l00182"></a>00182 <span class="comment">/**</span>
|
|
<a name="l00183"></a>00183 <span class="comment"> * uIP initialization function.</span>
|
|
<a name="l00184"></a>00184 <span class="comment"> *</span>
|
|
<a name="l00185"></a>00185 <span class="comment"> * This function should be called at boot up to initilize the uIP</span>
|
|
<a name="l00186"></a>00186 <span class="comment"> * TCP/IP stack.</span>
|
|
<a name="l00187"></a>00187 <span class="comment"> */</span>
|
|
<a name="l00188"></a>00188 <span class="keywordtype">void</span> <a class="code" href="a00145.html#gc48ed5f0d27721ef62a3ed02a5ad8d2e">uip_init</a>(<span class="keywordtype">void</span>);
|
|
<a name="l00189"></a>00189 <span class="comment"></span>
|
|
<a name="l00190"></a>00190 <span class="comment">/**</span>
|
|
<a name="l00191"></a>00191 <span class="comment"> * uIP initialization function.</span>
|
|
<a name="l00192"></a>00192 <span class="comment"> *</span>
|
|
<a name="l00193"></a>00193 <span class="comment"> * This function may be used at boot time to set the initial ip_id.</span>
|
|
<a name="l00194"></a>00194 <span class="comment"> */</span>
|
|
<a name="l00195"></a>00195 <span class="keywordtype">void</span> <a class="code" href="a00145.html#g22f140b02c354dfebcc7ad481c3bcd68">uip_setipid</a>(<a class="code" href="a00153.html#g77570ac4fcab86864fa1916e55676da2">u16_t</a> <span class="keywordtype">id</span>);
|
|
<a name="l00196"></a>00196 <span class="comment"></span>
|
|
<a name="l00197"></a>00197 <span class="comment">/** @} */</span>
|
|
<a name="l00198"></a>00198 <span class="comment"></span>
|
|
<a name="l00199"></a>00199 <span class="comment">/**</span>
|
|
<a name="l00200"></a>00200 <span class="comment"> * \defgroup uipdevfunc uIP device driver functions</span>
|
|
<a name="l00201"></a>00201 <span class="comment"> * @{</span>
|
|
<a name="l00202"></a>00202 <span class="comment"> *</span>
|
|
<a name="l00203"></a>00203 <span class="comment"> * These functions are used by a network device driver for interacting</span>
|
|
<a name="l00204"></a>00204 <span class="comment"> * with uIP.</span>
|
|
<a name="l00205"></a>00205 <span class="comment"> */</span>
|
|
<a name="l00206"></a>00206 <span class="comment"></span>
|
|
<a name="l00207"></a>00207 <span class="comment">/**</span>
|
|
<a name="l00208"></a>00208 <span class="comment"> * Process an incoming packet.</span>
|
|
<a name="l00209"></a>00209 <span class="comment"> *</span>
|
|
<a name="l00210"></a>00210 <span class="comment"> * This function should be called when the device driver has received</span>
|
|
<a name="l00211"></a>00211 <span class="comment"> * a packet from the network. The packet from the device driver must</span>
|
|
<a name="l00212"></a>00212 <span class="comment"> * be present in the uip_buf buffer, and the length of the packet</span>
|
|
<a name="l00213"></a>00213 <span class="comment"> * should be placed in the uip_len variable.</span>
|
|
<a name="l00214"></a>00214 <span class="comment"> *</span>
|
|
<a name="l00215"></a>00215 <span class="comment"> * When the function returns, there may be an outbound packet placed</span>
|
|
<a name="l00216"></a>00216 <span class="comment"> * in the uip_buf packet buffer. If so, the uip_len variable is set to</span>
|
|
<a name="l00217"></a>00217 <span class="comment"> * the length of the packet. If no packet is to be sent out, the</span>
|
|
<a name="l00218"></a>00218 <span class="comment"> * uip_len variable is set to 0.</span>
|
|
<a name="l00219"></a>00219 <span class="comment"> *</span>
|
|
<a name="l00220"></a>00220 <span class="comment"> * The usual way of calling the function is presented by the source</span>
|
|
<a name="l00221"></a>00221 <span class="comment"> * code below.</span>
|
|
<a name="l00222"></a>00222 <span class="comment"> \code</span>
|
|
<a name="l00223"></a>00223 <span class="comment"> uip_len = devicedriver_poll();</span>
|
|
<a name="l00224"></a>00224 <span class="comment"> if(uip_len > 0) {</span>
|
|
<a name="l00225"></a>00225 <span class="comment"> uip_input();</span>
|
|
<a name="l00226"></a>00226 <span class="comment"> if(uip_len > 0) {</span>
|
|
<a name="l00227"></a>00227 <span class="comment"> devicedriver_send();</span>
|
|
<a name="l00228"></a>00228 <span class="comment"> }</span>
|
|
<a name="l00229"></a>00229 <span class="comment"> }</span>
|
|
<a name="l00230"></a>00230 <span class="comment"> \endcode</span>
|
|
<a name="l00231"></a>00231 <span class="comment"> *</span>
|
|
<a name="l00232"></a>00232 <span class="comment"> * \note If you are writing a uIP device driver that needs ARP</span>
|
|
<a name="l00233"></a>00233 <span class="comment"> * (Address Resolution Protocol), e.g., when running uIP over</span>
|
|
<a name="l00234"></a>00234 <span class="comment"> * Ethernet, you will need to call the uIP ARP code before calling</span>
|
|
<a name="l00235"></a>00235 <span class="comment"> * this function:</span>
|
|
<a name="l00236"></a>00236 <span class="comment"> \code</span>
|
|
<a name="l00237"></a>00237 <span class="comment"> #define BUF ((struct uip_eth_hdr *)&uip_buf[0])</span>
|
|
<a name="l00238"></a>00238 <span class="comment"> uip_len = ethernet_devicedrver_poll();</span>
|
|
<a name="l00239"></a>00239 <span class="comment"> if(uip_len > 0) {</span>
|
|
<a name="l00240"></a>00240 <span class="comment"> if(BUF->type == HTONS(UIP_ETHTYPE_IP)) {</span>
|
|
<a name="l00241"></a>00241 <span class="comment"> uip_arp_ipin();</span>
|
|
<a name="l00242"></a>00242 <span class="comment"> uip_input();</span>
|
|
<a name="l00243"></a>00243 <span class="comment"> if(uip_len > 0) {</span>
|
|
<a name="l00244"></a>00244 <span class="comment"> uip_arp_out();</span>
|
|
<a name="l00245"></a>00245 <span class="comment"> ethernet_devicedriver_send();</span>
|
|
<a name="l00246"></a>00246 <span class="comment"> }</span>
|
|
<a name="l00247"></a>00247 <span class="comment"> } else if(BUF->type == HTONS(UIP_ETHTYPE_ARP)) {</span>
|
|
<a name="l00248"></a>00248 <span class="comment"> uip_arp_arpin();</span>
|
|
<a name="l00249"></a>00249 <span class="comment"> if(uip_len > 0) {</span>
|
|
<a name="l00250"></a>00250 <span class="comment"> ethernet_devicedriver_send();</span>
|
|
<a name="l00251"></a>00251 <span class="comment"> }</span>
|
|
<a name="l00252"></a>00252 <span class="comment"> }</span>
|
|
<a name="l00253"></a>00253 <span class="comment"> \endcode</span>
|
|
<a name="l00254"></a>00254 <span class="comment"> *</span>
|
|
<a name="l00255"></a>00255 <span class="comment"> * \hideinitializer</span>
|
|
<a name="l00256"></a>00256 <span class="comment"> */</span>
|
|
<a name="l00257"></a><a class="code" href="a00146.html#ga4360412ee9350fba725f98a137169fe">00257</a> <span class="preprocessor">#define uip_input() uip_process(UIP_DATA)</span>
|
|
<a name="l00258"></a>00258 <span class="preprocessor"></span><span class="comment"></span>
|
|
<a name="l00259"></a>00259 <span class="comment">/**</span>
|
|
<a name="l00260"></a>00260 <span class="comment"> * Periodic processing for a connection identified by its number.</span>
|
|
<a name="l00261"></a>00261 <span class="comment"> *</span>
|
|
<a name="l00262"></a>00262 <span class="comment"> * This function does the necessary periodic processing (timers,</span>
|
|
<a name="l00263"></a>00263 <span class="comment"> * polling) for a uIP TCP conneciton, and should be called when the</span>
|
|
<a name="l00264"></a>00264 <span class="comment"> * periodic uIP timer goes off. It should be called for every</span>
|
|
<a name="l00265"></a>00265 <span class="comment"> * connection, regardless of whether they are open of closed.</span>
|
|
<a name="l00266"></a>00266 <span class="comment"> *</span>
|
|
<a name="l00267"></a>00267 <span class="comment"> * When the function returns, it may have an outbound packet waiting</span>
|
|
<a name="l00268"></a>00268 <span class="comment"> * for service in the uIP packet buffer, and if so the uip_len</span>
|
|
<a name="l00269"></a>00269 <span class="comment"> * variable is set to a value larger than zero. The device driver</span>
|
|
<a name="l00270"></a>00270 <span class="comment"> * should be called to send out the packet.</span>
|
|
<a name="l00271"></a>00271 <span class="comment"> *</span>
|
|
<a name="l00272"></a>00272 <span class="comment"> * The ususal way of calling the function is through a for() loop like</span>
|
|
<a name="l00273"></a>00273 <span class="comment"> * this:</span>
|
|
<a name="l00274"></a>00274 <span class="comment"> \code</span>
|
|
<a name="l00275"></a>00275 <span class="comment"> for(i = 0; i < UIP_CONNS; ++i) {</span>
|
|
<a name="l00276"></a>00276 <span class="comment"> uip_periodic(i);</span>
|
|
<a name="l00277"></a>00277 <span class="comment"> if(uip_len > 0) {</span>
|
|
<a name="l00278"></a>00278 <span class="comment"> devicedriver_send();</span>
|
|
<a name="l00279"></a>00279 <span class="comment"> }</span>
|
|
<a name="l00280"></a>00280 <span class="comment"> }</span>
|
|
<a name="l00281"></a>00281 <span class="comment"> \endcode</span>
|
|
<a name="l00282"></a>00282 <span class="comment"> *</span>
|
|
<a name="l00283"></a>00283 <span class="comment"> * \note If you are writing a uIP device driver that needs ARP</span>
|
|
<a name="l00284"></a>00284 <span class="comment"> * (Address Resolution Protocol), e.g., when running uIP over</span>
|
|
<a name="l00285"></a>00285 <span class="comment"> * Ethernet, you will need to call the uip_arp_out() function before</span>
|
|
<a name="l00286"></a>00286 <span class="comment"> * calling the device driver:</span>
|
|
<a name="l00287"></a>00287 <span class="comment"> \code</span>
|
|
<a name="l00288"></a>00288 <span class="comment"> for(i = 0; i < UIP_CONNS; ++i) {</span>
|
|
<a name="l00289"></a>00289 <span class="comment"> uip_periodic(i);</span>
|
|
<a name="l00290"></a>00290 <span class="comment"> if(uip_len > 0) {</span>
|
|
<a name="l00291"></a>00291 <span class="comment"> uip_arp_out();</span>
|
|
<a name="l00292"></a>00292 <span class="comment"> ethernet_devicedriver_send();</span>
|
|
<a name="l00293"></a>00293 <span class="comment"> }</span>
|
|
<a name="l00294"></a>00294 <span class="comment"> }</span>
|
|
<a name="l00295"></a>00295 <span class="comment"> \endcode</span>
|
|
<a name="l00296"></a>00296 <span class="comment"> *</span>
|
|
<a name="l00297"></a>00297 <span class="comment"> * \param conn The number of the connection which is to be periodically polled.</span>
|
|
<a name="l00298"></a>00298 <span class="comment"> *</span>
|
|
<a name="l00299"></a>00299 <span class="comment"> * \hideinitializer</span>
|
|
<a name="l00300"></a>00300 <span class="comment"> */</span>
|
|
<a name="l00301"></a><a class="code" href="a00146.html#g1024f8a5fa65e82bf848b2e6590d9628">00301</a> <span class="preprocessor">#define uip_periodic(conn) do { uip_conn = &uip_conns[conn]; \</span>
|
|
<a name="l00302"></a>00302 <span class="preprocessor"> uip_process(UIP_TIMER); } while (0)</span>
|
|
<a name="l00303"></a>00303 <span class="preprocessor"></span><span class="comment"></span>
|
|
<a name="l00304"></a>00304 <span class="comment">/**</span>
|
|
<a name="l00305"></a>00305 <span class="comment"> *</span>
|
|
<a name="l00306"></a>00306 <span class="comment"> *</span>
|
|
<a name="l00307"></a>00307 <span class="comment"> */</span>
|
|
<a name="l00308"></a><a class="code" href="a00146.html#gfd5ebb56a1bd1da9878aa886a2075e80">00308</a> <span class="preprocessor">#define uip_conn_active(conn) (uip_conns[conn].tcpstateflags != UIP_CLOSED)</span>
|
|
<a name="l00309"></a>00309 <span class="preprocessor"></span><span class="comment"></span>
|
|
<a name="l00310"></a>00310 <span class="comment">/**</span>
|
|
<a name="l00311"></a>00311 <span class="comment"> * Perform periodic processing for a connection identified by a pointer</span>
|
|
<a name="l00312"></a>00312 <span class="comment"> * to its structure.</span>
|
|
<a name="l00313"></a>00313 <span class="comment"> *</span>
|
|
<a name="l00314"></a>00314 <span class="comment"> * Same as uip_periodic() but takes a pointer to the actual uip_conn</span>
|
|
<a name="l00315"></a>00315 <span class="comment"> * struct instead of an integer as its argument. This function can be</span>
|
|
<a name="l00316"></a>00316 <span class="comment"> * used to force periodic processing of a specific connection.</span>
|
|
<a name="l00317"></a>00317 <span class="comment"> *</span>
|
|
<a name="l00318"></a>00318 <span class="comment"> * \param conn A pointer to the uip_conn struct for the connection to</span>
|
|
<a name="l00319"></a>00319 <span class="comment"> * be processed.</span>
|
|
<a name="l00320"></a>00320 <span class="comment"> *</span>
|
|
<a name="l00321"></a>00321 <span class="comment"> * \hideinitializer</span>
|
|
<a name="l00322"></a>00322 <span class="comment"> */</span>
|
|
<a name="l00323"></a><a class="code" href="a00146.html#gbaf0bb2b6a4424b4eb69e45e457c2583">00323</a> <span class="preprocessor">#define uip_periodic_conn(conn) do { uip_conn = conn; \</span>
|
|
<a name="l00324"></a>00324 <span class="preprocessor"> uip_process(UIP_TIMER); } while (0)</span>
|
|
<a name="l00325"></a>00325 <span class="preprocessor"></span><span class="comment"></span>
|
|
<a name="l00326"></a>00326 <span class="comment">/**</span>
|
|
<a name="l00327"></a>00327 <span class="comment"> * Reuqest that a particular connection should be polled.</span>
|
|
<a name="l00328"></a>00328 <span class="comment"> *</span>
|
|
<a name="l00329"></a>00329 <span class="comment"> * Similar to uip_periodic_conn() but does not perform any timer</span>
|
|
<a name="l00330"></a>00330 <span class="comment"> * processing. The application is polled for new data.</span>
|
|
<a name="l00331"></a>00331 <span class="comment"> *</span>
|
|
<a name="l00332"></a>00332 <span class="comment"> * \param conn A pointer to the uip_conn struct for the connection to</span>
|
|
<a name="l00333"></a>00333 <span class="comment"> * be processed.</span>
|
|
<a name="l00334"></a>00334 <span class="comment"> *</span>
|
|
<a name="l00335"></a>00335 <span class="comment"> * \hideinitializer</span>
|
|
<a name="l00336"></a>00336 <span class="comment"> */</span>
|
|
<a name="l00337"></a><a class="code" href="a00146.html#gf20aaf4292cb0d2a1b10bc0a568b51fa">00337</a> <span class="preprocessor">#define uip_poll_conn(conn) do { uip_conn = conn; \</span>
|
|
<a name="l00338"></a>00338 <span class="preprocessor"> uip_process(UIP_POLL_REQUEST); } while (0)</span>
|
|
<a name="l00339"></a>00339 <span class="preprocessor"></span>
|
|
<a name="l00340"></a>00340
|
|
<a name="l00341"></a>00341 <span class="preprocessor">#if UIP_UDP</span>
|
|
<a name="l00342"></a>00342 <span class="preprocessor"></span><span class="comment">/**</span>
|
|
<a name="l00343"></a>00343 <span class="comment"> * Periodic processing for a UDP connection identified by its number.</span>
|
|
<a name="l00344"></a>00344 <span class="comment"> *</span>
|
|
<a name="l00345"></a>00345 <span class="comment"> * This function is essentially the same as uip_periodic(), but for</span>
|
|
<a name="l00346"></a>00346 <span class="comment"> * UDP connections. It is called in a similar fashion as the</span>
|
|
<a name="l00347"></a>00347 <span class="comment"> * uip_periodic() function:</span>
|
|
<a name="l00348"></a>00348 <span class="comment"> \code</span>
|
|
<a name="l00349"></a>00349 <span class="comment"> for(i = 0; i < UIP_UDP_CONNS; i++) {</span>
|
|
<a name="l00350"></a>00350 <span class="comment"> uip_udp_periodic(i);</span>
|
|
<a name="l00351"></a>00351 <span class="comment"> if(uip_len > 0) {</span>
|
|
<a name="l00352"></a>00352 <span class="comment"> devicedriver_send();</span>
|
|
<a name="l00353"></a>00353 <span class="comment"> }</span>
|
|
<a name="l00354"></a>00354 <span class="comment"> }</span>
|
|
<a name="l00355"></a>00355 <span class="comment"> \endcode</span>
|
|
<a name="l00356"></a>00356 <span class="comment"> *</span>
|
|
<a name="l00357"></a>00357 <span class="comment"> * \note As for the uip_periodic() function, special care has to be</span>
|
|
<a name="l00358"></a>00358 <span class="comment"> * taken when using uIP together with ARP and Ethernet:</span>
|
|
<a name="l00359"></a>00359 <span class="comment"> \code</span>
|
|
<a name="l00360"></a>00360 <span class="comment"> for(i = 0; i < UIP_UDP_CONNS; i++) {</span>
|
|
<a name="l00361"></a>00361 <span class="comment"> uip_udp_periodic(i);</span>
|
|
<a name="l00362"></a>00362 <span class="comment"> if(uip_len > 0) {</span>
|
|
<a name="l00363"></a>00363 <span class="comment"> uip_arp_out();</span>
|
|
<a name="l00364"></a>00364 <span class="comment"> ethernet_devicedriver_send();</span>
|
|
<a name="l00365"></a>00365 <span class="comment"> }</span>
|
|
<a name="l00366"></a>00366 <span class="comment"> }</span>
|
|
<a name="l00367"></a>00367 <span class="comment"> \endcode</span>
|
|
<a name="l00368"></a>00368 <span class="comment"> *</span>
|
|
<a name="l00369"></a>00369 <span class="comment"> * \param conn The number of the UDP connection to be processed.</span>
|
|
<a name="l00370"></a>00370 <span class="comment"> *</span>
|
|
<a name="l00371"></a>00371 <span class="comment"> * \hideinitializer</span>
|
|
<a name="l00372"></a>00372 <span class="comment"> */</span>
|
|
<a name="l00373"></a><a class="code" href="a00146.html#g2c64c8c36bc84f9336f6a2184ea51883">00373</a> <span class="preprocessor">#define uip_udp_periodic(conn) do { uip_udp_conn = &uip_udp_conns[conn]; \</span>
|
|
<a name="l00374"></a>00374 <span class="preprocessor"> uip_process(UIP_UDP_TIMER); } while (0)</span>
|
|
<a name="l00375"></a>00375 <span class="preprocessor"></span><span class="comment"></span>
|
|
<a name="l00376"></a>00376 <span class="comment">/**</span>
|
|
<a name="l00377"></a>00377 <span class="comment"> * Periodic processing for a UDP connection identified by a pointer to</span>
|
|
<a name="l00378"></a>00378 <span class="comment"> * its structure.</span>
|
|
<a name="l00379"></a>00379 <span class="comment"> *</span>
|
|
<a name="l00380"></a>00380 <span class="comment"> * Same as uip_udp_periodic() but takes a pointer to the actual</span>
|
|
<a name="l00381"></a>00381 <span class="comment"> * uip_conn struct instead of an integer as its argument. This</span>
|
|
<a name="l00382"></a>00382 <span class="comment"> * function can be used to force periodic processing of a specific</span>
|
|
<a name="l00383"></a>00383 <span class="comment"> * connection.</span>
|
|
<a name="l00384"></a>00384 <span class="comment"> *</span>
|
|
<a name="l00385"></a>00385 <span class="comment"> * \param conn A pointer to the uip_udp_conn struct for the connection</span>
|
|
<a name="l00386"></a>00386 <span class="comment"> * to be processed.</span>
|
|
<a name="l00387"></a>00387 <span class="comment"> *</span>
|
|
<a name="l00388"></a>00388 <span class="comment"> * \hideinitializer</span>
|
|
<a name="l00389"></a>00389 <span class="comment"> */</span>
|
|
<a name="l00390"></a><a class="code" href="a00146.html#gf5c2ad5acf3cc23b8262e9ba6a15136b">00390</a> <span class="preprocessor">#define uip_udp_periodic_conn(conn) do { uip_udp_conn = conn; \</span>
|
|
<a name="l00391"></a>00391 <span class="preprocessor"> uip_process(UIP_UDP_TIMER); } while (0)</span>
|
|
<a name="l00392"></a>00392 <span class="preprocessor"></span>
|
|
<a name="l00393"></a>00393
|
|
<a name="l00394"></a>00394 <span class="preprocessor">#endif </span><span class="comment">/* UIP_UDP */</span>
|
|
<a name="l00395"></a>00395 <span class="comment"></span>
|
|
<a name="l00396"></a>00396 <span class="comment">/**</span>
|
|
<a name="l00397"></a>00397 <span class="comment"> * The uIP packet buffer.</span>
|
|
<a name="l00398"></a>00398 <span class="comment"> *</span>
|
|
<a name="l00399"></a>00399 <span class="comment"> * The uip_buf array is used to hold incoming and outgoing</span>
|
|
<a name="l00400"></a>00400 <span class="comment"> * packets. The device driver should place incoming data into this</span>
|
|
<a name="l00401"></a>00401 <span class="comment"> * buffer. When sending data, the device driver should read the link</span>
|
|
<a name="l00402"></a>00402 <span class="comment"> * level headers and the TCP/IP headers from this buffer. The size of</span>
|
|
<a name="l00403"></a>00403 <span class="comment"> * the link level headers is configured by the UIP_LLH_LEN define.</span>
|
|
<a name="l00404"></a>00404 <span class="comment"> *</span>
|
|
<a name="l00405"></a>00405 <span class="comment"> * \note The application data need not be placed in this buffer, so</span>
|
|
<a name="l00406"></a>00406 <span class="comment"> * the device driver must read it from the place pointed to by the</span>
|
|
<a name="l00407"></a>00407 <span class="comment"> * uip_appdata pointer as illustrated by the following example:</span>
|
|
<a name="l00408"></a>00408 <span class="comment"> \code</span>
|
|
<a name="l00409"></a>00409 <span class="comment"> void</span>
|
|
<a name="l00410"></a>00410 <span class="comment"> devicedriver_send(void)</span>
|
|
<a name="l00411"></a>00411 <span class="comment"> {</span>
|
|
<a name="l00412"></a>00412 <span class="comment"> hwsend(&uip_buf[0], UIP_LLH_LEN);</span>
|
|
<a name="l00413"></a>00413 <span class="comment"> if(uip_len <= UIP_LLH_LEN + UIP_TCPIP_HLEN) {</span>
|
|
<a name="l00414"></a>00414 <span class="comment"> hwsend(&uip_buf[UIP_LLH_LEN], uip_len - UIP_LLH_LEN);</span>
|
|
<a name="l00415"></a>00415 <span class="comment"> } else {</span>
|
|
<a name="l00416"></a>00416 <span class="comment"> hwsend(&uip_buf[UIP_LLH_LEN], UIP_TCPIP_HLEN);</span>
|
|
<a name="l00417"></a>00417 <span class="comment"> hwsend(uip_appdata, uip_len - UIP_TCPIP_HLEN - UIP_LLH_LEN);</span>
|
|
<a name="l00418"></a>00418 <span class="comment"> }</span>
|
|
<a name="l00419"></a>00419 <span class="comment"> }</span>
|
|
<a name="l00420"></a>00420 <span class="comment"> \endcode</span>
|
|
<a name="l00421"></a>00421 <span class="comment"> */</span>
|
|
<a name="l00422"></a>00422 <span class="keyword">extern</span> <a class="code" href="a00153.html#g4caecabca98b43919dd11be1c0d4cd8e">u8_t</a> <a class="code" href="a00146.html#gb81e78f890dbbee50c533a9734b74fd9">uip_buf</a>[<a class="code" href="a00153.html#g3589822ecb9d9c4145209756396b8a6b">UIP_BUFSIZE</a>+2];
|
|
<a name="l00423"></a>00423 <span class="comment"></span>
|
|
<a name="l00424"></a>00424 <span class="comment">/** @} */</span>
|
|
<a name="l00425"></a>00425
|
|
<a name="l00426"></a>00426 <span class="comment">/*---------------------------------------------------------------------------*/</span>
|
|
<a name="l00427"></a>00427 <span class="comment">/* Functions that are used by the uIP application program. Opening and</span>
|
|
<a name="l00428"></a>00428 <span class="comment"> * closing connections, sending and receiving data, etc. is all</span>
|
|
<a name="l00429"></a>00429 <span class="comment"> * handled by the functions below.</span>
|
|
<a name="l00430"></a>00430 <span class="comment">*/</span><span class="comment"></span>
|
|
<a name="l00431"></a>00431 <span class="comment">/**</span>
|
|
<a name="l00432"></a>00432 <span class="comment"> * \defgroup uipappfunc uIP application functions</span>
|
|
<a name="l00433"></a>00433 <span class="comment"> * @{</span>
|
|
<a name="l00434"></a>00434 <span class="comment"> *</span>
|
|
<a name="l00435"></a>00435 <span class="comment"> * Functions used by an application running of top of uIP.</span>
|
|
<a name="l00436"></a>00436 <span class="comment"> */</span>
|
|
<a name="l00437"></a>00437 <span class="comment"></span>
|
|
<a name="l00438"></a>00438 <span class="comment">/**</span>
|
|
<a name="l00439"></a>00439 <span class="comment"> * Start listening to the specified port.</span>
|
|
<a name="l00440"></a>00440 <span class="comment"> *</span>
|
|
<a name="l00441"></a>00441 <span class="comment"> * \note Since this function expects the port number in network byte</span>
|
|
<a name="l00442"></a>00442 <span class="comment"> * order, a conversion using HTONS() or htons() is necessary.</span>
|
|
<a name="l00443"></a>00443 <span class="comment"> *</span>
|
|
<a name="l00444"></a>00444 <span class="comment"> \code</span>
|
|
<a name="l00445"></a>00445 <span class="comment"> uip_listen(HTONS(80));</span>
|
|
<a name="l00446"></a>00446 <span class="comment"> \endcode</span>
|
|
<a name="l00447"></a>00447 <span class="comment"> *</span>
|
|
<a name="l00448"></a>00448 <span class="comment"> * \param port A 16-bit port number in network byte order.</span>
|
|
<a name="l00449"></a>00449 <span class="comment"> */</span>
|
|
<a name="l00450"></a>00450 <span class="keywordtype">void</span> <a class="code" href="a00147.html#gdd1ab3704ecd4900eec61a6897d32dc8">uip_listen</a>(<a class="code" href="a00153.html#g77570ac4fcab86864fa1916e55676da2">u16_t</a> port);
|
|
<a name="l00451"></a>00451 <span class="comment"></span>
|
|
<a name="l00452"></a>00452 <span class="comment">/**</span>
|
|
<a name="l00453"></a>00453 <span class="comment"> * Stop listening to the specified port.</span>
|
|
<a name="l00454"></a>00454 <span class="comment"> *</span>
|
|
<a name="l00455"></a>00455 <span class="comment"> * \note Since this function expects the port number in network byte</span>
|
|
<a name="l00456"></a>00456 <span class="comment"> * order, a conversion using HTONS() or htons() is necessary.</span>
|
|
<a name="l00457"></a>00457 <span class="comment"> *</span>
|
|
<a name="l00458"></a>00458 <span class="comment"> \code</span>
|
|
<a name="l00459"></a>00459 <span class="comment"> uip_unlisten(HTONS(80));</span>
|
|
<a name="l00460"></a>00460 <span class="comment"> \endcode</span>
|
|
<a name="l00461"></a>00461 <span class="comment"> *</span>
|
|
<a name="l00462"></a>00462 <span class="comment"> * \param port A 16-bit port number in network byte order.</span>
|
|
<a name="l00463"></a>00463 <span class="comment"> */</span>
|
|
<a name="l00464"></a>00464 <span class="keywordtype">void</span> <a class="code" href="a00147.html#gaa585784b0914cac1d37f07f85457008">uip_unlisten</a>(<a class="code" href="a00153.html#g77570ac4fcab86864fa1916e55676da2">u16_t</a> port);
|
|
<a name="l00465"></a>00465 <span class="comment"></span>
|
|
<a name="l00466"></a>00466 <span class="comment">/**</span>
|
|
<a name="l00467"></a>00467 <span class="comment"> * Connect to a remote host using TCP.</span>
|
|
<a name="l00468"></a>00468 <span class="comment"> *</span>
|
|
<a name="l00469"></a>00469 <span class="comment"> * This function is used to start a new connection to the specified</span>
|
|
<a name="l00470"></a>00470 <span class="comment"> * port on the specied host. It allocates a new connection identifier,</span>
|
|
<a name="l00471"></a>00471 <span class="comment"> * sets the connection to the SYN_SENT state and sets the</span>
|
|
<a name="l00472"></a>00472 <span class="comment"> * retransmission timer to 0. This will cause a TCP SYN segment to be</span>
|
|
<a name="l00473"></a>00473 <span class="comment"> * sent out the next time this connection is periodically processed,</span>
|
|
<a name="l00474"></a>00474 <span class="comment"> * which usually is done within 0.5 seconds after the call to</span>
|
|
<a name="l00475"></a>00475 <span class="comment"> * uip_connect().</span>
|
|
<a name="l00476"></a>00476 <span class="comment"> *</span>
|
|
<a name="l00477"></a>00477 <span class="comment"> * \note This function is avaliable only if support for active open</span>
|
|
<a name="l00478"></a>00478 <span class="comment"> * has been configured by defining UIP_ACTIVE_OPEN to 1 in uipopt.h.</span>
|
|
<a name="l00479"></a>00479 <span class="comment"> *</span>
|
|
<a name="l00480"></a>00480 <span class="comment"> * \note Since this function requires the port number to be in network</span>
|
|
<a name="l00481"></a>00481 <span class="comment"> * byte order, a conversion using HTONS() or htons() is necessary.</span>
|
|
<a name="l00482"></a>00482 <span class="comment"> *</span>
|
|
<a name="l00483"></a>00483 <span class="comment"> \code</span>
|
|
<a name="l00484"></a>00484 <span class="comment"> uip_ipaddr_t ipaddr;</span>
|
|
<a name="l00485"></a>00485 <span class="comment"></span>
|
|
<a name="l00486"></a>00486 <span class="comment"> uip_ipaddr(&ipaddr, 192,168,1,2);</span>
|
|
<a name="l00487"></a>00487 <span class="comment"> uip_connect(&ipaddr, HTONS(80));</span>
|
|
<a name="l00488"></a>00488 <span class="comment"> \endcode</span>
|
|
<a name="l00489"></a>00489 <span class="comment"> *</span>
|
|
<a name="l00490"></a>00490 <span class="comment"> * \param ripaddr The IP address of the remote hot.</span>
|
|
<a name="l00491"></a>00491 <span class="comment"> *</span>
|
|
<a name="l00492"></a>00492 <span class="comment"> * \param port A 16-bit port number in network byte order.</span>
|
|
<a name="l00493"></a>00493 <span class="comment"> *</span>
|
|
<a name="l00494"></a>00494 <span class="comment"> * \return A pointer to the uIP connection identifier for the new connection,</span>
|
|
<a name="l00495"></a>00495 <span class="comment"> * or NULL if no connection could be allocated.</span>
|
|
<a name="l00496"></a>00496 <span class="comment"> *</span>
|
|
<a name="l00497"></a>00497 <span class="comment"> */</span>
|
|
<a name="l00498"></a>00498 <span class="keyword">struct </span><a class="code" href="a00088.html">uip_conn</a> *<a class="code" href="a00147.html#g8096b0c4b543dc408f4dd031ddae7240">uip_connect</a>(<a class="code" href="a00150.html#g1ef35301f43a5bbb9f89f07b5a36b9a0">uip_ipaddr_t</a> *<a class="code" href="a00088.html#79510aa86d3fa0a0fc6cfc49b1da7279">ripaddr</a>, <a class="code" href="a00153.html#g77570ac4fcab86864fa1916e55676da2">u16_t</a> port);
|
|
<a name="l00499"></a>00499
|
|
<a name="l00500"></a>00500
|
|
<a name="l00501"></a>00501 <span class="comment"></span>
|
|
<a name="l00502"></a>00502 <span class="comment">/**</span>
|
|
<a name="l00503"></a>00503 <span class="comment"> * \internal</span>
|
|
<a name="l00504"></a>00504 <span class="comment"> *</span>
|
|
<a name="l00505"></a>00505 <span class="comment"> * Check if a connection has outstanding (i.e., unacknowledged) data.</span>
|
|
<a name="l00506"></a>00506 <span class="comment"> *</span>
|
|
<a name="l00507"></a>00507 <span class="comment"> * \param conn A pointer to the uip_conn structure for the connection.</span>
|
|
<a name="l00508"></a>00508 <span class="comment"> *</span>
|
|
<a name="l00509"></a>00509 <span class="comment"> * \hideinitializer</span>
|
|
<a name="l00510"></a>00510 <span class="comment"> */</span>
|
|
<a name="l00511"></a><a class="code" href="a00147.html#gef14e83c046e19ab9fe9d1bbcca276c2">00511</a> <span class="preprocessor">#define uip_outstanding(conn) ((conn)->len)</span>
|
|
<a name="l00512"></a>00512 <span class="preprocessor"></span><span class="comment"></span>
|
|
<a name="l00513"></a>00513 <span class="comment">/**</span>
|
|
<a name="l00514"></a>00514 <span class="comment"> * Send data on the current connection.</span>
|
|
<a name="l00515"></a>00515 <span class="comment"> *</span>
|
|
<a name="l00516"></a>00516 <span class="comment"> * This function is used to send out a single segment of TCP</span>
|
|
<a name="l00517"></a>00517 <span class="comment"> * data. Only applications that have been invoked by uIP for event</span>
|
|
<a name="l00518"></a>00518 <span class="comment"> * processing can send data.</span>
|
|
<a name="l00519"></a>00519 <span class="comment"> *</span>
|
|
<a name="l00520"></a>00520 <span class="comment"> * The amount of data that actually is sent out after a call to this</span>
|
|
<a name="l00521"></a>00521 <span class="comment"> * funcion is determined by the maximum amount of data TCP allows. uIP</span>
|
|
<a name="l00522"></a>00522 <span class="comment"> * will automatically crop the data so that only the appropriate</span>
|
|
<a name="l00523"></a>00523 <span class="comment"> * amount of data is sent. The function uip_mss() can be used to query</span>
|
|
<a name="l00524"></a>00524 <span class="comment"> * uIP for the amount of data that actually will be sent.</span>
|
|
<a name="l00525"></a>00525 <span class="comment"> *</span>
|
|
<a name="l00526"></a>00526 <span class="comment"> * \note This function does not guarantee that the sent data will</span>
|
|
<a name="l00527"></a>00527 <span class="comment"> * arrive at the destination. If the data is lost in the network, the</span>
|
|
<a name="l00528"></a>00528 <span class="comment"> * application will be invoked with the uip_rexmit() event being</span>
|
|
<a name="l00529"></a>00529 <span class="comment"> * set. The application will then have to resend the data using this</span>
|
|
<a name="l00530"></a>00530 <span class="comment"> * function.</span>
|
|
<a name="l00531"></a>00531 <span class="comment"> *</span>
|
|
<a name="l00532"></a>00532 <span class="comment"> * \param data A pointer to the data which is to be sent.</span>
|
|
<a name="l00533"></a>00533 <span class="comment"> *</span>
|
|
<a name="l00534"></a>00534 <span class="comment"> * \param len The maximum amount of data bytes to be sent.</span>
|
|
<a name="l00535"></a>00535 <span class="comment"> *</span>
|
|
<a name="l00536"></a>00536 <span class="comment"> * \hideinitializer</span>
|
|
<a name="l00537"></a>00537 <span class="comment"> */</span>
|
|
<a name="l00538"></a>00538 <span class="keywordtype">void</span> <a class="code" href="a00147.html#g04b053a623aac7cd4195157d470661b3">uip_send</a>(<span class="keyword">const</span> <span class="keywordtype">void</span> *data, <span class="keywordtype">int</span> <a class="code" href="a00088.html#0ef3ae2764714bf90620075c374c262e">len</a>);
|
|
<a name="l00539"></a>00539 <span class="comment"></span>
|
|
<a name="l00540"></a>00540 <span class="comment">/**</span>
|
|
<a name="l00541"></a>00541 <span class="comment"> * The length of any incoming data that is currently avaliable (if avaliable)</span>
|
|
<a name="l00542"></a>00542 <span class="comment"> * in the uip_appdata buffer.</span>
|
|
<a name="l00543"></a>00543 <span class="comment"> *</span>
|
|
<a name="l00544"></a>00544 <span class="comment"> * The test function uip_data() must first be used to check if there</span>
|
|
<a name="l00545"></a>00545 <span class="comment"> * is any data available at all.</span>
|
|
<a name="l00546"></a>00546 <span class="comment"> *</span>
|
|
<a name="l00547"></a>00547 <span class="comment"> * \hideinitializer</span>
|
|
<a name="l00548"></a>00548 <span class="comment"> */</span>
|
|
<a name="l00549"></a>00549 <span class="comment">/*void uip_datalen(void);*/</span>
|
|
<a name="l00550"></a><a class="code" href="a00147.html#g1a1bc437c09ddef238abab41d77c3177">00550</a> <span class="preprocessor">#define uip_datalen() uip_len</span>
|
|
<a name="l00551"></a>00551 <span class="preprocessor"></span><span class="comment"></span>
|
|
<a name="l00552"></a>00552 <span class="comment">/**</span>
|
|
<a name="l00553"></a>00553 <span class="comment"> * The length of any out-of-band data (urgent data) that has arrived</span>
|
|
<a name="l00554"></a>00554 <span class="comment"> * on the connection.</span>
|
|
<a name="l00555"></a>00555 <span class="comment"> *</span>
|
|
<a name="l00556"></a>00556 <span class="comment"> * \note The configuration parameter UIP_URGDATA must be set for this</span>
|
|
<a name="l00557"></a>00557 <span class="comment"> * function to be enabled.</span>
|
|
<a name="l00558"></a>00558 <span class="comment"> *</span>
|
|
<a name="l00559"></a>00559 <span class="comment"> * \hideinitializer</span>
|
|
<a name="l00560"></a>00560 <span class="comment"> */</span>
|
|
<a name="l00561"></a><a class="code" href="a00147.html#g8411c95a4d89367ad2d9d6bde1a3d537">00561</a> <span class="preprocessor">#define uip_urgdatalen() uip_urglen</span>
|
|
<a name="l00562"></a>00562 <span class="preprocessor"></span><span class="comment"></span>
|
|
<a name="l00563"></a>00563 <span class="comment">/**</span>
|
|
<a name="l00564"></a>00564 <span class="comment"> * Close the current connection.</span>
|
|
<a name="l00565"></a>00565 <span class="comment"> *</span>
|
|
<a name="l00566"></a>00566 <span class="comment"> * This function will close the current connection in a nice way.</span>
|
|
<a name="l00567"></a>00567 <span class="comment"> *</span>
|
|
<a name="l00568"></a>00568 <span class="comment"> * \hideinitializer</span>
|
|
<a name="l00569"></a>00569 <span class="comment"> */</span>
|
|
<a name="l00570"></a><a class="code" href="a00147.html#g61db1dcb7c760e4dd5d60bf4e5576dca">00570</a> <span class="preprocessor">#define uip_close() (uip_flags = UIP_CLOSE)</span>
|
|
<a name="l00571"></a>00571 <span class="preprocessor"></span><span class="comment"></span>
|
|
<a name="l00572"></a>00572 <span class="comment">/**</span>
|
|
<a name="l00573"></a>00573 <span class="comment"> * Abort the current connection.</span>
|
|
<a name="l00574"></a>00574 <span class="comment"> *</span>
|
|
<a name="l00575"></a>00575 <span class="comment"> * This function will abort (reset) the current connection, and is</span>
|
|
<a name="l00576"></a>00576 <span class="comment"> * usually used when an error has occured that prevents using the</span>
|
|
<a name="l00577"></a>00577 <span class="comment"> * uip_close() function.</span>
|
|
<a name="l00578"></a>00578 <span class="comment"> *</span>
|
|
<a name="l00579"></a>00579 <span class="comment"> * \hideinitializer</span>
|
|
<a name="l00580"></a>00580 <span class="comment"> */</span>
|
|
<a name="l00581"></a><a class="code" href="a00147.html#g88d2ccf7cd821f89d9a8df7e3948b56c">00581</a> <span class="preprocessor">#define uip_abort() (uip_flags = UIP_ABORT)</span>
|
|
<a name="l00582"></a>00582 <span class="preprocessor"></span><span class="comment"></span>
|
|
<a name="l00583"></a>00583 <span class="comment">/**</span>
|
|
<a name="l00584"></a>00584 <span class="comment"> * Tell the sending host to stop sending data.</span>
|
|
<a name="l00585"></a>00585 <span class="comment"> *</span>
|
|
<a name="l00586"></a>00586 <span class="comment"> * This function will close our receiver's window so that we stop</span>
|
|
<a name="l00587"></a>00587 <span class="comment"> * receiving data for the current connection.</span>
|
|
<a name="l00588"></a>00588 <span class="comment"> *</span>
|
|
<a name="l00589"></a>00589 <span class="comment"> * \hideinitializer</span>
|
|
<a name="l00590"></a>00590 <span class="comment"> */</span>
|
|
<a name="l00591"></a><a class="code" href="a00147.html#g0a8bb9d6d0f1f56852ccfccbbad6c5d8">00591</a> <span class="preprocessor">#define uip_stop() (uip_conn->tcpstateflags |= UIP_STOPPED)</span>
|
|
<a name="l00592"></a>00592 <span class="preprocessor"></span><span class="comment"></span>
|
|
<a name="l00593"></a>00593 <span class="comment">/**</span>
|
|
<a name="l00594"></a>00594 <span class="comment"> * Find out if the current connection has been previously stopped with</span>
|
|
<a name="l00595"></a>00595 <span class="comment"> * uip_stop().</span>
|
|
<a name="l00596"></a>00596 <span class="comment"> *</span>
|
|
<a name="l00597"></a>00597 <span class="comment"> * \hideinitializer</span>
|
|
<a name="l00598"></a>00598 <span class="comment"> */</span>
|
|
<a name="l00599"></a><a class="code" href="a00147.html#g64a238a5c02640a7a4aef004163aeb47">00599</a> <span class="preprocessor">#define uip_stopped(conn) ((conn)->tcpstateflags & UIP_STOPPED)</span>
|
|
<a name="l00600"></a>00600 <span class="preprocessor"></span><span class="comment"></span>
|
|
<a name="l00601"></a>00601 <span class="comment">/**</span>
|
|
<a name="l00602"></a>00602 <span class="comment"> * Restart the current connection, if is has previously been stopped</span>
|
|
<a name="l00603"></a>00603 <span class="comment"> * with uip_stop().</span>
|
|
<a name="l00604"></a>00604 <span class="comment"> *</span>
|
|
<a name="l00605"></a>00605 <span class="comment"> * This function will open the receiver's window again so that we</span>
|
|
<a name="l00606"></a>00606 <span class="comment"> * start receiving data for the current connection.</span>
|
|
<a name="l00607"></a>00607 <span class="comment"> *</span>
|
|
<a name="l00608"></a>00608 <span class="comment"> * \hideinitializer</span>
|
|
<a name="l00609"></a>00609 <span class="comment"> */</span>
|
|
<a name="l00610"></a><a class="code" href="a00147.html#g81ac47cee1c18f6aa479044069db7ca3">00610</a> <span class="preprocessor">#define uip_restart() do { uip_flags |= UIP_NEWDATA; \</span>
|
|
<a name="l00611"></a>00611 <span class="preprocessor"> uip_conn->tcpstateflags &= ~UIP_STOPPED; \</span>
|
|
<a name="l00612"></a>00612 <span class="preprocessor"> } while(0)</span>
|
|
<a name="l00613"></a>00613 <span class="preprocessor"></span>
|
|
<a name="l00614"></a>00614
|
|
<a name="l00615"></a>00615 <span class="comment">/* uIP tests that can be made to determine in what state the current</span>
|
|
<a name="l00616"></a>00616 <span class="comment"> connection is, and what the application function should do. */</span>
|
|
<a name="l00617"></a>00617 <span class="comment"></span>
|
|
<a name="l00618"></a>00618 <span class="comment">/**</span>
|
|
<a name="l00619"></a>00619 <span class="comment"> * Is the current connection a UDP connection?</span>
|
|
<a name="l00620"></a>00620 <span class="comment"> *</span>
|
|
<a name="l00621"></a>00621 <span class="comment"> * This function checks whether the current connection is a UDP connection.</span>
|
|
<a name="l00622"></a>00622 <span class="comment"> *</span>
|
|
<a name="l00623"></a>00623 <span class="comment"> * \hideinitializer</span>
|
|
<a name="l00624"></a>00624 <span class="comment"> *</span>
|
|
<a name="l00625"></a>00625 <span class="comment"> */</span>
|
|
<a name="l00626"></a><a class="code" href="a00147.html#ga9de254b8aa308eb4aab17efdde622d2">00626</a> <span class="preprocessor">#define uip_udpconnection() (uip_conn == NULL)</span>
|
|
<a name="l00627"></a>00627 <span class="preprocessor"></span><span class="comment"></span>
|
|
<a name="l00628"></a>00628 <span class="comment">/**</span>
|
|
<a name="l00629"></a>00629 <span class="comment"> * Is new incoming data available?</span>
|
|
<a name="l00630"></a>00630 <span class="comment"> *</span>
|
|
<a name="l00631"></a>00631 <span class="comment"> * Will reduce to non-zero if there is new data for the application</span>
|
|
<a name="l00632"></a>00632 <span class="comment"> * present at the uip_appdata pointer. The size of the data is</span>
|
|
<a name="l00633"></a>00633 <span class="comment"> * avaliable through the uip_len variable.</span>
|
|
<a name="l00634"></a>00634 <span class="comment"> *</span>
|
|
<a name="l00635"></a>00635 <span class="comment"> * \hideinitializer</span>
|
|
<a name="l00636"></a>00636 <span class="comment"> */</span>
|
|
<a name="l00637"></a><a class="code" href="a00147.html#g26a14b8dae3f861830af9e7cf1e03725">00637</a> <span class="preprocessor">#define uip_newdata() (uip_flags & UIP_NEWDATA)</span>
|
|
<a name="l00638"></a>00638 <span class="preprocessor"></span><span class="comment"></span>
|
|
<a name="l00639"></a>00639 <span class="comment">/**</span>
|
|
<a name="l00640"></a>00640 <span class="comment"> * Has previously sent data been acknowledged?</span>
|
|
<a name="l00641"></a>00641 <span class="comment"> *</span>
|
|
<a name="l00642"></a>00642 <span class="comment"> * Will reduce to non-zero if the previously sent data has been</span>
|
|
<a name="l00643"></a>00643 <span class="comment"> * acknowledged by the remote host. This means that the application</span>
|
|
<a name="l00644"></a>00644 <span class="comment"> * can send new data.</span>
|
|
<a name="l00645"></a>00645 <span class="comment"> *</span>
|
|
<a name="l00646"></a>00646 <span class="comment"> * \hideinitializer</span>
|
|
<a name="l00647"></a>00647 <span class="comment"> */</span>
|
|
<a name="l00648"></a><a class="code" href="a00147.html#gde6634974418e3240c212b9b16864368">00648</a> <span class="preprocessor">#define uip_acked() (uip_flags & UIP_ACKDATA)</span>
|
|
<a name="l00649"></a>00649 <span class="preprocessor"></span><span class="comment"></span>
|
|
<a name="l00650"></a>00650 <span class="comment">/**</span>
|
|
<a name="l00651"></a>00651 <span class="comment"> * Has the connection just been connected?</span>
|
|
<a name="l00652"></a>00652 <span class="comment"> *</span>
|
|
<a name="l00653"></a>00653 <span class="comment"> * Reduces to non-zero if the current connection has been connected to</span>
|
|
<a name="l00654"></a>00654 <span class="comment"> * a remote host. This will happen both if the connection has been</span>
|
|
<a name="l00655"></a>00655 <span class="comment"> * actively opened (with uip_connect()) or passively opened (with</span>
|
|
<a name="l00656"></a>00656 <span class="comment"> * uip_listen()).</span>
|
|
<a name="l00657"></a>00657 <span class="comment"> *</span>
|
|
<a name="l00658"></a>00658 <span class="comment"> * \hideinitializer</span>
|
|
<a name="l00659"></a>00659 <span class="comment"> */</span>
|
|
<a name="l00660"></a><a class="code" href="a00147.html#gdb971fb1525d0c5002f52125b05f3218">00660</a> <span class="preprocessor">#define uip_connected() (uip_flags & UIP_CONNECTED)</span>
|
|
<a name="l00661"></a>00661 <span class="preprocessor"></span><span class="comment"></span>
|
|
<a name="l00662"></a>00662 <span class="comment">/**</span>
|
|
<a name="l00663"></a>00663 <span class="comment"> * Has the connection been closed by the other end?</span>
|
|
<a name="l00664"></a>00664 <span class="comment"> *</span>
|
|
<a name="l00665"></a>00665 <span class="comment"> * Is non-zero if the connection has been closed by the remote</span>
|
|
<a name="l00666"></a>00666 <span class="comment"> * host. The application may then do the necessary clean-ups.</span>
|
|
<a name="l00667"></a>00667 <span class="comment"> *</span>
|
|
<a name="l00668"></a>00668 <span class="comment"> * \hideinitializer</span>
|
|
<a name="l00669"></a>00669 <span class="comment"> */</span>
|
|
<a name="l00670"></a><a class="code" href="a00147.html#gef6c4140c632b6a406779342cf3b6eb6">00670</a> <span class="preprocessor">#define uip_closed() (uip_flags & UIP_CLOSE)</span>
|
|
<a name="l00671"></a>00671 <span class="preprocessor"></span><span class="comment"></span>
|
|
<a name="l00672"></a>00672 <span class="comment">/**</span>
|
|
<a name="l00673"></a>00673 <span class="comment"> * Has the connection been aborted by the other end?</span>
|
|
<a name="l00674"></a>00674 <span class="comment"> *</span>
|
|
<a name="l00675"></a>00675 <span class="comment"> * Non-zero if the current connection has been aborted (reset) by the</span>
|
|
<a name="l00676"></a>00676 <span class="comment"> * remote host.</span>
|
|
<a name="l00677"></a>00677 <span class="comment"> *</span>
|
|
<a name="l00678"></a>00678 <span class="comment"> * \hideinitializer</span>
|
|
<a name="l00679"></a>00679 <span class="comment"> */</span>
|
|
<a name="l00680"></a><a class="code" href="a00147.html#gfbd5fc486dfdf6bf6fc9db52b1f418c4">00680</a> <span class="preprocessor">#define uip_aborted() (uip_flags & UIP_ABORT)</span>
|
|
<a name="l00681"></a>00681 <span class="preprocessor"></span><span class="comment"></span>
|
|
<a name="l00682"></a>00682 <span class="comment">/**</span>
|
|
<a name="l00683"></a>00683 <span class="comment"> * Has the connection timed out?</span>
|
|
<a name="l00684"></a>00684 <span class="comment"> *</span>
|
|
<a name="l00685"></a>00685 <span class="comment"> * Non-zero if the current connection has been aborted due to too many</span>
|
|
<a name="l00686"></a>00686 <span class="comment"> * retransmissions.</span>
|
|
<a name="l00687"></a>00687 <span class="comment"> *</span>
|
|
<a name="l00688"></a>00688 <span class="comment"> * \hideinitializer</span>
|
|
<a name="l00689"></a>00689 <span class="comment"> */</span>
|
|
<a name="l00690"></a><a class="code" href="a00147.html#g7b2ac4b18bd2ac3912fe67b3b17158c3">00690</a> <span class="preprocessor">#define uip_timedout() (uip_flags & UIP_TIMEDOUT)</span>
|
|
<a name="l00691"></a>00691 <span class="preprocessor"></span><span class="comment"></span>
|
|
<a name="l00692"></a>00692 <span class="comment">/**</span>
|
|
<a name="l00693"></a>00693 <span class="comment"> * Do we need to retransmit previously data?</span>
|
|
<a name="l00694"></a>00694 <span class="comment"> *</span>
|
|
<a name="l00695"></a>00695 <span class="comment"> * Reduces to non-zero if the previously sent data has been lost in</span>
|
|
<a name="l00696"></a>00696 <span class="comment"> * the network, and the application should retransmit it. The</span>
|
|
<a name="l00697"></a>00697 <span class="comment"> * application should send the exact same data as it did the last</span>
|
|
<a name="l00698"></a>00698 <span class="comment"> * time, using the uip_send() function.</span>
|
|
<a name="l00699"></a>00699 <span class="comment"> *</span>
|
|
<a name="l00700"></a>00700 <span class="comment"> * \hideinitializer</span>
|
|
<a name="l00701"></a>00701 <span class="comment"> */</span>
|
|
<a name="l00702"></a><a class="code" href="a00147.html#ga8933ad15a2e2947dae4a5cff50e6007">00702</a> <span class="preprocessor">#define uip_rexmit() (uip_flags & UIP_REXMIT)</span>
|
|
<a name="l00703"></a>00703 <span class="preprocessor"></span><span class="comment"></span>
|
|
<a name="l00704"></a>00704 <span class="comment">/**</span>
|
|
<a name="l00705"></a>00705 <span class="comment"> * Is the connection being polled by uIP?</span>
|
|
<a name="l00706"></a>00706 <span class="comment"> *</span>
|
|
<a name="l00707"></a>00707 <span class="comment"> * Is non-zero if the reason the application is invoked is that the</span>
|
|
<a name="l00708"></a>00708 <span class="comment"> * current connection has been idle for a while and should be</span>
|
|
<a name="l00709"></a>00709 <span class="comment"> * polled.</span>
|
|
<a name="l00710"></a>00710 <span class="comment"> *</span>
|
|
<a name="l00711"></a>00711 <span class="comment"> * The polling event can be used for sending data without having to</span>
|
|
<a name="l00712"></a>00712 <span class="comment"> * wait for the remote host to send data.</span>
|
|
<a name="l00713"></a>00713 <span class="comment"> *</span>
|
|
<a name="l00714"></a>00714 <span class="comment"> * \hideinitializer</span>
|
|
<a name="l00715"></a>00715 <span class="comment"> */</span>
|
|
<a name="l00716"></a><a class="code" href="a00147.html#g58bb90796c1cdad3aac2ecf44d87b20e">00716</a> <span class="preprocessor">#define uip_poll() (uip_flags & UIP_POLL)</span>
|
|
<a name="l00717"></a>00717 <span class="preprocessor"></span><span class="comment"></span>
|
|
<a name="l00718"></a>00718 <span class="comment">/**</span>
|
|
<a name="l00719"></a>00719 <span class="comment"> * Get the initial maxium segment size (MSS) of the current</span>
|
|
<a name="l00720"></a>00720 <span class="comment"> * connection.</span>
|
|
<a name="l00721"></a>00721 <span class="comment"> *</span>
|
|
<a name="l00722"></a>00722 <span class="comment"> * \hideinitializer</span>
|
|
<a name="l00723"></a>00723 <span class="comment"> */</span>
|
|
<a name="l00724"></a><a class="code" href="a00147.html#ga87feebc7cffd4d8300e776cf64e4fec">00724</a> <span class="preprocessor">#define uip_initialmss() (uip_conn->initialmss)</span>
|
|
<a name="l00725"></a>00725 <span class="preprocessor"></span><span class="comment"></span>
|
|
<a name="l00726"></a>00726 <span class="comment">/**</span>
|
|
<a name="l00727"></a>00727 <span class="comment"> * Get the current maxium segment size that can be sent on the current</span>
|
|
<a name="l00728"></a>00728 <span class="comment"> * connection.</span>
|
|
<a name="l00729"></a>00729 <span class="comment"> *</span>
|
|
<a name="l00730"></a>00730 <span class="comment"> * The current maxiumum segment size that can be sent on the</span>
|
|
<a name="l00731"></a>00731 <span class="comment"> * connection is computed from the receiver's window and the MSS of</span>
|
|
<a name="l00732"></a>00732 <span class="comment"> * the connection (which also is available by calling</span>
|
|
<a name="l00733"></a>00733 <span class="comment"> * uip_initialmss()).</span>
|
|
<a name="l00734"></a>00734 <span class="comment"> *</span>
|
|
<a name="l00735"></a>00735 <span class="comment"> * \hideinitializer</span>
|
|
<a name="l00736"></a>00736 <span class="comment"> */</span>
|
|
<a name="l00737"></a><a class="code" href="a00147.html#gb5fecbc62edd128012cea0f47b57ab9f">00737</a> <span class="preprocessor">#define uip_mss() (uip_conn->mss)</span>
|
|
<a name="l00738"></a>00738 <span class="preprocessor"></span><span class="comment"></span>
|
|
<a name="l00739"></a>00739 <span class="comment">/**</span>
|
|
<a name="l00740"></a>00740 <span class="comment"> * Set up a new UDP connection.</span>
|
|
<a name="l00741"></a>00741 <span class="comment"> *</span>
|
|
<a name="l00742"></a>00742 <span class="comment"> * This function sets up a new UDP connection. The function will</span>
|
|
<a name="l00743"></a>00743 <span class="comment"> * automatically allocate an unused local port for the new</span>
|
|
<a name="l00744"></a>00744 <span class="comment"> * connection. However, another port can be chosen by using the</span>
|
|
<a name="l00745"></a>00745 <span class="comment"> * uip_udp_bind() call, after the uip_udp_new() function has been</span>
|
|
<a name="l00746"></a>00746 <span class="comment"> * called.</span>
|
|
<a name="l00747"></a>00747 <span class="comment"> *</span>
|
|
<a name="l00748"></a>00748 <span class="comment"> * Example:</span>
|
|
<a name="l00749"></a>00749 <span class="comment"> \code</span>
|
|
<a name="l00750"></a>00750 <span class="comment"> uip_ipaddr_t addr;</span>
|
|
<a name="l00751"></a>00751 <span class="comment"> struct uip_udp_conn *c;</span>
|
|
<a name="l00752"></a>00752 <span class="comment"> </span>
|
|
<a name="l00753"></a>00753 <span class="comment"> uip_ipaddr(&addr, 192,168,2,1);</span>
|
|
<a name="l00754"></a>00754 <span class="comment"> c = uip_udp_new(&addr, HTONS(12345));</span>
|
|
<a name="l00755"></a>00755 <span class="comment"> if(c != NULL) {</span>
|
|
<a name="l00756"></a>00756 <span class="comment"> uip_udp_bind(c, HTONS(12344));</span>
|
|
<a name="l00757"></a>00757 <span class="comment"> }</span>
|
|
<a name="l00758"></a>00758 <span class="comment"> \endcode</span>
|
|
<a name="l00759"></a>00759 <span class="comment"> * \param ripaddr The IP address of the remote host.</span>
|
|
<a name="l00760"></a>00760 <span class="comment"> *</span>
|
|
<a name="l00761"></a>00761 <span class="comment"> * \param rport The remote port number in network byte order.</span>
|
|
<a name="l00762"></a>00762 <span class="comment"> *</span>
|
|
<a name="l00763"></a>00763 <span class="comment"> * \return The uip_udp_conn structure for the new connection or NULL</span>
|
|
<a name="l00764"></a>00764 <span class="comment"> * if no connection could be allocated.</span>
|
|
<a name="l00765"></a>00765 <span class="comment"> */</span>
|
|
<a name="l00766"></a>00766 <span class="keyword">struct </span><a class="code" href="a00095.html">uip_udp_conn</a> *<a class="code" href="a00147.html#g79c4110211247df3fb30b8cf1c4c02af">uip_udp_new</a>(<a class="code" href="a00150.html#g1ef35301f43a5bbb9f89f07b5a36b9a0">uip_ipaddr_t</a> *<a class="code" href="a00095.html#8a661a2d544100b82d0d14a1985083d5">ripaddr</a>, <a class="code" href="a00153.html#g77570ac4fcab86864fa1916e55676da2">u16_t</a> <a class="code" href="a00095.html#280a0c2a93544e597f92bbacf36ee1dc">rport</a>);
|
|
<a name="l00767"></a>00767 <span class="comment"></span>
|
|
<a name="l00768"></a>00768 <span class="comment">/**</span>
|
|
<a name="l00769"></a>00769 <span class="comment"> * Removed a UDP connection.</span>
|
|
<a name="l00770"></a>00770 <span class="comment"> *</span>
|
|
<a name="l00771"></a>00771 <span class="comment"> * \param conn A pointer to the uip_udp_conn structure for the connection.</span>
|
|
<a name="l00772"></a>00772 <span class="comment"> *</span>
|
|
<a name="l00773"></a>00773 <span class="comment"> * \hideinitializer</span>
|
|
<a name="l00774"></a>00774 <span class="comment"> */</span>
|
|
<a name="l00775"></a><a class="code" href="a00147.html#gf2dbaceb10c67783a115075b5b6d66df">00775</a> <span class="preprocessor">#define uip_udp_remove(conn) (conn)->lport = 0</span>
|
|
<a name="l00776"></a>00776 <span class="preprocessor"></span><span class="comment"></span>
|
|
<a name="l00777"></a>00777 <span class="comment">/**</span>
|
|
<a name="l00778"></a>00778 <span class="comment"> * Bind a UDP connection to a local port.</span>
|
|
<a name="l00779"></a>00779 <span class="comment"> *</span>
|
|
<a name="l00780"></a>00780 <span class="comment"> * \param conn A pointer to the uip_udp_conn structure for the</span>
|
|
<a name="l00781"></a>00781 <span class="comment"> * connection.</span>
|
|
<a name="l00782"></a>00782 <span class="comment"> *</span>
|
|
<a name="l00783"></a>00783 <span class="comment"> * \param port The local port number, in network byte order.</span>
|
|
<a name="l00784"></a>00784 <span class="comment"> *</span>
|
|
<a name="l00785"></a>00785 <span class="comment"> * \hideinitializer</span>
|
|
<a name="l00786"></a>00786 <span class="comment"> */</span>
|
|
<a name="l00787"></a><a class="code" href="a00147.html#ga20812098a4663c8a9fc4ce8e95391b6">00787</a> <span class="preprocessor">#define uip_udp_bind(conn, port) (conn)->lport = port</span>
|
|
<a name="l00788"></a>00788 <span class="preprocessor"></span><span class="comment"></span>
|
|
<a name="l00789"></a>00789 <span class="comment">/**</span>
|
|
<a name="l00790"></a>00790 <span class="comment"> * Send a UDP datagram of length len on the current connection.</span>
|
|
<a name="l00791"></a>00791 <span class="comment"> *</span>
|
|
<a name="l00792"></a>00792 <span class="comment"> * This function can only be called in response to a UDP event (poll</span>
|
|
<a name="l00793"></a>00793 <span class="comment"> * or newdata). The data must be present in the uip_buf buffer, at the</span>
|
|
<a name="l00794"></a>00794 <span class="comment"> * place pointed to by the uip_appdata pointer.</span>
|
|
<a name="l00795"></a>00795 <span class="comment"> *</span>
|
|
<a name="l00796"></a>00796 <span class="comment"> * \param len The length of the data in the uip_buf buffer.</span>
|
|
<a name="l00797"></a>00797 <span class="comment"> *</span>
|
|
<a name="l00798"></a>00798 <span class="comment"> * \hideinitializer</span>
|
|
<a name="l00799"></a>00799 <span class="comment"> */</span>
|
|
<a name="l00800"></a><a class="code" href="a00147.html#ge5ab69d40013e6cf86ef1763c95d920e">00800</a> <span class="preprocessor">#define uip_udp_send(len) uip_send((char *)uip_appdata, len)</span>
|
|
<a name="l00801"></a>00801 <span class="preprocessor"></span><span class="comment"></span>
|
|
<a name="l00802"></a>00802 <span class="comment">/** @} */</span>
|
|
<a name="l00803"></a>00803
|
|
<a name="l00804"></a>00804 <span class="comment">/* uIP convenience and converting functions. */</span>
|
|
<a name="l00805"></a>00805 <span class="comment"></span>
|
|
<a name="l00806"></a>00806 <span class="comment">/**</span>
|
|
<a name="l00807"></a>00807 <span class="comment"> * \defgroup uipconvfunc uIP conversion functions</span>
|
|
<a name="l00808"></a>00808 <span class="comment"> * @{</span>
|
|
<a name="l00809"></a>00809 <span class="comment"> *</span>
|
|
<a name="l00810"></a>00810 <span class="comment"> * These functions can be used for converting between different data</span>
|
|
<a name="l00811"></a>00811 <span class="comment"> * formats used by uIP.</span>
|
|
<a name="l00812"></a>00812 <span class="comment"> */</span>
|
|
<a name="l00813"></a>00813 <span class="comment"></span>
|
|
<a name="l00814"></a>00814 <span class="comment">/**</span>
|
|
<a name="l00815"></a>00815 <span class="comment"> * Construct an IP address from four bytes.</span>
|
|
<a name="l00816"></a>00816 <span class="comment"> *</span>
|
|
<a name="l00817"></a>00817 <span class="comment"> * This function constructs an IP address of the type that uIP handles</span>
|
|
<a name="l00818"></a>00818 <span class="comment"> * internally from four bytes. The function is handy for specifying IP</span>
|
|
<a name="l00819"></a>00819 <span class="comment"> * addresses to use with e.g. the uip_connect() function.</span>
|
|
<a name="l00820"></a>00820 <span class="comment"> *</span>
|
|
<a name="l00821"></a>00821 <span class="comment"> * Example:</span>
|
|
<a name="l00822"></a>00822 <span class="comment"> \code</span>
|
|
<a name="l00823"></a>00823 <span class="comment"> uip_ipaddr_t ipaddr;</span>
|
|
<a name="l00824"></a>00824 <span class="comment"> struct uip_conn *c;</span>
|
|
<a name="l00825"></a>00825 <span class="comment"> </span>
|
|
<a name="l00826"></a>00826 <span class="comment"> uip_ipaddr(&ipaddr, 192,168,1,2);</span>
|
|
<a name="l00827"></a>00827 <span class="comment"> c = uip_connect(&ipaddr, HTONS(80));</span>
|
|
<a name="l00828"></a>00828 <span class="comment"> \endcode</span>
|
|
<a name="l00829"></a>00829 <span class="comment"> *</span>
|
|
<a name="l00830"></a>00830 <span class="comment"> * \param addr A pointer to a uip_ipaddr_t variable that will be</span>
|
|
<a name="l00831"></a>00831 <span class="comment"> * filled in with the IP address.</span>
|
|
<a name="l00832"></a>00832 <span class="comment"> *</span>
|
|
<a name="l00833"></a>00833 <span class="comment"> * \param addr0 The first octet of the IP address.</span>
|
|
<a name="l00834"></a>00834 <span class="comment"> * \param addr1 The second octet of the IP address.</span>
|
|
<a name="l00835"></a>00835 <span class="comment"> * \param addr2 The third octet of the IP address.</span>
|
|
<a name="l00836"></a>00836 <span class="comment"> * \param addr3 The forth octet of the IP address.</span>
|
|
<a name="l00837"></a>00837 <span class="comment"> *</span>
|
|
<a name="l00838"></a>00838 <span class="comment"> * \hideinitializer</span>
|
|
<a name="l00839"></a>00839 <span class="comment"> */</span>
|
|
<a name="l00840"></a><a class="code" href="a00148.html#g87f0b54ade0d159fba495089128a4932">00840</a> <span class="preprocessor">#define uip_ipaddr(addr, addr0,addr1,addr2,addr3) do { \</span>
|
|
<a name="l00841"></a>00841 <span class="preprocessor"> ((u16_t *)(addr))[0] = HTONS(((addr0) << 8) | (addr1)); \</span>
|
|
<a name="l00842"></a>00842 <span class="preprocessor"> ((u16_t *)(addr))[1] = HTONS(((addr2) << 8) | (addr3)); \</span>
|
|
<a name="l00843"></a>00843 <span class="preprocessor"> } while(0)</span>
|
|
<a name="l00844"></a>00844 <span class="preprocessor"></span><span class="comment"></span>
|
|
<a name="l00845"></a>00845 <span class="comment">/**</span>
|
|
<a name="l00846"></a>00846 <span class="comment"> * Construct an IPv6 address from eight 16-bit words.</span>
|
|
<a name="l00847"></a>00847 <span class="comment"> *</span>
|
|
<a name="l00848"></a>00848 <span class="comment"> * This function constructs an IPv6 address.</span>
|
|
<a name="l00849"></a>00849 <span class="comment"> *</span>
|
|
<a name="l00850"></a>00850 <span class="comment"> * \hideinitializer</span>
|
|
<a name="l00851"></a>00851 <span class="comment"> */</span>
|
|
<a name="l00852"></a><a class="code" href="a00148.html#g53fbda0e8c31d4882294c8dc3cb5f487">00852</a> <span class="preprocessor">#define uip_ip6addr(addr, addr0,addr1,addr2,addr3,addr4,addr5,addr6,addr7) do { \</span>
|
|
<a name="l00853"></a>00853 <span class="preprocessor"> ((u16_t *)(addr))[0] = HTONS((addr0)); \</span>
|
|
<a name="l00854"></a>00854 <span class="preprocessor"> ((u16_t *)(addr))[1] = HTONS((addr1)); \</span>
|
|
<a name="l00855"></a>00855 <span class="preprocessor"> ((u16_t *)(addr))[2] = HTONS((addr2)); \</span>
|
|
<a name="l00856"></a>00856 <span class="preprocessor"> ((u16_t *)(addr))[3] = HTONS((addr3)); \</span>
|
|
<a name="l00857"></a>00857 <span class="preprocessor"> ((u16_t *)(addr))[4] = HTONS((addr4)); \</span>
|
|
<a name="l00858"></a>00858 <span class="preprocessor"> ((u16_t *)(addr))[5] = HTONS((addr5)); \</span>
|
|
<a name="l00859"></a>00859 <span class="preprocessor"> ((u16_t *)(addr))[6] = HTONS((addr6)); \</span>
|
|
<a name="l00860"></a>00860 <span class="preprocessor"> ((u16_t *)(addr))[7] = HTONS((addr7)); \</span>
|
|
<a name="l00861"></a>00861 <span class="preprocessor"> } while(0)</span>
|
|
<a name="l00862"></a>00862 <span class="preprocessor"></span><span class="comment"></span>
|
|
<a name="l00863"></a>00863 <span class="comment">/**</span>
|
|
<a name="l00864"></a>00864 <span class="comment"> * Copy an IP address to another IP address.</span>
|
|
<a name="l00865"></a>00865 <span class="comment"> *</span>
|
|
<a name="l00866"></a>00866 <span class="comment"> * Copies an IP address from one place to another.</span>
|
|
<a name="l00867"></a>00867 <span class="comment"> *</span>
|
|
<a name="l00868"></a>00868 <span class="comment"> * Example:</span>
|
|
<a name="l00869"></a>00869 <span class="comment"> \code</span>
|
|
<a name="l00870"></a>00870 <span class="comment"> uip_ipaddr_t ipaddr1, ipaddr2;</span>
|
|
<a name="l00871"></a>00871 <span class="comment"></span>
|
|
<a name="l00872"></a>00872 <span class="comment"> uip_ipaddr(&ipaddr1, 192,16,1,2);</span>
|
|
<a name="l00873"></a>00873 <span class="comment"> uip_ipaddr_copy(&ipaddr2, &ipaddr1);</span>
|
|
<a name="l00874"></a>00874 <span class="comment"> \endcode</span>
|
|
<a name="l00875"></a>00875 <span class="comment"> *</span>
|
|
<a name="l00876"></a>00876 <span class="comment"> * \param dest The destination for the copy.</span>
|
|
<a name="l00877"></a>00877 <span class="comment"> * \param src The source from where to copy.</span>
|
|
<a name="l00878"></a>00878 <span class="comment"> *</span>
|
|
<a name="l00879"></a>00879 <span class="comment"> * \hideinitializer</span>
|
|
<a name="l00880"></a>00880 <span class="comment"> */</span>
|
|
<a name="l00881"></a>00881 <span class="preprocessor">#if !UIP_CONF_IPV6</span>
|
|
<a name="l00882"></a><a class="code" href="a00148.html#g769512993b7b27271909d6daa4748b60">00882</a> <span class="preprocessor"></span><span class="preprocessor">#define uip_ipaddr_copy(dest, src) do { \</span>
|
|
<a name="l00883"></a>00883 <span class="preprocessor"> ((u16_t *)dest)[0] = ((u16_t *)src)[0]; \</span>
|
|
<a name="l00884"></a>00884 <span class="preprocessor"> ((u16_t *)dest)[1] = ((u16_t *)src)[1]; \</span>
|
|
<a name="l00885"></a>00885 <span class="preprocessor"> } while(0)</span>
|
|
<a name="l00886"></a>00886 <span class="preprocessor"></span><span class="preprocessor">#else </span><span class="comment">/* !UIP_CONF_IPV6 */</span>
|
|
<a name="l00887"></a>00887 <span class="preprocessor">#define uip_ipaddr_copy(dest, src) memcpy(dest, src, sizeof(uip_ip6addr_t))</span>
|
|
<a name="l00888"></a>00888 <span class="preprocessor"></span><span class="preprocessor">#endif </span><span class="comment">/* !UIP_CONF_IPV6 */</span>
|
|
<a name="l00889"></a>00889 <span class="comment"></span>
|
|
<a name="l00890"></a>00890 <span class="comment">/**</span>
|
|
<a name="l00891"></a>00891 <span class="comment"> * Compare two IP addresses</span>
|
|
<a name="l00892"></a>00892 <span class="comment"> *</span>
|
|
<a name="l00893"></a>00893 <span class="comment"> * Compares two IP addresses.</span>
|
|
<a name="l00894"></a>00894 <span class="comment"> *</span>
|
|
<a name="l00895"></a>00895 <span class="comment"> * Example:</span>
|
|
<a name="l00896"></a>00896 <span class="comment"> \code</span>
|
|
<a name="l00897"></a>00897 <span class="comment"> uip_ipaddr_t ipaddr1, ipaddr2;</span>
|
|
<a name="l00898"></a>00898 <span class="comment"></span>
|
|
<a name="l00899"></a>00899 <span class="comment"> uip_ipaddr(&ipaddr1, 192,16,1,2);</span>
|
|
<a name="l00900"></a>00900 <span class="comment"> if(uip_ipaddr_cmp(&ipaddr2, &ipaddr1)) {</span>
|
|
<a name="l00901"></a>00901 <span class="comment"> printf("They are the same");</span>
|
|
<a name="l00902"></a>00902 <span class="comment"> }</span>
|
|
<a name="l00903"></a>00903 <span class="comment"> \endcode</span>
|
|
<a name="l00904"></a>00904 <span class="comment"> *</span>
|
|
<a name="l00905"></a>00905 <span class="comment"> * \param addr1 The first IP address.</span>
|
|
<a name="l00906"></a>00906 <span class="comment"> * \param addr2 The second IP address.</span>
|
|
<a name="l00907"></a>00907 <span class="comment"> *</span>
|
|
<a name="l00908"></a>00908 <span class="comment"> * \hideinitializer</span>
|
|
<a name="l00909"></a>00909 <span class="comment"> */</span>
|
|
<a name="l00910"></a>00910 <span class="preprocessor">#if !UIP_CONF_IPV6</span>
|
|
<a name="l00911"></a><a class="code" href="a00148.html#g210e629f7252e4bc8458cbdf260b3318">00911</a> <span class="preprocessor"></span><span class="preprocessor">#define uip_ipaddr_cmp(addr1, addr2) (((u16_t *)addr1)[0] == ((u16_t *)addr2)[0] && \</span>
|
|
<a name="l00912"></a>00912 <span class="preprocessor"> ((u16_t *)addr1)[1] == ((u16_t *)addr2)[1])</span>
|
|
<a name="l00913"></a>00913 <span class="preprocessor"></span><span class="preprocessor">#else </span><span class="comment">/* !UIP_CONF_IPV6 */</span>
|
|
<a name="l00914"></a>00914 <span class="preprocessor">#define uip_ipaddr_cmp(addr1, addr2) (memcmp(addr1, addr2, sizeof(uip_ip6addr_t)) == 0)</span>
|
|
<a name="l00915"></a>00915 <span class="preprocessor"></span><span class="preprocessor">#endif </span><span class="comment">/* !UIP_CONF_IPV6 */</span>
|
|
<a name="l00916"></a>00916 <span class="comment"></span>
|
|
<a name="l00917"></a>00917 <span class="comment">/**</span>
|
|
<a name="l00918"></a>00918 <span class="comment"> * Compare two IP addresses with netmasks</span>
|
|
<a name="l00919"></a>00919 <span class="comment"> *</span>
|
|
<a name="l00920"></a>00920 <span class="comment"> * Compares two IP addresses with netmasks. The masks are used to mask</span>
|
|
<a name="l00921"></a>00921 <span class="comment"> * out the bits that are to be compared.</span>
|
|
<a name="l00922"></a>00922 <span class="comment"> *</span>
|
|
<a name="l00923"></a>00923 <span class="comment"> * Example:</span>
|
|
<a name="l00924"></a>00924 <span class="comment"> \code</span>
|
|
<a name="l00925"></a>00925 <span class="comment"> uip_ipaddr_t ipaddr1, ipaddr2, mask;</span>
|
|
<a name="l00926"></a>00926 <span class="comment"></span>
|
|
<a name="l00927"></a>00927 <span class="comment"> uip_ipaddr(&mask, 255,255,255,0);</span>
|
|
<a name="l00928"></a>00928 <span class="comment"> uip_ipaddr(&ipaddr1, 192,16,1,2);</span>
|
|
<a name="l00929"></a>00929 <span class="comment"> uip_ipaddr(&ipaddr2, 192,16,1,3);</span>
|
|
<a name="l00930"></a>00930 <span class="comment"> if(uip_ipaddr_maskcmp(&ipaddr1, &ipaddr2, &mask)) {</span>
|
|
<a name="l00931"></a>00931 <span class="comment"> printf("They are the same");</span>
|
|
<a name="l00932"></a>00932 <span class="comment"> }</span>
|
|
<a name="l00933"></a>00933 <span class="comment"> \endcode</span>
|
|
<a name="l00934"></a>00934 <span class="comment"> *</span>
|
|
<a name="l00935"></a>00935 <span class="comment"> * \param addr1 The first IP address.</span>
|
|
<a name="l00936"></a>00936 <span class="comment"> * \param addr2 The second IP address.</span>
|
|
<a name="l00937"></a>00937 <span class="comment"> * \param mask The netmask.</span>
|
|
<a name="l00938"></a>00938 <span class="comment"> *</span>
|
|
<a name="l00939"></a>00939 <span class="comment"> * \hideinitializer</span>
|
|
<a name="l00940"></a>00940 <span class="comment"> */</span>
|
|
<a name="l00941"></a><a class="code" href="a00148.html#g6b16e0bac41821c1fbe0c267071642f0">00941</a> <span class="preprocessor">#define uip_ipaddr_maskcmp(addr1, addr2, mask) \</span>
|
|
<a name="l00942"></a>00942 <span class="preprocessor"> (((((u16_t *)addr1)[0] & ((u16_t *)mask)[0]) == \</span>
|
|
<a name="l00943"></a>00943 <span class="preprocessor"> (((u16_t *)addr2)[0] & ((u16_t *)mask)[0])) && \</span>
|
|
<a name="l00944"></a>00944 <span class="preprocessor"> ((((u16_t *)addr1)[1] & ((u16_t *)mask)[1]) == \</span>
|
|
<a name="l00945"></a>00945 <span class="preprocessor"> (((u16_t *)addr2)[1] & ((u16_t *)mask)[1])))</span>
|
|
<a name="l00946"></a>00946 <span class="preprocessor"></span>
|
|
<a name="l00947"></a>00947 <span class="comment"></span>
|
|
<a name="l00948"></a>00948 <span class="comment">/**</span>
|
|
<a name="l00949"></a>00949 <span class="comment"> * Mask out the network part of an IP address.</span>
|
|
<a name="l00950"></a>00950 <span class="comment"> *</span>
|
|
<a name="l00951"></a>00951 <span class="comment"> * Masks out the network part of an IP address, given the address and</span>
|
|
<a name="l00952"></a>00952 <span class="comment"> * the netmask.</span>
|
|
<a name="l00953"></a>00953 <span class="comment"> *</span>
|
|
<a name="l00954"></a>00954 <span class="comment"> * Example:</span>
|
|
<a name="l00955"></a>00955 <span class="comment"> \code</span>
|
|
<a name="l00956"></a>00956 <span class="comment"> uip_ipaddr_t ipaddr1, ipaddr2, netmask;</span>
|
|
<a name="l00957"></a>00957 <span class="comment"></span>
|
|
<a name="l00958"></a>00958 <span class="comment"> uip_ipaddr(&ipaddr1, 192,16,1,2);</span>
|
|
<a name="l00959"></a>00959 <span class="comment"> uip_ipaddr(&netmask, 255,255,255,0);</span>
|
|
<a name="l00960"></a>00960 <span class="comment"> uip_ipaddr_mask(&ipaddr2, &ipaddr1, &netmask);</span>
|
|
<a name="l00961"></a>00961 <span class="comment"> \endcode</span>
|
|
<a name="l00962"></a>00962 <span class="comment"> *</span>
|
|
<a name="l00963"></a>00963 <span class="comment"> * In the example above, the variable "ipaddr2" will contain the IP</span>
|
|
<a name="l00964"></a>00964 <span class="comment"> * address 192.168.1.0.</span>
|
|
<a name="l00965"></a>00965 <span class="comment"> *</span>
|
|
<a name="l00966"></a>00966 <span class="comment"> * \param dest Where the result is to be placed.</span>
|
|
<a name="l00967"></a>00967 <span class="comment"> * \param src The IP address.</span>
|
|
<a name="l00968"></a>00968 <span class="comment"> * \param mask The netmask.</span>
|
|
<a name="l00969"></a>00969 <span class="comment"> *</span>
|
|
<a name="l00970"></a>00970 <span class="comment"> * \hideinitializer</span>
|
|
<a name="l00971"></a>00971 <span class="comment"> */</span>
|
|
<a name="l00972"></a><a class="code" href="a00148.html#g969d7fff37a979737da045e0d538a9bd">00972</a> <span class="preprocessor">#define uip_ipaddr_mask(dest, src, mask) do { \</span>
|
|
<a name="l00973"></a>00973 <span class="preprocessor"> ((u16_t *)dest)[0] = ((u16_t *)src)[0] & ((u16_t *)mask)[0]; \</span>
|
|
<a name="l00974"></a>00974 <span class="preprocessor"> ((u16_t *)dest)[1] = ((u16_t *)src)[1] & ((u16_t *)mask)[1]; \</span>
|
|
<a name="l00975"></a>00975 <span class="preprocessor"> } while(0)</span>
|
|
<a name="l00976"></a>00976 <span class="preprocessor"></span><span class="comment"></span>
|
|
<a name="l00977"></a>00977 <span class="comment">/**</span>
|
|
<a name="l00978"></a>00978 <span class="comment"> * Pick the first octet of an IP address.</span>
|
|
<a name="l00979"></a>00979 <span class="comment"> *</span>
|
|
<a name="l00980"></a>00980 <span class="comment"> * Picks out the first octet of an IP address.</span>
|
|
<a name="l00981"></a>00981 <span class="comment"> *</span>
|
|
<a name="l00982"></a>00982 <span class="comment"> * Example:</span>
|
|
<a name="l00983"></a>00983 <span class="comment"> \code</span>
|
|
<a name="l00984"></a>00984 <span class="comment"> uip_ipaddr_t ipaddr;</span>
|
|
<a name="l00985"></a>00985 <span class="comment"> u8_t octet;</span>
|
|
<a name="l00986"></a>00986 <span class="comment"></span>
|
|
<a name="l00987"></a>00987 <span class="comment"> uip_ipaddr(&ipaddr, 1,2,3,4);</span>
|
|
<a name="l00988"></a>00988 <span class="comment"> octet = uip_ipaddr1(&ipaddr);</span>
|
|
<a name="l00989"></a>00989 <span class="comment"> \endcode</span>
|
|
<a name="l00990"></a>00990 <span class="comment"> *</span>
|
|
<a name="l00991"></a>00991 <span class="comment"> * In the example above, the variable "octet" will contain the value 1.</span>
|
|
<a name="l00992"></a>00992 <span class="comment"> *</span>
|
|
<a name="l00993"></a>00993 <span class="comment"> * \hideinitializer</span>
|
|
<a name="l00994"></a>00994 <span class="comment"> */</span>
|
|
<a name="l00995"></a><a class="code" href="a00148.html#g22fa0681cd463191d7a01fe85d86996f">00995</a> <span class="preprocessor">#define uip_ipaddr1(addr) (htons(((u16_t *)(addr))[0]) >> 8)</span>
|
|
<a name="l00996"></a>00996 <span class="preprocessor"></span><span class="comment"></span>
|
|
<a name="l00997"></a>00997 <span class="comment">/**</span>
|
|
<a name="l00998"></a>00998 <span class="comment"> * Pick the second octet of an IP address.</span>
|
|
<a name="l00999"></a>00999 <span class="comment"> *</span>
|
|
<a name="l01000"></a>01000 <span class="comment"> * Picks out the second octet of an IP address.</span>
|
|
<a name="l01001"></a>01001 <span class="comment"> *</span>
|
|
<a name="l01002"></a>01002 <span class="comment"> * Example:</span>
|
|
<a name="l01003"></a>01003 <span class="comment"> \code</span>
|
|
<a name="l01004"></a>01004 <span class="comment"> uip_ipaddr_t ipaddr;</span>
|
|
<a name="l01005"></a>01005 <span class="comment"> u8_t octet;</span>
|
|
<a name="l01006"></a>01006 <span class="comment"></span>
|
|
<a name="l01007"></a>01007 <span class="comment"> uip_ipaddr(&ipaddr, 1,2,3,4);</span>
|
|
<a name="l01008"></a>01008 <span class="comment"> octet = uip_ipaddr2(&ipaddr);</span>
|
|
<a name="l01009"></a>01009 <span class="comment"> \endcode</span>
|
|
<a name="l01010"></a>01010 <span class="comment"> *</span>
|
|
<a name="l01011"></a>01011 <span class="comment"> * In the example above, the variable "octet" will contain the value 2.</span>
|
|
<a name="l01012"></a>01012 <span class="comment"> *</span>
|
|
<a name="l01013"></a>01013 <span class="comment"> * \hideinitializer</span>
|
|
<a name="l01014"></a>01014 <span class="comment"> */</span>
|
|
<a name="l01015"></a><a class="code" href="a00148.html#gffcd2fbe181e2aaefbf970551c302af5">01015</a> <span class="preprocessor">#define uip_ipaddr2(addr) (htons(((u16_t *)(addr))[0]) & 0xff)</span>
|
|
<a name="l01016"></a>01016 <span class="preprocessor"></span><span class="comment"></span>
|
|
<a name="l01017"></a>01017 <span class="comment">/**</span>
|
|
<a name="l01018"></a>01018 <span class="comment"> * Pick the third octet of an IP address.</span>
|
|
<a name="l01019"></a>01019 <span class="comment"> *</span>
|
|
<a name="l01020"></a>01020 <span class="comment"> * Picks out the third octet of an IP address.</span>
|
|
<a name="l01021"></a>01021 <span class="comment"> *</span>
|
|
<a name="l01022"></a>01022 <span class="comment"> * Example:</span>
|
|
<a name="l01023"></a>01023 <span class="comment"> \code</span>
|
|
<a name="l01024"></a>01024 <span class="comment"> uip_ipaddr_t ipaddr;</span>
|
|
<a name="l01025"></a>01025 <span class="comment"> u8_t octet;</span>
|
|
<a name="l01026"></a>01026 <span class="comment"></span>
|
|
<a name="l01027"></a>01027 <span class="comment"> uip_ipaddr(&ipaddr, 1,2,3,4);</span>
|
|
<a name="l01028"></a>01028 <span class="comment"> octet = uip_ipaddr3(&ipaddr);</span>
|
|
<a name="l01029"></a>01029 <span class="comment"> \endcode</span>
|
|
<a name="l01030"></a>01030 <span class="comment"> *</span>
|
|
<a name="l01031"></a>01031 <span class="comment"> * In the example above, the variable "octet" will contain the value 3.</span>
|
|
<a name="l01032"></a>01032 <span class="comment"> *</span>
|
|
<a name="l01033"></a>01033 <span class="comment"> * \hideinitializer</span>
|
|
<a name="l01034"></a>01034 <span class="comment"> */</span>
|
|
<a name="l01035"></a><a class="code" href="a00148.html#ge23534479ead15af8ff08ace26a47fb5">01035</a> <span class="preprocessor">#define uip_ipaddr3(addr) (htons(((u16_t *)(addr))[1]) >> 8)</span>
|
|
<a name="l01036"></a>01036 <span class="preprocessor"></span><span class="comment"></span>
|
|
<a name="l01037"></a>01037 <span class="comment">/**</span>
|
|
<a name="l01038"></a>01038 <span class="comment"> * Pick the fourth octet of an IP address.</span>
|
|
<a name="l01039"></a>01039 <span class="comment"> *</span>
|
|
<a name="l01040"></a>01040 <span class="comment"> * Picks out the fourth octet of an IP address.</span>
|
|
<a name="l01041"></a>01041 <span class="comment"> *</span>
|
|
<a name="l01042"></a>01042 <span class="comment"> * Example:</span>
|
|
<a name="l01043"></a>01043 <span class="comment"> \code</span>
|
|
<a name="l01044"></a>01044 <span class="comment"> uip_ipaddr_t ipaddr;</span>
|
|
<a name="l01045"></a>01045 <span class="comment"> u8_t octet;</span>
|
|
<a name="l01046"></a>01046 <span class="comment"></span>
|
|
<a name="l01047"></a>01047 <span class="comment"> uip_ipaddr(&ipaddr, 1,2,3,4);</span>
|
|
<a name="l01048"></a>01048 <span class="comment"> octet = uip_ipaddr4(&ipaddr);</span>
|
|
<a name="l01049"></a>01049 <span class="comment"> \endcode</span>
|
|
<a name="l01050"></a>01050 <span class="comment"> *</span>
|
|
<a name="l01051"></a>01051 <span class="comment"> * In the example above, the variable "octet" will contain the value 4.</span>
|
|
<a name="l01052"></a>01052 <span class="comment"> *</span>
|
|
<a name="l01053"></a>01053 <span class="comment"> * \hideinitializer</span>
|
|
<a name="l01054"></a>01054 <span class="comment"> */</span>
|
|
<a name="l01055"></a><a class="code" href="a00148.html#g165b603ec150e26efec7be199c9c2901">01055</a> <span class="preprocessor">#define uip_ipaddr4(addr) (htons(((u16_t *)(addr))[1]) & 0xff)</span>
|
|
<a name="l01056"></a>01056 <span class="preprocessor"></span><span class="comment"></span>
|
|
<a name="l01057"></a>01057 <span class="comment">/**</span>
|
|
<a name="l01058"></a>01058 <span class="comment"> * Convert 16-bit quantity from host byte order to network byte order.</span>
|
|
<a name="l01059"></a>01059 <span class="comment"> *</span>
|
|
<a name="l01060"></a>01060 <span class="comment"> * This macro is primarily used for converting constants from host</span>
|
|
<a name="l01061"></a>01061 <span class="comment"> * byte order to network byte order. For converting variables to</span>
|
|
<a name="l01062"></a>01062 <span class="comment"> * network byte order, use the htons() function instead.</span>
|
|
<a name="l01063"></a>01063 <span class="comment"> *</span>
|
|
<a name="l01064"></a>01064 <span class="comment"> * \hideinitializer</span>
|
|
<a name="l01065"></a>01065 <span class="comment"> */</span>
|
|
<a name="l01066"></a>01066 <span class="preprocessor">#ifndef HTONS</span>
|
|
<a name="l01067"></a>01067 <span class="preprocessor"></span><span class="preprocessor"># if UIP_BYTE_ORDER == UIP_BIG_ENDIAN</span>
|
|
<a name="l01068"></a>01068 <span class="preprocessor"></span><span class="preprocessor"># define HTONS(n) (n)</span>
|
|
<a name="l01069"></a>01069 <span class="preprocessor"></span><span class="preprocessor"># else </span><span class="comment">/* UIP_BYTE_ORDER == UIP_BIG_ENDIAN */</span>
|
|
<a name="l01070"></a><a class="code" href="a00148.html#g69a7a4951ff21b302267532c21ee78fc">01070</a> <span class="preprocessor"># define HTONS(n) (u16_t)((((u16_t) (n)) << 8) | (((u16_t) (n)) >> 8))</span>
|
|
<a name="l01071"></a>01071 <span class="preprocessor"></span><span class="preprocessor"># endif </span><span class="comment">/* UIP_BYTE_ORDER == UIP_BIG_ENDIAN */</span>
|
|
<a name="l01072"></a>01072 <span class="preprocessor">#else</span>
|
|
<a name="l01073"></a>01073 <span class="preprocessor"></span><span class="preprocessor">#error "HTONS already defined!"</span>
|
|
<a name="l01074"></a>01074 <span class="preprocessor"></span><span class="preprocessor">#endif </span><span class="comment">/* HTONS */</span>
|
|
<a name="l01075"></a>01075 <span class="comment"></span>
|
|
<a name="l01076"></a>01076 <span class="comment">/**</span>
|
|
<a name="l01077"></a>01077 <span class="comment"> * Convert 16-bit quantity from host byte order to network byte order.</span>
|
|
<a name="l01078"></a>01078 <span class="comment"> *</span>
|
|
<a name="l01079"></a>01079 <span class="comment"> * This function is primarily used for converting variables from host</span>
|
|
<a name="l01080"></a>01080 <span class="comment"> * byte order to network byte order. For converting constants to</span>
|
|
<a name="l01081"></a>01081 <span class="comment"> * network byte order, use the HTONS() macro instead.</span>
|
|
<a name="l01082"></a>01082 <span class="comment"> */</span>
|
|
<a name="l01083"></a>01083 <span class="preprocessor">#ifndef htons</span>
|
|
<a name="l01084"></a>01084 <span class="preprocessor"></span><a class="code" href="a00153.html#g77570ac4fcab86864fa1916e55676da2">u16_t</a> <a class="code" href="a00148.html#ga22b04cac8cf283ca12f028578bebc06">htons</a>(<a class="code" href="a00153.html#g77570ac4fcab86864fa1916e55676da2">u16_t</a> val);
|
|
<a name="l01085"></a>01085 <span class="preprocessor">#endif </span><span class="comment">/* htons */</span>
|
|
<a name="l01086"></a>01086 <span class="preprocessor">#ifndef ntohs</span>
|
|
<a name="l01087"></a><a class="code" href="a00148.html#g118e9d76568ab81ad97f138d4ea1ddd2">01087</a> <span class="preprocessor"></span><span class="preprocessor">#define ntohs htons</span>
|
|
<a name="l01088"></a>01088 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
|
|
<a name="l01089"></a>01089 <span class="preprocessor"></span><span class="comment"></span>
|
|
<a name="l01090"></a>01090 <span class="comment">/** @} */</span>
|
|
<a name="l01091"></a>01091 <span class="comment"></span>
|
|
<a name="l01092"></a>01092 <span class="comment">/**</span>
|
|
<a name="l01093"></a>01093 <span class="comment"> * Pointer to the application data in the packet buffer.</span>
|
|
<a name="l01094"></a>01094 <span class="comment"> *</span>
|
|
<a name="l01095"></a>01095 <span class="comment"> * This pointer points to the application data when the application is</span>
|
|
<a name="l01096"></a>01096 <span class="comment"> * called. If the application wishes to send data, the application may</span>
|
|
<a name="l01097"></a>01097 <span class="comment"> * use this space to write the data into before calling uip_send().</span>
|
|
<a name="l01098"></a>01098 <span class="comment"> */</span>
|
|
<a name="l01099"></a>01099 <span class="keyword">extern</span> <span class="keywordtype">void</span> *<a class="code" href="a00150.html#g561b8eda32e059d4e7397f776268cc63">uip_appdata</a>;
|
|
<a name="l01100"></a>01100
|
|
<a name="l01101"></a>01101 <span class="preprocessor">#if UIP_URGDATA > 0</span>
|
|
<a name="l01102"></a>01102 <span class="preprocessor"></span><span class="comment">/* u8_t *uip_urgdata:</span>
|
|
<a name="l01103"></a>01103 <span class="comment"> *</span>
|
|
<a name="l01104"></a>01104 <span class="comment"> * This pointer points to any urgent data that has been received. Only</span>
|
|
<a name="l01105"></a>01105 <span class="comment"> * present if compiled with support for urgent data (UIP_URGDATA).</span>
|
|
<a name="l01106"></a>01106 <span class="comment"> */</span>
|
|
<a name="l01107"></a>01107 <span class="keyword">extern</span> <span class="keywordtype">void</span> *uip_urgdata;
|
|
<a name="l01108"></a>01108 <span class="preprocessor">#endif </span><span class="comment">/* UIP_URGDATA > 0 */</span>
|
|
<a name="l01109"></a>01109
|
|
<a name="l01110"></a>01110 <span class="comment"></span>
|
|
<a name="l01111"></a>01111 <span class="comment">/**</span>
|
|
<a name="l01112"></a>01112 <span class="comment"> * \defgroup uipdrivervars Variables used in uIP device drivers</span>
|
|
<a name="l01113"></a>01113 <span class="comment"> * @{</span>
|
|
<a name="l01114"></a>01114 <span class="comment"> *</span>
|
|
<a name="l01115"></a>01115 <span class="comment"> * uIP has a few global variables that are used in device drivers for</span>
|
|
<a name="l01116"></a>01116 <span class="comment"> * uIP.</span>
|
|
<a name="l01117"></a>01117 <span class="comment"> */</span>
|
|
<a name="l01118"></a>01118 <span class="comment"></span>
|
|
<a name="l01119"></a>01119 <span class="comment">/**</span>
|
|
<a name="l01120"></a>01120 <span class="comment"> * The length of the packet in the uip_buf buffer.</span>
|
|
<a name="l01121"></a>01121 <span class="comment"> *</span>
|
|
<a name="l01122"></a>01122 <span class="comment"> * The global variable uip_len holds the length of the packet in the</span>
|
|
<a name="l01123"></a>01123 <span class="comment"> * uip_buf buffer.</span>
|
|
<a name="l01124"></a>01124 <span class="comment"> *</span>
|
|
<a name="l01125"></a>01125 <span class="comment"> * When the network device driver calls the uIP input function,</span>
|
|
<a name="l01126"></a>01126 <span class="comment"> * uip_len should be set to the length of the packet in the uip_buf</span>
|
|
<a name="l01127"></a>01127 <span class="comment"> * buffer.</span>
|
|
<a name="l01128"></a>01128 <span class="comment"> *</span>
|
|
<a name="l01129"></a>01129 <span class="comment"> * When sending packets, the device driver should use the contents of</span>
|
|
<a name="l01130"></a>01130 <span class="comment"> * the uip_len variable to determine the length of the outgoing</span>
|
|
<a name="l01131"></a>01131 <span class="comment"> * packet.</span>
|
|
<a name="l01132"></a>01132 <span class="comment"> *</span>
|
|
<a name="l01133"></a>01133 <span class="comment"> */</span>
|
|
<a name="l01134"></a>01134 <span class="keyword">extern</span> <a class="code" href="a00153.html#g77570ac4fcab86864fa1916e55676da2">u16_t</a> <a class="code" href="a00149.html#g12a33f0c09711167bdf3dd7d7cf8c5a1">uip_len</a>;
|
|
<a name="l01135"></a>01135 <span class="comment"></span>
|
|
<a name="l01136"></a>01136 <span class="comment">/** @} */</span>
|
|
<a name="l01137"></a>01137
|
|
<a name="l01138"></a>01138 <span class="preprocessor">#if UIP_URGDATA > 0</span>
|
|
<a name="l01139"></a>01139 <span class="preprocessor"></span><span class="keyword">extern</span> <a class="code" href="a00153.html#g77570ac4fcab86864fa1916e55676da2">u16_t</a> uip_urglen, uip_surglen;
|
|
<a name="l01140"></a>01140 <span class="preprocessor">#endif </span><span class="comment">/* UIP_URGDATA > 0 */</span>
|
|
<a name="l01141"></a>01141
|
|
<a name="l01142"></a>01142 <span class="comment"></span>
|
|
<a name="l01143"></a>01143 <span class="comment">/**</span>
|
|
<a name="l01144"></a>01144 <span class="comment"> * Representation of a uIP TCP connection.</span>
|
|
<a name="l01145"></a>01145 <span class="comment"> *</span>
|
|
<a name="l01146"></a>01146 <span class="comment"> * The uip_conn structure is used for identifying a connection. All</span>
|
|
<a name="l01147"></a>01147 <span class="comment"> * but one field in the structure are to be considered read-only by an</span>
|
|
<a name="l01148"></a>01148 <span class="comment"> * application. The only exception is the appstate field whos purpose</span>
|
|
<a name="l01149"></a>01149 <span class="comment"> * is to let the application store application-specific state (e.g.,</span>
|
|
<a name="l01150"></a>01150 <span class="comment"> * file pointers) for the connection. The type of this field is</span>
|
|
<a name="l01151"></a>01151 <span class="comment"> * configured in the "uipopt.h" header file.</span>
|
|
<a name="l01152"></a>01152 <span class="comment"> */</span>
|
|
<a name="l01153"></a><a class="code" href="a00088.html">01153</a> <span class="keyword">struct </span><a class="code" href="a00088.html">uip_conn</a> {
|
|
<a name="l01154"></a><a class="code" href="a00088.html#79510aa86d3fa0a0fc6cfc49b1da7279">01154</a> <a class="code" href="a00150.html#g1ef35301f43a5bbb9f89f07b5a36b9a0">uip_ipaddr_t</a> <a class="code" href="a00088.html#79510aa86d3fa0a0fc6cfc49b1da7279">ripaddr</a>; <span class="comment">/**< The IP address of the remote host. */</span>
|
|
<a name="l01155"></a>01155
|
|
<a name="l01156"></a><a class="code" href="a00088.html#0cd09beee671e7e9efb0b4aced10249e">01156</a> <a class="code" href="a00153.html#g77570ac4fcab86864fa1916e55676da2">u16_t</a> <a class="code" href="a00088.html#0cd09beee671e7e9efb0b4aced10249e">lport</a>; <span class="comment">/**< The local TCP port, in network byte order. */</span>
|
|
<a name="l01157"></a><a class="code" href="a00088.html#1df6aa054ef2fa634ac4c6f418228285">01157</a> <a class="code" href="a00153.html#g77570ac4fcab86864fa1916e55676da2">u16_t</a> <a class="code" href="a00088.html#1df6aa054ef2fa634ac4c6f418228285">rport</a>; <span class="comment">/**< The local remote TCP port, in network byte</span>
|
|
<a name="l01158"></a>01158 <span class="comment"> order. */</span>
|
|
<a name="l01159"></a>01159
|
|
<a name="l01160"></a><a class="code" href="a00088.html#70297b3e6d4eaae7bd828cb50bd1efe3">01160</a> <a class="code" href="a00153.html#g4caecabca98b43919dd11be1c0d4cd8e">u8_t</a> <a class="code" href="a00088.html#70297b3e6d4eaae7bd828cb50bd1efe3">rcv_nxt</a>[4]; <span class="comment">/**< The sequence number that we expect to</span>
|
|
<a name="l01161"></a>01161 <span class="comment"> receive next. */</span>
|
|
<a name="l01162"></a><a class="code" href="a00088.html#8f6b08a5ba2a8d75ca7279e2056aa8c6">01162</a> <a class="code" href="a00153.html#g4caecabca98b43919dd11be1c0d4cd8e">u8_t</a> <a class="code" href="a00088.html#8f6b08a5ba2a8d75ca7279e2056aa8c6">snd_nxt</a>[4]; <span class="comment">/**< The sequence number that was last sent by</span>
|
|
<a name="l01163"></a>01163 <span class="comment"> us. */</span>
|
|
<a name="l01164"></a><a class="code" href="a00088.html#0ef3ae2764714bf90620075c374c262e">01164</a> <a class="code" href="a00153.html#g77570ac4fcab86864fa1916e55676da2">u16_t</a> <a class="code" href="a00088.html#0ef3ae2764714bf90620075c374c262e">len</a>; <span class="comment">/**< Length of the data that was previously sent. */</span>
|
|
<a name="l01165"></a><a class="code" href="a00088.html#3347ef1b6e8581402445d1a0280c7a14">01165</a> <a class="code" href="a00153.html#g77570ac4fcab86864fa1916e55676da2">u16_t</a> <a class="code" href="a00088.html#3347ef1b6e8581402445d1a0280c7a14">mss</a>; <span class="comment">/**< Current maximum segment size for the</span>
|
|
<a name="l01166"></a>01166 <span class="comment"> connection. */</span>
|
|
<a name="l01167"></a><a class="code" href="a00088.html#db7a3fadb68df5fdd37e8b91a2c751ea">01167</a> <a class="code" href="a00153.html#g77570ac4fcab86864fa1916e55676da2">u16_t</a> <a class="code" href="a00088.html#db7a3fadb68df5fdd37e8b91a2c751ea">initialmss</a>; <span class="comment">/**< Initial maximum segment size for the</span>
|
|
<a name="l01168"></a>01168 <span class="comment"> connection. */</span>
|
|
<a name="l01169"></a><a class="code" href="a00088.html#ef661afb3aa82f0437d2ed8d3c20be76">01169</a> <a class="code" href="a00153.html#g4caecabca98b43919dd11be1c0d4cd8e">u8_t</a> <a class="code" href="a00088.html#ef661afb3aa82f0437d2ed8d3c20be76">sa</a>; <span class="comment">/**< Retransmission time-out calculation state</span>
|
|
<a name="l01170"></a>01170 <span class="comment"> variable. */</span>
|
|
<a name="l01171"></a><a class="code" href="a00088.html#eb9fcbd3c9b0a795dcd63f33c323d65c">01171</a> <a class="code" href="a00153.html#g4caecabca98b43919dd11be1c0d4cd8e">u8_t</a> <a class="code" href="a00088.html#eb9fcbd3c9b0a795dcd63f33c323d65c">sv</a>; <span class="comment">/**< Retransmission time-out calculation state</span>
|
|
<a name="l01172"></a>01172 <span class="comment"> variable. */</span>
|
|
<a name="l01173"></a><a class="code" href="a00088.html#e3aa9cc25e45b663e6aabc54c013019e">01173</a> <a class="code" href="a00153.html#g4caecabca98b43919dd11be1c0d4cd8e">u8_t</a> <a class="code" href="a00088.html#e3aa9cc25e45b663e6aabc54c013019e">rto</a>; <span class="comment">/**< Retransmission time-out. */</span>
|
|
<a name="l01174"></a><a class="code" href="a00088.html#a5f58074435cdc180f17de69651beebd">01174</a> <a class="code" href="a00153.html#g4caecabca98b43919dd11be1c0d4cd8e">u8_t</a> <a class="code" href="a00088.html#a5f58074435cdc180f17de69651beebd">tcpstateflags</a>; <span class="comment">/**< TCP state and flags. */</span>
|
|
<a name="l01175"></a><a class="code" href="a00088.html#2d9732cf5752d30bd11cb25dc7d0c8d3">01175</a> <a class="code" href="a00153.html#g4caecabca98b43919dd11be1c0d4cd8e">u8_t</a> <a class="code" href="a00087.html">timer</a>; <span class="comment">/**< The retransmission timer. */</span>
|
|
<a name="l01176"></a><a class="code" href="a00088.html#4289c59840b128f2f6526e9da2711d47">01176</a> <a class="code" href="a00153.html#g4caecabca98b43919dd11be1c0d4cd8e">u8_t</a> <a class="code" href="a00088.html#4289c59840b128f2f6526e9da2711d47">nrtx</a>; <span class="comment">/**< The number of retransmissions for the last</span>
|
|
<a name="l01177"></a>01177 <span class="comment"> segment sent. */</span>
|
|
<a name="l01178"></a>01178 <span class="comment"></span>
|
|
<a name="l01179"></a>01179 <span class="comment"> /** The application state. */</span>
|
|
<a name="l01180"></a><a class="code" href="a00088.html#97f9e1fda815bfb8b1f4577c355ade20">01180</a> <a class="code" href="a00085.html">uip_tcp_appstate_t</a> <a class="code" href="a00088.html#97f9e1fda815bfb8b1f4577c355ade20">appstate</a>;
|
|
<a name="l01181"></a>01181 };
|
|
<a name="l01182"></a>01182
|
|
<a name="l01183"></a>01183 <span class="comment"></span>
|
|
<a name="l01184"></a>01184 <span class="comment">/**</span>
|
|
<a name="l01185"></a>01185 <span class="comment"> * Pointer to the current TCP connection.</span>
|
|
<a name="l01186"></a>01186 <span class="comment"> *</span>
|
|
<a name="l01187"></a>01187 <span class="comment"> * The uip_conn pointer can be used to access the current TCP</span>
|
|
<a name="l01188"></a>01188 <span class="comment"> * connection.</span>
|
|
<a name="l01189"></a>01189 <span class="comment"> */</span>
|
|
<a name="l01190"></a>01190 <span class="keyword">extern</span> <span class="keyword">struct </span><a class="code" href="a00088.html">uip_conn</a> *<a class="code" href="a00088.html">uip_conn</a>;
|
|
<a name="l01191"></a>01191 <span class="comment">/* The array containing all uIP connections. */</span>
|
|
<a name="l01192"></a>01192 <span class="keyword">extern</span> <span class="keyword">struct </span><a class="code" href="a00150.html#g788ffac72342f6172343d7f8099cbe1a">uip_conn</a> <a class="code" href="a00150.html#gf703683056d2bfa5c81fa157dcb20fe2">uip_conns</a>[<a class="code" href="a00153.html#gf5fe83be78b78b9e7d9e7f1e34ab1cc5">UIP_CONNS</a>];<span class="comment"></span>
|
|
<a name="l01193"></a>01193 <span class="comment">/**</span>
|
|
<a name="l01194"></a>01194 <span class="comment"> * \addtogroup uiparch</span>
|
|
<a name="l01195"></a>01195 <span class="comment"> * @{</span>
|
|
<a name="l01196"></a>01196 <span class="comment"> */</span>
|
|
<a name="l01197"></a>01197 <span class="comment"></span>
|
|
<a name="l01198"></a>01198 <span class="comment">/**</span>
|
|
<a name="l01199"></a>01199 <span class="comment"> * 4-byte array used for the 32-bit sequence number calculations.</span>
|
|
<a name="l01200"></a>01200 <span class="comment"> */</span>
|
|
<a name="l01201"></a>01201 <span class="keyword">extern</span> <a class="code" href="a00153.html#g4caecabca98b43919dd11be1c0d4cd8e">u8_t</a> <a class="code" href="a00151.html#g2a0cf5d86c58fab216414ce59bf1fea1">uip_acc32</a>[4];
|
|
<a name="l01202"></a>01202 <span class="comment"></span>
|
|
<a name="l01203"></a>01203 <span class="comment">/** @} */</span>
|
|
<a name="l01204"></a>01204
|
|
<a name="l01205"></a>01205
|
|
<a name="l01206"></a>01206 <span class="preprocessor">#if UIP_UDP</span>
|
|
<a name="l01207"></a>01207 <span class="preprocessor"></span><span class="comment">/**</span>
|
|
<a name="l01208"></a>01208 <span class="comment"> * Representation of a uIP UDP connection.</span>
|
|
<a name="l01209"></a>01209 <span class="comment"> */</span>
|
|
<a name="l01210"></a><a class="code" href="a00095.html">01210</a> <span class="keyword">struct </span><a class="code" href="a00095.html">uip_udp_conn</a> {
|
|
<a name="l01211"></a><a class="code" href="a00095.html#8a661a2d544100b82d0d14a1985083d5">01211</a> <a class="code" href="a00150.html#g1ef35301f43a5bbb9f89f07b5a36b9a0">uip_ipaddr_t</a> <a class="code" href="a00095.html#8a661a2d544100b82d0d14a1985083d5">ripaddr</a>; <span class="comment">/**< The IP address of the remote peer. */</span>
|
|
<a name="l01212"></a><a class="code" href="a00095.html#981392e295db4d024eea95805c51c371">01212</a> <a class="code" href="a00153.html#g77570ac4fcab86864fa1916e55676da2">u16_t</a> <a class="code" href="a00095.html#981392e295db4d024eea95805c51c371">lport</a>; <span class="comment">/**< The local port number in network byte order. */</span>
|
|
<a name="l01213"></a><a class="code" href="a00095.html#280a0c2a93544e597f92bbacf36ee1dc">01213</a> <a class="code" href="a00153.html#g77570ac4fcab86864fa1916e55676da2">u16_t</a> <a class="code" href="a00095.html#280a0c2a93544e597f92bbacf36ee1dc">rport</a>; <span class="comment">/**< The remote port number in network byte order. */</span>
|
|
<a name="l01214"></a><a class="code" href="a00095.html#4da1d7815516cd2b5bda3a66fdf05198">01214</a> <a class="code" href="a00153.html#g4caecabca98b43919dd11be1c0d4cd8e">u8_t</a> <a class="code" href="a00095.html#4da1d7815516cd2b5bda3a66fdf05198">ttl</a>; <span class="comment">/**< Default time-to-live. */</span>
|
|
<a name="l01215"></a>01215 <span class="comment"></span>
|
|
<a name="l01216"></a>01216 <span class="comment"> /** The application state. */</span>
|
|
<a name="l01217"></a><a class="code" href="a00095.html#c8afa29e0aa5e789d6929b366d98ba56">01217</a> <a class="code" href="a00153.html#ga92afb113e122f860392bfbd385f842e">uip_udp_appstate_t</a> <a class="code" href="a00095.html#c8afa29e0aa5e789d6929b366d98ba56">appstate</a>;
|
|
<a name="l01218"></a>01218 };
|
|
<a name="l01219"></a>01219 <span class="comment"></span>
|
|
<a name="l01220"></a>01220 <span class="comment">/**</span>
|
|
<a name="l01221"></a>01221 <span class="comment"> * The current UDP connection.</span>
|
|
<a name="l01222"></a>01222 <span class="comment"> */</span>
|
|
<a name="l01223"></a>01223 <span class="keyword">extern</span> <span class="keyword">struct </span><a class="code" href="a00095.html">uip_udp_conn</a> *<a class="code" href="a00095.html">uip_udp_conn</a>;
|
|
<a name="l01224"></a>01224 <span class="keyword">extern</span> <span class="keyword">struct </span><a class="code" href="a00150.html#g210f227119fc972e6222c9cb452e15a9">uip_udp_conn</a> <a class="code" href="a00150.html#geb533744817cf6695d75293369c2248b">uip_udp_conns</a>[<a class="code" href="a00153.html#g196379ceb1219a99f4495e41ccc9bbfb">UIP_UDP_CONNS</a>];
|
|
<a name="l01225"></a>01225 <span class="preprocessor">#endif </span><span class="comment">/* UIP_UDP */</span>
|
|
<a name="l01226"></a>01226 <span class="comment"></span>
|
|
<a name="l01227"></a>01227 <span class="comment">/**</span>
|
|
<a name="l01228"></a>01228 <span class="comment"> * The structure holding the TCP/IP statistics that are gathered if</span>
|
|
<a name="l01229"></a>01229 <span class="comment"> * UIP_STATISTICS is set to 1.</span>
|
|
<a name="l01230"></a>01230 <span class="comment"> *</span>
|
|
<a name="l01231"></a>01231 <span class="comment"> */</span>
|
|
<a name="l01232"></a><a class="code" href="a00093.html">01232</a> <span class="keyword">struct </span><a class="code" href="a00093.html">uip_stats</a> {
|
|
<a name="l01233"></a>01233 <span class="keyword">struct </span>{
|
|
<a name="l01234"></a><a class="code" href="a00093.html#5d8996950cdf3d8130cc3ad340eb9dff">01234</a> <a class="code" href="a00153.html#g727459e5c4f777543c81ffffa3df3f0c">uip_stats_t</a> <a class="code" href="a00093.html#5d8996950cdf3d8130cc3ad340eb9dff">drop</a>; <span class="comment">/**< Number of dropped packets at the IP</span>
|
|
<a name="l01235"></a>01235 <span class="comment"> layer. */</span>
|
|
<a name="l01236"></a><a class="code" href="a00093.html#7f7bb2145afba5df00c6e10ddefa8ae1">01236</a> <a class="code" href="a00153.html#g727459e5c4f777543c81ffffa3df3f0c">uip_stats_t</a> <a class="code" href="a00093.html#7f7bb2145afba5df00c6e10ddefa8ae1">recv</a>; <span class="comment">/**< Number of received packets at the IP</span>
|
|
<a name="l01237"></a>01237 <span class="comment"> layer. */</span>
|
|
<a name="l01238"></a><a class="code" href="a00093.html#dc69abadd5aa07c7d74f9292db2cd93c">01238</a> <a class="code" href="a00153.html#g727459e5c4f777543c81ffffa3df3f0c">uip_stats_t</a> <a class="code" href="a00093.html#dc69abadd5aa07c7d74f9292db2cd93c">sent</a>; <span class="comment">/**< Number of sent packets at the IP</span>
|
|
<a name="l01239"></a>01239 <span class="comment"> layer. */</span>
|
|
<a name="l01240"></a><a class="code" href="a00093.html#b93e351c3abba0c700b26b7b07e9527d">01240</a> <a class="code" href="a00153.html#g727459e5c4f777543c81ffffa3df3f0c">uip_stats_t</a> <a class="code" href="a00093.html#b93e351c3abba0c700b26b7b07e9527d">vhlerr</a>; <span class="comment">/**< Number of packets dropped due to wrong</span>
|
|
<a name="l01241"></a>01241 <span class="comment"> IP version or header length. */</span>
|
|
<a name="l01242"></a><a class="code" href="a00093.html#0c816f34c0187f2154c91a18d3ad87c8">01242</a> <a class="code" href="a00153.html#g727459e5c4f777543c81ffffa3df3f0c">uip_stats_t</a> <a class="code" href="a00093.html#0c816f34c0187f2154c91a18d3ad87c8">hblenerr</a>; <span class="comment">/**< Number of packets dropped due to wrong</span>
|
|
<a name="l01243"></a>01243 <span class="comment"> IP length, high byte. */</span>
|
|
<a name="l01244"></a><a class="code" href="a00093.html#6157452bdc9921f44b2e22e4b5969258">01244</a> <a class="code" href="a00153.html#g727459e5c4f777543c81ffffa3df3f0c">uip_stats_t</a> <a class="code" href="a00093.html#6157452bdc9921f44b2e22e4b5969258">lblenerr</a>; <span class="comment">/**< Number of packets dropped due to wrong</span>
|
|
<a name="l01245"></a>01245 <span class="comment"> IP length, low byte. */</span>
|
|
<a name="l01246"></a><a class="code" href="a00093.html#8082509468b2ac80ed7746aa1a5bc4f7">01246</a> <a class="code" href="a00153.html#g727459e5c4f777543c81ffffa3df3f0c">uip_stats_t</a> <a class="code" href="a00093.html#8082509468b2ac80ed7746aa1a5bc4f7">fragerr</a>; <span class="comment">/**< Number of packets dropped since they</span>
|
|
<a name="l01247"></a>01247 <span class="comment"> were IP fragments. */</span>
|
|
<a name="l01248"></a><a class="code" href="a00093.html#7675e6b9adbddbd545d3aac8ca092fbb">01248</a> <a class="code" href="a00153.html#g727459e5c4f777543c81ffffa3df3f0c">uip_stats_t</a> <a class="code" href="a00093.html#7675e6b9adbddbd545d3aac8ca092fbb">chkerr</a>; <span class="comment">/**< Number of packets dropped due to IP</span>
|
|
<a name="l01249"></a>01249 <span class="comment"> checksum errors. */</span>
|
|
<a name="l01250"></a><a class="code" href="a00093.html#b4622e2599ff3a592db09219b2641682">01250</a> <a class="code" href="a00153.html#g727459e5c4f777543c81ffffa3df3f0c">uip_stats_t</a> <a class="code" href="a00093.html#b4622e2599ff3a592db09219b2641682">protoerr</a>; <span class="comment">/**< Number of packets dropped since they</span>
|
|
<a name="l01251"></a>01251 <span class="comment"> were neither ICMP, UDP nor TCP. */</span>
|
|
<a name="l01252"></a>01252 } <a class="code" href="a00093.html#1deb2899508216804823498a69378118">ip</a>; <span class="comment">/**< IP statistics. */</span>
|
|
<a name="l01253"></a>01253 <span class="keyword">struct </span>{
|
|
<a name="l01254"></a>01254 <a class="code" href="a00153.html#g727459e5c4f777543c81ffffa3df3f0c">uip_stats_t</a> <a class="code" href="a00093.html#5d8996950cdf3d8130cc3ad340eb9dff">drop</a>; <span class="comment">/**< Number of dropped ICMP packets. */</span>
|
|
<a name="l01255"></a>01255 <a class="code" href="a00153.html#g727459e5c4f777543c81ffffa3df3f0c">uip_stats_t</a> <a class="code" href="a00093.html#7f7bb2145afba5df00c6e10ddefa8ae1">recv</a>; <span class="comment">/**< Number of received ICMP packets. */</span>
|
|
<a name="l01256"></a>01256 <a class="code" href="a00153.html#g727459e5c4f777543c81ffffa3df3f0c">uip_stats_t</a> <a class="code" href="a00093.html#dc69abadd5aa07c7d74f9292db2cd93c">sent</a>; <span class="comment">/**< Number of sent ICMP packets. */</span>
|
|
<a name="l01257"></a><a class="code" href="a00093.html#8da121d6e50992ec55778f9b2141552d">01257</a> <a class="code" href="a00153.html#g727459e5c4f777543c81ffffa3df3f0c">uip_stats_t</a> <a class="code" href="a00093.html#8da121d6e50992ec55778f9b2141552d">typeerr</a>; <span class="comment">/**< Number of ICMP packets with a wrong</span>
|
|
<a name="l01258"></a>01258 <span class="comment"> type. */</span>
|
|
<a name="l01259"></a>01259 } <a class="code" href="a00093.html#3983b45977630418d3038231aa8b68ed">icmp</a>; <span class="comment">/**< ICMP statistics. */</span>
|
|
<a name="l01260"></a>01260 <span class="keyword">struct </span>{
|
|
<a name="l01261"></a>01261 <a class="code" href="a00153.html#g727459e5c4f777543c81ffffa3df3f0c">uip_stats_t</a> <a class="code" href="a00093.html#5d8996950cdf3d8130cc3ad340eb9dff">drop</a>; <span class="comment">/**< Number of dropped TCP segments. */</span>
|
|
<a name="l01262"></a>01262 <a class="code" href="a00153.html#g727459e5c4f777543c81ffffa3df3f0c">uip_stats_t</a> <a class="code" href="a00093.html#7f7bb2145afba5df00c6e10ddefa8ae1">recv</a>; <span class="comment">/**< Number of recived TCP segments. */</span>
|
|
<a name="l01263"></a>01263 <a class="code" href="a00153.html#g727459e5c4f777543c81ffffa3df3f0c">uip_stats_t</a> <a class="code" href="a00093.html#dc69abadd5aa07c7d74f9292db2cd93c">sent</a>; <span class="comment">/**< Number of sent TCP segments. */</span>
|
|
<a name="l01264"></a>01264 <a class="code" href="a00153.html#g727459e5c4f777543c81ffffa3df3f0c">uip_stats_t</a> <a class="code" href="a00093.html#7675e6b9adbddbd545d3aac8ca092fbb">chkerr</a>; <span class="comment">/**< Number of TCP segments with a bad</span>
|
|
<a name="l01265"></a>01265 <span class="comment"> checksum. */</span>
|
|
<a name="l01266"></a><a class="code" href="a00093.html#7a58d95f7f7827789ff52500e3d16c34">01266</a> <a class="code" href="a00153.html#g727459e5c4f777543c81ffffa3df3f0c">uip_stats_t</a> <a class="code" href="a00093.html#7a58d95f7f7827789ff52500e3d16c34">ackerr</a>; <span class="comment">/**< Number of TCP segments with a bad ACK</span>
|
|
<a name="l01267"></a>01267 <span class="comment"> number. */</span>
|
|
<a name="l01268"></a><a class="code" href="a00093.html#b6e9a75167bdddd561373bc5b6ef501c">01268</a> <a class="code" href="a00153.html#g727459e5c4f777543c81ffffa3df3f0c">uip_stats_t</a> <a class="code" href="a00093.html#b6e9a75167bdddd561373bc5b6ef501c">rst</a>; <span class="comment">/**< Number of recevied TCP RST (reset) segments. */</span>
|
|
<a name="l01269"></a><a class="code" href="a00093.html#3ad48284f7a91f78bb24096aad89056e">01269</a> <a class="code" href="a00153.html#g727459e5c4f777543c81ffffa3df3f0c">uip_stats_t</a> <a class="code" href="a00093.html#3ad48284f7a91f78bb24096aad89056e">rexmit</a>; <span class="comment">/**< Number of retransmitted TCP segments. */</span>
|
|
<a name="l01270"></a><a class="code" href="a00093.html#494ea6767a8a8fab7abe96b799d6c3b3">01270</a> <a class="code" href="a00153.html#g727459e5c4f777543c81ffffa3df3f0c">uip_stats_t</a> <a class="code" href="a00093.html#494ea6767a8a8fab7abe96b799d6c3b3">syndrop</a>; <span class="comment">/**< Number of dropped SYNs due to too few</span>
|
|
<a name="l01271"></a>01271 <span class="comment"> connections was avaliable. */</span>
|
|
<a name="l01272"></a><a class="code" href="a00093.html#e9205a565ea3c911a785fc4e87c91a58">01272</a> <a class="code" href="a00153.html#g727459e5c4f777543c81ffffa3df3f0c">uip_stats_t</a> <a class="code" href="a00093.html#e9205a565ea3c911a785fc4e87c91a58">synrst</a>; <span class="comment">/**< Number of SYNs for closed ports,</span>
|
|
<a name="l01273"></a>01273 <span class="comment"> triggering a RST. */</span>
|
|
<a name="l01274"></a>01274 } <a class="code" href="a00093.html#e292b8977f6b81265bf14e1676face3e">tcp</a>; <span class="comment">/**< TCP statistics. */</span>
|
|
<a name="l01275"></a>01275 <span class="preprocessor">#if UIP_UDP</span>
|
|
<a name="l01276"></a>01276 <span class="preprocessor"></span> <span class="keyword">struct </span>{
|
|
<a name="l01277"></a>01277 <a class="code" href="a00153.html#g727459e5c4f777543c81ffffa3df3f0c">uip_stats_t</a> <a class="code" href="a00093.html#5d8996950cdf3d8130cc3ad340eb9dff">drop</a>; <span class="comment">/**< Number of dropped UDP segments. */</span>
|
|
<a name="l01278"></a>01278 <a class="code" href="a00153.html#g727459e5c4f777543c81ffffa3df3f0c">uip_stats_t</a> <a class="code" href="a00093.html#7f7bb2145afba5df00c6e10ddefa8ae1">recv</a>; <span class="comment">/**< Number of recived UDP segments. */</span>
|
|
<a name="l01279"></a>01279 <a class="code" href="a00153.html#g727459e5c4f777543c81ffffa3df3f0c">uip_stats_t</a> <a class="code" href="a00093.html#dc69abadd5aa07c7d74f9292db2cd93c">sent</a>; <span class="comment">/**< Number of sent UDP segments. */</span>
|
|
<a name="l01280"></a>01280 <a class="code" href="a00153.html#g727459e5c4f777543c81ffffa3df3f0c">uip_stats_t</a> <a class="code" href="a00093.html#7675e6b9adbddbd545d3aac8ca092fbb">chkerr</a>; <span class="comment">/**< Number of UDP segments with a bad</span>
|
|
<a name="l01281"></a>01281 <span class="comment"> checksum. */</span>
|
|
<a name="l01282"></a>01282 } <a class="code" href="a00093.html#4f39f0fe6a820d260fe6cddf9ccaa832">udp</a>; <span class="comment">/**< UDP statistics. */</span>
|
|
<a name="l01283"></a>01283 <span class="preprocessor">#endif </span><span class="comment">/* UIP_UDP */</span>
|
|
<a name="l01284"></a>01284 };
|
|
<a name="l01285"></a>01285 <span class="comment"></span>
|
|
<a name="l01286"></a>01286 <span class="comment">/**</span>
|
|
<a name="l01287"></a>01287 <span class="comment"> * The uIP TCP/IP statistics.</span>
|
|
<a name="l01288"></a>01288 <span class="comment"> *</span>
|
|
<a name="l01289"></a>01289 <span class="comment"> * This is the variable in which the uIP TCP/IP statistics are gathered.</span>
|
|
<a name="l01290"></a>01290 <span class="comment"> */</span>
|
|
<a name="l01291"></a>01291 <span class="keyword">extern</span> <span class="keyword">struct </span><a class="code" href="a00093.html">uip_stats</a> <a class="code" href="a00150.html#g9ee50a40597e67fce96541ab56c3b712">uip_stat</a>;
|
|
<a name="l01292"></a>01292
|
|
<a name="l01293"></a>01293
|
|
<a name="l01294"></a>01294 <span class="comment">/*---------------------------------------------------------------------------*/</span>
|
|
<a name="l01295"></a>01295 <span class="comment">/* All the stuff below this point is internal to uIP and should not be</span>
|
|
<a name="l01296"></a>01296 <span class="comment"> * used directly by an application or by a device driver.</span>
|
|
<a name="l01297"></a>01297 <span class="comment"> */</span>
|
|
<a name="l01298"></a>01298 <span class="comment">/*---------------------------------------------------------------------------*/</span>
|
|
<a name="l01299"></a>01299 <span class="comment">/* u8_t uip_flags:</span>
|
|
<a name="l01300"></a>01300 <span class="comment"> *</span>
|
|
<a name="l01301"></a>01301 <span class="comment"> * When the application is called, uip_flags will contain the flags</span>
|
|
<a name="l01302"></a>01302 <span class="comment"> * that are defined in this file. Please read below for more</span>
|
|
<a name="l01303"></a>01303 <span class="comment"> * infomation.</span>
|
|
<a name="l01304"></a>01304 <span class="comment"> */</span>
|
|
<a name="l01305"></a>01305 <span class="keyword">extern</span> <a class="code" href="a00153.html#g4caecabca98b43919dd11be1c0d4cd8e">u8_t</a> <a class="code" href="a00150.html#gb4ef6b00924990e7a293f66715b6d1d1">uip_flags</a>;
|
|
<a name="l01306"></a>01306
|
|
<a name="l01307"></a>01307 <span class="comment">/* The following flags may be set in the global variable uip_flags</span>
|
|
<a name="l01308"></a>01308 <span class="comment"> before calling the application callback. The UIP_ACKDATA,</span>
|
|
<a name="l01309"></a>01309 <span class="comment"> UIP_NEWDATA, and UIP_CLOSE flags may both be set at the same time,</span>
|
|
<a name="l01310"></a>01310 <span class="comment"> whereas the others are mutualy exclusive. Note that these flags</span>
|
|
<a name="l01311"></a>01311 <span class="comment"> should *NOT* be accessed directly, but only through the uIP</span>
|
|
<a name="l01312"></a>01312 <span class="comment"> functions/macros. */</span>
|
|
<a name="l01313"></a>01313
|
|
<a name="l01314"></a><a class="code" href="a00150.html#g6bfa488f87f68a6f7f4a3efb9e45eaf8">01314</a> <span class="preprocessor">#define UIP_ACKDATA 1 </span><span class="comment">/* Signifies that the outstanding data was</span>
|
|
<a name="l01315"></a>01315 <span class="comment"> acked and the application should send</span>
|
|
<a name="l01316"></a>01316 <span class="comment"> out new data instead of retransmitting</span>
|
|
<a name="l01317"></a>01317 <span class="comment"> the last data. */</span>
|
|
<a name="l01318"></a><a class="code" href="a00150.html#g39ce739bd352d7e348e37395ce903e43">01318</a> <span class="preprocessor">#define UIP_NEWDATA 2 </span><span class="comment">/* Flags the fact that the peer has sent</span>
|
|
<a name="l01319"></a>01319 <span class="comment"> us new data. */</span>
|
|
<a name="l01320"></a><a class="code" href="a00150.html#gf848ce44c810492e7a35c2d23a429f45">01320</a> <span class="preprocessor">#define UIP_REXMIT 4 </span><span class="comment">/* Tells the application to retransmit the</span>
|
|
<a name="l01321"></a>01321 <span class="comment"> data that was last sent. */</span>
|
|
<a name="l01322"></a><a class="code" href="a00150.html#gf0ed78fd2be24d849cdd5af75e3b2674">01322</a> <span class="preprocessor">#define UIP_POLL 8 </span><span class="comment">/* Used for polling the application, to</span>
|
|
<a name="l01323"></a>01323 <span class="comment"> check if the application has data that</span>
|
|
<a name="l01324"></a>01324 <span class="comment"> it wants to send. */</span>
|
|
<a name="l01325"></a><a class="code" href="a00150.html#g57e6dc1d58a36d0ed53a3dd29ccc5798">01325</a> <span class="preprocessor">#define UIP_CLOSE 16 </span><span class="comment">/* The remote host has closed the</span>
|
|
<a name="l01326"></a>01326 <span class="comment"> connection, thus the connection has</span>
|
|
<a name="l01327"></a>01327 <span class="comment"> gone away. Or the application signals</span>
|
|
<a name="l01328"></a>01328 <span class="comment"> that it wants to close the</span>
|
|
<a name="l01329"></a>01329 <span class="comment"> connection. */</span>
|
|
<a name="l01330"></a><a class="code" href="a00150.html#ga4c4310e54f18541b09e1e251fe7b22d">01330</a> <span class="preprocessor">#define UIP_ABORT 32 </span><span class="comment">/* The remote host has aborted the</span>
|
|
<a name="l01331"></a>01331 <span class="comment"> connection, thus the connection has</span>
|
|
<a name="l01332"></a>01332 <span class="comment"> gone away. Or the application signals</span>
|
|
<a name="l01333"></a>01333 <span class="comment"> that it wants to abort the</span>
|
|
<a name="l01334"></a>01334 <span class="comment"> connection. */</span>
|
|
<a name="l01335"></a><a class="code" href="a00150.html#gf84316f469ce0726985c0702db49a989">01335</a> <span class="preprocessor">#define UIP_CONNECTED 64 </span><span class="comment">/* We have got a connection from a remote</span>
|
|
<a name="l01336"></a>01336 <span class="comment"> host and have set up a new connection</span>
|
|
<a name="l01337"></a>01337 <span class="comment"> for it, or an active connection has</span>
|
|
<a name="l01338"></a>01338 <span class="comment"> been successfully established. */</span>
|
|
<a name="l01339"></a>01339
|
|
<a name="l01340"></a><a class="code" href="a00150.html#g2d3ba4b14d6d2f6576f9b547800b7945">01340</a> <span class="preprocessor">#define UIP_TIMEDOUT 128 </span><span class="comment">/* The connection has been aborted due to</span>
|
|
<a name="l01341"></a>01341 <span class="comment"> too many retransmissions. */</span>
|
|
<a name="l01342"></a>01342
|
|
<a name="l01343"></a>01343 <span class="comment">/* uip_process(flag):</span>
|
|
<a name="l01344"></a>01344 <span class="comment"> *</span>
|
|
<a name="l01345"></a>01345 <span class="comment"> * The actual uIP function which does all the work.</span>
|
|
<a name="l01346"></a>01346 <span class="comment"> */</span>
|
|
<a name="l01347"></a>01347 <span class="keywordtype">void</span> <a class="code" href="a00150.html#g266263ac78a1361a2b1d15741d3b0675">uip_process</a>(<a class="code" href="a00153.html#g4caecabca98b43919dd11be1c0d4cd8e">u8_t</a> flag);
|
|
<a name="l01348"></a>01348
|
|
<a name="l01349"></a>01349 <span class="comment">/* The following flags are passed as an argument to the uip_process()</span>
|
|
<a name="l01350"></a>01350 <span class="comment"> function. They are used to distinguish between the two cases where</span>
|
|
<a name="l01351"></a>01351 <span class="comment"> uip_process() is called. It can be called either because we have</span>
|
|
<a name="l01352"></a>01352 <span class="comment"> incoming data that should be processed, or because the periodic</span>
|
|
<a name="l01353"></a>01353 <span class="comment"> timer has fired. These values are never used directly, but only in</span>
|
|
<a name="l01354"></a>01354 <span class="comment"> the macrose defined in this file. */</span>
|
|
<a name="l01355"></a>01355
|
|
<a name="l01356"></a><a class="code" href="a00150.html#gabc40c09f49d15acb1b1a7f02bb3a807">01356</a> <span class="preprocessor">#define UIP_DATA 1 </span><span class="comment">/* Tells uIP that there is incoming</span>
|
|
<a name="l01357"></a>01357 <span class="comment"> data in the uip_buf buffer. The</span>
|
|
<a name="l01358"></a>01358 <span class="comment"> length of the data is stored in the</span>
|
|
<a name="l01359"></a>01359 <span class="comment"> global variable uip_len. */</span>
|
|
<a name="l01360"></a><a class="code" href="a00150.html#g041aea91aa6ef84dcc6cac3c51db9b2f">01360</a> <span class="preprocessor">#define UIP_TIMER 2 </span><span class="comment">/* Tells uIP that the periodic timer</span>
|
|
<a name="l01361"></a>01361 <span class="comment"> has fired. */</span>
|
|
<a name="l01362"></a><a class="code" href="a00150.html#gd605357e29affb0d3104294c90f09905">01362</a> <span class="preprocessor">#define UIP_POLL_REQUEST 3 </span><span class="comment">/* Tells uIP that a connection should</span>
|
|
<a name="l01363"></a>01363 <span class="comment"> be polled. */</span>
|
|
<a name="l01364"></a><a class="code" href="a00150.html#g5c97ae587595b5444be80f5ecc1d3382">01364</a> <span class="preprocessor">#define UIP_UDP_SEND_CONN 4 </span><span class="comment">/* Tells uIP that a UDP datagram</span>
|
|
<a name="l01365"></a>01365 <span class="comment"> should be constructed in the</span>
|
|
<a name="l01366"></a>01366 <span class="comment"> uip_buf buffer. */</span>
|
|
<a name="l01367"></a>01367 <span class="preprocessor">#if UIP_UDP</span>
|
|
<a name="l01368"></a><a class="code" href="a00150.html#gf0ccbc3bb2a3ba1ebc255c7b3fcedd24">01368</a> <span class="preprocessor"></span><span class="preprocessor">#define UIP_UDP_TIMER 5</span>
|
|
<a name="l01369"></a>01369 <span class="preprocessor"></span><span class="preprocessor">#endif </span><span class="comment">/* UIP_UDP */</span>
|
|
<a name="l01370"></a>01370
|
|
<a name="l01371"></a>01371 <span class="comment">/* The TCP states used in the uip_conn->tcpstateflags. */</span>
|
|
<a name="l01372"></a><a class="code" href="a00150.html#g28eda870cff3d8e3cf2949e6f57a502b">01372</a> <span class="preprocessor">#define UIP_CLOSED 0</span>
|
|
<a name="l01373"></a><a class="code" href="a00150.html#ga5e3c856b86725125d19fccc34cd9eb5">01373</a> <span class="preprocessor"></span><span class="preprocessor">#define UIP_SYN_RCVD 1</span>
|
|
<a name="l01374"></a><a class="code" href="a00150.html#g8af482dec973db57d8b3bd3f69461488">01374</a> <span class="preprocessor"></span><span class="preprocessor">#define UIP_SYN_SENT 2</span>
|
|
<a name="l01375"></a><a class="code" href="a00150.html#gae59b70658f28ee6e998eaaab05e423f">01375</a> <span class="preprocessor"></span><span class="preprocessor">#define UIP_ESTABLISHED 3</span>
|
|
<a name="l01376"></a><a class="code" href="a00150.html#ga533c394b1fa0030205534befa31c525">01376</a> <span class="preprocessor"></span><span class="preprocessor">#define UIP_FIN_WAIT_1 4</span>
|
|
<a name="l01377"></a><a class="code" href="a00150.html#g160128ab5d2ea3cc497b91ee4eb4ef99">01377</a> <span class="preprocessor"></span><span class="preprocessor">#define UIP_FIN_WAIT_2 5</span>
|
|
<a name="l01378"></a><a class="code" href="a00150.html#g64d9affc680a445d708234e70450477b">01378</a> <span class="preprocessor"></span><span class="preprocessor">#define UIP_CLOSING 6</span>
|
|
<a name="l01379"></a><a class="code" href="a00150.html#gfff0ed43201bf1e2020de1a0d6cac070">01379</a> <span class="preprocessor"></span><span class="preprocessor">#define UIP_TIME_WAIT 7</span>
|
|
<a name="l01380"></a><a class="code" href="a00150.html#gd135fb0cfdfb2c212f0f51865a3640e4">01380</a> <span class="preprocessor"></span><span class="preprocessor">#define UIP_LAST_ACK 8</span>
|
|
<a name="l01381"></a><a class="code" href="a00150.html#g13dfcb4a5f920e108253ade527a66cc2">01381</a> <span class="preprocessor"></span><span class="preprocessor">#define UIP_TS_MASK 15</span>
|
|
<a name="l01382"></a>01382 <span class="preprocessor"></span>
|
|
<a name="l01383"></a><a class="code" href="a00150.html#gde29ec025e6754afd8cc24c954a8dec8">01383</a> <span class="preprocessor">#define UIP_STOPPED 16</span>
|
|
<a name="l01384"></a>01384 <span class="preprocessor"></span>
|
|
<a name="l01385"></a>01385 <span class="comment">/* The TCP and IP headers. */</span>
|
|
<a name="l01386"></a><a class="code" href="a00094.html">01386</a> <span class="keyword">struct </span><a class="code" href="a00094.html">uip_tcpip_hdr</a> {
|
|
<a name="l01387"></a>01387 <span class="preprocessor">#if UIP_CONF_IPV6</span>
|
|
<a name="l01388"></a>01388 <span class="preprocessor"></span> <span class="comment">/* IPv6 header. */</span>
|
|
<a name="l01389"></a>01389 <a class="code" href="a00153.html#g4caecabca98b43919dd11be1c0d4cd8e">u8_t</a> vtc,
|
|
<a name="l01390"></a>01390 tcflow;
|
|
<a name="l01391"></a>01391 <a class="code" href="a00153.html#g77570ac4fcab86864fa1916e55676da2">u16_t</a> flow;
|
|
<a name="l01392"></a>01392 <a class="code" href="a00153.html#g4caecabca98b43919dd11be1c0d4cd8e">u8_t</a> <a class="code" href="a00094.html#e57281f5bef284bc9545834ef8ed4a96">len</a>[2];
|
|
<a name="l01393"></a>01393 <a class="code" href="a00153.html#g4caecabca98b43919dd11be1c0d4cd8e">u8_t</a> <a class="code" href="a00094.html#e45b31a0a277dd5325ad2a332358b21b">proto</a>, <a class="code" href="a00094.html#0f27e16ddcf7199d514968204966f559">ttl</a>;
|
|
<a name="l01394"></a>01394 <a class="code" href="a00150.html#g9ebb4dac683163840eab9c6c41ad61f7">uip_ip6addr_t</a> <a class="code" href="a00094.html#c8f124419a231f38bb6cdf5041757a27">srcipaddr</a>, <a class="code" href="a00094.html#8d4e08d051b35b1c710c3be5b8bbfa05">destipaddr</a>;
|
|
<a name="l01395"></a>01395 <span class="preprocessor">#else </span><span class="comment">/* UIP_CONF_IPV6 */</span>
|
|
<a name="l01396"></a>01396 <span class="comment">/* IPv4 header. */</span>
|
|
<a name="l01397"></a><a class="code" href="a00094.html#e1e60d56ea87dfa09230e25ca5ecf2fc">01397</a> <a class="code" href="a00153.html#g4caecabca98b43919dd11be1c0d4cd8e">u8_t</a> <a class="code" href="a00094.html#e1e60d56ea87dfa09230e25ca5ecf2fc">vhl</a>,
|
|
<a name="l01398"></a>01398 <a class="code" href="a00094.html#8cf0ca17b115ff2e3071b3fabcc43b53">tos</a>,
|
|
<a name="l01399"></a>01399 <a class="code" href="a00094.html#e57281f5bef284bc9545834ef8ed4a96">len</a>[2],
|
|
<a name="l01400"></a>01400 <a class="code" href="a00094.html#7a59f0dad059786238d8ab604630e7f3">ipid</a>[2],
|
|
<a name="l01401"></a>01401 <a class="code" href="a00094.html#85d7f35662f7be20cd84e789a290dd4b">ipoffset</a>[2],
|
|
<a name="l01402"></a>01402 <a class="code" href="a00094.html#0f27e16ddcf7199d514968204966f559">ttl</a>,
|
|
<a name="l01403"></a>01403 <a class="code" href="a00094.html#e45b31a0a277dd5325ad2a332358b21b">proto</a>;
|
|
<a name="l01404"></a><a class="code" href="a00094.html#af7a8a5310ad945de38f5b3ac755ae7d">01404</a> <a class="code" href="a00153.html#g77570ac4fcab86864fa1916e55676da2">u16_t</a> <a class="code" href="a00094.html#af7a8a5310ad945de38f5b3ac755ae7d">ipchksum</a>;
|
|
<a name="l01405"></a><a class="code" href="a00094.html#c8f124419a231f38bb6cdf5041757a27">01405</a> <a class="code" href="a00153.html#g77570ac4fcab86864fa1916e55676da2">u16_t</a> <a class="code" href="a00094.html#c8f124419a231f38bb6cdf5041757a27">srcipaddr</a>[2],
|
|
<a name="l01406"></a>01406 <a class="code" href="a00094.html#8d4e08d051b35b1c710c3be5b8bbfa05">destipaddr</a>[2];
|
|
<a name="l01407"></a>01407 <span class="preprocessor">#endif </span><span class="comment">/* UIP_CONF_IPV6 */</span>
|
|
<a name="l01408"></a>01408
|
|
<a name="l01409"></a>01409 <span class="comment">/* TCP header. */</span>
|
|
<a name="l01410"></a><a class="code" href="a00094.html#a81fff4836049cb3c018304d77337554">01410</a> <a class="code" href="a00153.html#g77570ac4fcab86864fa1916e55676da2">u16_t</a> <a class="code" href="a00094.html#a81fff4836049cb3c018304d77337554">srcport</a>,
|
|
<a name="l01411"></a>01411 <a class="code" href="a00094.html#025ffa46b799fa6952719c499a3ae17c">destport</a>;
|
|
<a name="l01412"></a><a class="code" href="a00094.html#7f0ab3fe3bcf1e3ed9f5950cb4474ec1">01412</a> <a class="code" href="a00153.html#g4caecabca98b43919dd11be1c0d4cd8e">u8_t</a> <a class="code" href="a00094.html#2541fae506eb111ff1be2372e0919839">seqno</a>[4],
|
|
<a name="l01413"></a>01413 <a class="code" href="a00094.html#71721395f1c7c42b8bcc111b339bea7c">ackno</a>[4],
|
|
<a name="l01414"></a>01414 <a class="code" href="a00094.html#6af8a59d0ab8967aacea749d6e59ac90">tcpoffset</a>,
|
|
<a name="l01415"></a>01415 <a class="code" href="a00094.html#619d9755a5d4aaabdb2e5e6ea4c1e0bf">flags</a>,
|
|
<a name="l01416"></a>01416 <a class="code" href="a00094.html#7f0ab3fe3bcf1e3ed9f5950cb4474ec1">wnd</a>[2];
|
|
<a name="l01417"></a><a class="code" href="a00094.html#f4a1d8cfbe270393a2de02b0c743e474">01417</a> <a class="code" href="a00153.html#g77570ac4fcab86864fa1916e55676da2">u16_t</a> <a class="code" href="a00094.html#f4a1d8cfbe270393a2de02b0c743e474">tcpchksum</a>;
|
|
<a name="l01418"></a><a class="code" href="a00094.html#dc7001682017599549f57771f4cd1b9a">01418</a> <a class="code" href="a00153.html#g4caecabca98b43919dd11be1c0d4cd8e">u8_t</a> <a class="code" href="a00094.html#dc7001682017599549f57771f4cd1b9a">urgp</a>[2];
|
|
<a name="l01419"></a><a class="code" href="a00094.html#dde3cf9a57445814d01b3c67da08afdb">01419</a> <a class="code" href="a00153.html#g4caecabca98b43919dd11be1c0d4cd8e">u8_t</a> <a class="code" href="a00094.html#dde3cf9a57445814d01b3c67da08afdb">optdata</a>[4];
|
|
<a name="l01420"></a>01420 };
|
|
<a name="l01421"></a>01421
|
|
<a name="l01422"></a>01422 <span class="comment">/* The ICMP and IP headers. */</span>
|
|
<a name="l01423"></a><a class="code" href="a00091.html">01423</a> <span class="keyword">struct </span><a class="code" href="a00091.html">uip_icmpip_hdr</a> {
|
|
<a name="l01424"></a>01424 <span class="preprocessor">#if UIP_CONF_IPV6</span>
|
|
<a name="l01425"></a>01425 <span class="preprocessor"></span> <span class="comment">/* IPv6 header. */</span>
|
|
<a name="l01426"></a>01426 <a class="code" href="a00153.html#g4caecabca98b43919dd11be1c0d4cd8e">u8_t</a> vtc,
|
|
<a name="l01427"></a>01427 tcf;
|
|
<a name="l01428"></a>01428 <a class="code" href="a00153.html#g77570ac4fcab86864fa1916e55676da2">u16_t</a> flow;
|
|
<a name="l01429"></a>01429 <a class="code" href="a00153.html#g4caecabca98b43919dd11be1c0d4cd8e">u8_t</a> <a class="code" href="a00091.html#b15853725b233d526b291db0347d4ecd">len</a>[2];
|
|
<a name="l01430"></a>01430 <a class="code" href="a00153.html#g4caecabca98b43919dd11be1c0d4cd8e">u8_t</a> <a class="code" href="a00091.html#55e7764a9f6ed05aaa98076b9f6770a5">proto</a>, <a class="code" href="a00091.html#55be3d5413ce49c5c4f5576def12d7ec">ttl</a>;
|
|
<a name="l01431"></a>01431 <a class="code" href="a00150.html#g9ebb4dac683163840eab9c6c41ad61f7">uip_ip6addr_t</a> <a class="code" href="a00091.html#0ec6a6cbcbfd191d393738c16d54e5e1">srcipaddr</a>, <a class="code" href="a00091.html#e27f4949613fe3c1de5a839af01d99dd">destipaddr</a>;
|
|
<a name="l01432"></a>01432 <span class="preprocessor">#else </span><span class="comment">/* UIP_CONF_IPV6 */</span>
|
|
<a name="l01433"></a>01433 <span class="comment">/* IPv4 header. */</span>
|
|
<a name="l01434"></a><a class="code" href="a00091.html#7d472d8b3c41618d39c93c4ca92fb3f4">01434</a> <a class="code" href="a00153.html#g4caecabca98b43919dd11be1c0d4cd8e">u8_t</a> <a class="code" href="a00091.html#7d472d8b3c41618d39c93c4ca92fb3f4">vhl</a>,
|
|
<a name="l01435"></a>01435 <a class="code" href="a00091.html#a3f2d9cb20290019b2743e8df31a2f8b">tos</a>,
|
|
<a name="l01436"></a>01436 <a class="code" href="a00091.html#b15853725b233d526b291db0347d4ecd">len</a>[2],
|
|
<a name="l01437"></a>01437 <a class="code" href="a00091.html#308463cc7b3d45d2dbcdcedd4cde9bb9">ipid</a>[2],
|
|
<a name="l01438"></a>01438 <a class="code" href="a00091.html#4619e69ec86a47f6abe945b39ec7f63a">ipoffset</a>[2],
|
|
<a name="l01439"></a>01439 <a class="code" href="a00091.html#55be3d5413ce49c5c4f5576def12d7ec">ttl</a>,
|
|
<a name="l01440"></a>01440 <a class="code" href="a00091.html#55e7764a9f6ed05aaa98076b9f6770a5">proto</a>;
|
|
<a name="l01441"></a><a class="code" href="a00091.html#babb9c2be394477af97f79507bcb4c86">01441</a> <a class="code" href="a00153.html#g77570ac4fcab86864fa1916e55676da2">u16_t</a> <a class="code" href="a00091.html#babb9c2be394477af97f79507bcb4c86">ipchksum</a>;
|
|
<a name="l01442"></a><a class="code" href="a00091.html#0ec6a6cbcbfd191d393738c16d54e5e1">01442</a> <a class="code" href="a00153.html#g77570ac4fcab86864fa1916e55676da2">u16_t</a> <a class="code" href="a00091.html#0ec6a6cbcbfd191d393738c16d54e5e1">srcipaddr</a>[2],
|
|
<a name="l01443"></a>01443 <a class="code" href="a00091.html#e27f4949613fe3c1de5a839af01d99dd">destipaddr</a>[2];
|
|
<a name="l01444"></a>01444 <span class="preprocessor">#endif </span><span class="comment">/* UIP_CONF_IPV6 */</span>
|
|
<a name="l01445"></a>01445
|
|
<a name="l01446"></a>01446 <span class="comment">/* ICMP (echo) header. */</span>
|
|
<a name="l01447"></a><a class="code" href="a00091.html#fa0fe6ca88f692d22af70ff007411252">01447</a> <a class="code" href="a00153.html#g4caecabca98b43919dd11be1c0d4cd8e">u8_t</a> <a class="code" href="a00091.html#fa0fe6ca88f692d22af70ff007411252">type</a>, <a class="code" href="a00091.html#266ea23d75c83f15b915ce54100e51c5">icode</a>;
|
|
<a name="l01448"></a><a class="code" href="a00091.html#805f8fd5533a6d4b6793e0645005da4c">01448</a> <a class="code" href="a00153.html#g77570ac4fcab86864fa1916e55676da2">u16_t</a> <a class="code" href="a00091.html#805f8fd5533a6d4b6793e0645005da4c">icmpchksum</a>;
|
|
<a name="l01449"></a>01449 <span class="preprocessor">#if !UIP_CONF_IPV6</span>
|
|
<a name="l01450"></a><a class="code" href="a00091.html#967def494c68cfc8a08d5a6c4dbbc25d">01450</a> <span class="preprocessor"></span> <a class="code" href="a00153.html#g77570ac4fcab86864fa1916e55676da2">u16_t</a> <a class="code" href="a00091.html#a6d51f3fa5da9b7f9cd37ae69600c04a">id</a>, <a class="code" href="a00091.html#967def494c68cfc8a08d5a6c4dbbc25d">seqno</a>;
|
|
<a name="l01451"></a>01451 <span class="preprocessor">#else </span><span class="comment">/* !UIP_CONF_IPV6 */</span>
|
|
<a name="l01452"></a>01452 <a class="code" href="a00153.html#g4caecabca98b43919dd11be1c0d4cd8e">u8_t</a> flags, reserved1, reserved2, reserved3;
|
|
<a name="l01453"></a>01453 <a class="code" href="a00153.html#g4caecabca98b43919dd11be1c0d4cd8e">u8_t</a> icmp6data[16];
|
|
<a name="l01454"></a>01454 <a class="code" href="a00153.html#g4caecabca98b43919dd11be1c0d4cd8e">u8_t</a> options[1];
|
|
<a name="l01455"></a>01455 <span class="preprocessor">#endif </span><span class="comment">/* !UIP_CONF_IPV6 */</span>
|
|
<a name="l01456"></a>01456 };
|
|
<a name="l01457"></a>01457
|
|
<a name="l01458"></a>01458
|
|
<a name="l01459"></a>01459 <span class="comment">/* The UDP and IP headers. */</span>
|
|
<a name="l01460"></a><a class="code" href="a00096.html">01460</a> <span class="keyword">struct </span><a class="code" href="a00096.html">uip_udpip_hdr</a> {
|
|
<a name="l01461"></a>01461 <span class="preprocessor">#if UIP_CONF_IPV6</span>
|
|
<a name="l01462"></a>01462 <span class="preprocessor"></span> <span class="comment">/* IPv6 header. */</span>
|
|
<a name="l01463"></a>01463 <a class="code" href="a00153.html#g4caecabca98b43919dd11be1c0d4cd8e">u8_t</a> vtc,
|
|
<a name="l01464"></a>01464 tcf;
|
|
<a name="l01465"></a>01465 <a class="code" href="a00153.html#g77570ac4fcab86864fa1916e55676da2">u16_t</a> flow;
|
|
<a name="l01466"></a>01466 <a class="code" href="a00153.html#g4caecabca98b43919dd11be1c0d4cd8e">u8_t</a> <a class="code" href="a00096.html#47140aa52cb9e6a2de38fdfc5da08df1">len</a>[2];
|
|
<a name="l01467"></a>01467 <a class="code" href="a00153.html#g4caecabca98b43919dd11be1c0d4cd8e">u8_t</a> <a class="code" href="a00096.html#51bbbe3099c10ef26119ddc2aa51e35e">proto</a>, <a class="code" href="a00096.html#6f8c65cfc8242197bcc3cb5b4735b16f">ttl</a>;
|
|
<a name="l01468"></a>01468 <a class="code" href="a00150.html#g9ebb4dac683163840eab9c6c41ad61f7">uip_ip6addr_t</a> <a class="code" href="a00096.html#a80e8d0fc768525fa3bfb3d4e4cf260d">srcipaddr</a>, <a class="code" href="a00096.html#be2c98748e180c1747823cd2fb8ecf0e">destipaddr</a>;
|
|
<a name="l01469"></a>01469 <span class="preprocessor">#else </span><span class="comment">/* UIP_CONF_IPV6 */</span>
|
|
<a name="l01470"></a>01470 <span class="comment">/* IP header. */</span>
|
|
<a name="l01471"></a><a class="code" href="a00096.html#f1684ad96b8acf54154688df3883b801">01471</a> <a class="code" href="a00153.html#g4caecabca98b43919dd11be1c0d4cd8e">u8_t</a> <a class="code" href="a00096.html#f1684ad96b8acf54154688df3883b801">vhl</a>,
|
|
<a name="l01472"></a>01472 <a class="code" href="a00096.html#ed119a030ebd3bf7c30a12071c27d441">tos</a>,
|
|
<a name="l01473"></a>01473 <a class="code" href="a00096.html#47140aa52cb9e6a2de38fdfc5da08df1">len</a>[2],
|
|
<a name="l01474"></a>01474 <a class="code" href="a00096.html#569382bc53aa64c227e57efe88fe13ac">ipid</a>[2],
|
|
<a name="l01475"></a>01475 <a class="code" href="a00096.html#8587178a29882482be20c2822b402b96">ipoffset</a>[2],
|
|
<a name="l01476"></a>01476 <a class="code" href="a00096.html#6f8c65cfc8242197bcc3cb5b4735b16f">ttl</a>,
|
|
<a name="l01477"></a>01477 <a class="code" href="a00096.html#51bbbe3099c10ef26119ddc2aa51e35e">proto</a>;
|
|
<a name="l01478"></a><a class="code" href="a00096.html#f20186ef441ef5b600e8544a0f2d8d81">01478</a> <a class="code" href="a00153.html#g77570ac4fcab86864fa1916e55676da2">u16_t</a> <a class="code" href="a00096.html#f20186ef441ef5b600e8544a0f2d8d81">ipchksum</a>;
|
|
<a name="l01479"></a><a class="code" href="a00096.html#a80e8d0fc768525fa3bfb3d4e4cf260d">01479</a> <a class="code" href="a00153.html#g77570ac4fcab86864fa1916e55676da2">u16_t</a> <a class="code" href="a00096.html#a80e8d0fc768525fa3bfb3d4e4cf260d">srcipaddr</a>[2],
|
|
<a name="l01480"></a>01480 <a class="code" href="a00096.html#be2c98748e180c1747823cd2fb8ecf0e">destipaddr</a>[2];
|
|
<a name="l01481"></a>01481 <span class="preprocessor">#endif </span><span class="comment">/* UIP_CONF_IPV6 */</span>
|
|
<a name="l01482"></a>01482
|
|
<a name="l01483"></a>01483 <span class="comment">/* UDP header. */</span>
|
|
<a name="l01484"></a><a class="code" href="a00096.html#b20096ae4953caaa42f6bb2373c4494c">01484</a> <a class="code" href="a00153.html#g77570ac4fcab86864fa1916e55676da2">u16_t</a> <a class="code" href="a00096.html#b20096ae4953caaa42f6bb2373c4494c">srcport</a>,
|
|
<a name="l01485"></a>01485 <a class="code" href="a00096.html#e82f68cb91d8688a619d55d2a8572979">destport</a>;
|
|
<a name="l01486"></a><a class="code" href="a00096.html#c92d2f194f096e84791f95d7e8f0ba92">01486</a> <a class="code" href="a00153.html#g77570ac4fcab86864fa1916e55676da2">u16_t</a> <a class="code" href="a00096.html#c92d2f194f096e84791f95d7e8f0ba92">udplen</a>;
|
|
<a name="l01487"></a><a class="code" href="a00096.html#858f970feb7462871c814953697a8ad7">01487</a> <a class="code" href="a00153.html#g77570ac4fcab86864fa1916e55676da2">u16_t</a> <a class="code" href="a00096.html#858f970feb7462871c814953697a8ad7">udpchksum</a>;
|
|
<a name="l01488"></a>01488 };
|
|
<a name="l01489"></a>01489
|
|
<a name="l01490"></a>01490
|
|
<a name="l01491"></a>01491 <span class="comment"></span>
|
|
<a name="l01492"></a>01492 <span class="comment">/**</span>
|
|
<a name="l01493"></a>01493 <span class="comment"> * The buffer size available for user data in the \ref uip_buf buffer.</span>
|
|
<a name="l01494"></a>01494 <span class="comment"> *</span>
|
|
<a name="l01495"></a>01495 <span class="comment"> * This macro holds the available size for user data in the \ref</span>
|
|
<a name="l01496"></a>01496 <span class="comment"> * uip_buf buffer. The macro is intended to be used for checking</span>
|
|
<a name="l01497"></a>01497 <span class="comment"> * bounds of available user data.</span>
|
|
<a name="l01498"></a>01498 <span class="comment"> *</span>
|
|
<a name="l01499"></a>01499 <span class="comment"> * Example:</span>
|
|
<a name="l01500"></a>01500 <span class="comment"> \code</span>
|
|
<a name="l01501"></a>01501 <span class="comment"> snprintf(uip_appdata, UIP_APPDATA_SIZE, "%u\n", i);</span>
|
|
<a name="l01502"></a>01502 <span class="comment"> \endcode</span>
|
|
<a name="l01503"></a>01503 <span class="comment"> *</span>
|
|
<a name="l01504"></a>01504 <span class="comment"> * \hideinitializer</span>
|
|
<a name="l01505"></a>01505 <span class="comment"> */</span>
|
|
<a name="l01506"></a><a class="code" href="a00150.html#ge0825474feee11b4e038bfe71757875f">01506</a> <span class="preprocessor">#define UIP_APPDATA_SIZE (UIP_BUFSIZE - UIP_LLH_LEN - UIP_TCPIP_HLEN)</span>
|
|
<a name="l01507"></a>01507 <span class="preprocessor"></span>
|
|
<a name="l01508"></a>01508
|
|
<a name="l01509"></a><a class="code" href="a00150.html#g359951eecd80541c2101f628a9da9146">01509</a> <span class="preprocessor">#define UIP_PROTO_ICMP 1</span>
|
|
<a name="l01510"></a><a class="code" href="a00150.html#g517c770991459cc62dc009c0d3875c6a">01510</a> <span class="preprocessor"></span><span class="preprocessor">#define UIP_PROTO_TCP 6</span>
|
|
<a name="l01511"></a><a class="code" href="a00150.html#gf72d7b9a737707dcfb2c41fec2b6792e">01511</a> <span class="preprocessor"></span><span class="preprocessor">#define UIP_PROTO_UDP 17</span>
|
|
<a name="l01512"></a><a class="code" href="a00150.html#gad0321f4c570f9983c6de81ece3ddc20">01512</a> <span class="preprocessor"></span><span class="preprocessor">#define UIP_PROTO_ICMP6 58</span>
|
|
<a name="l01513"></a>01513 <span class="preprocessor"></span>
|
|
<a name="l01514"></a>01514 <span class="comment">/* Header sizes. */</span>
|
|
<a name="l01515"></a>01515 <span class="preprocessor">#if UIP_CONF_IPV6</span>
|
|
<a name="l01516"></a>01516 <span class="preprocessor"></span><span class="preprocessor">#define UIP_IPH_LEN 40</span>
|
|
<a name="l01517"></a>01517 <span class="preprocessor"></span><span class="preprocessor">#else </span><span class="comment">/* UIP_CONF_IPV6 */</span>
|
|
<a name="l01518"></a><a class="code" href="a00150.html#g6bc12c6c7b56f73ce5d57abfdcdc6eb5">01518</a> <span class="preprocessor">#define UIP_IPH_LEN 20 </span><span class="comment">/* Size of IP header */</span>
|
|
<a name="l01519"></a>01519 <span class="preprocessor">#endif </span><span class="comment">/* UIP_CONF_IPV6 */</span>
|
|
<a name="l01520"></a><a class="code" href="a00150.html#gb948296aea6b6b3aa1f156799c4d479c">01520</a> <span class="preprocessor">#define UIP_UDPH_LEN 8 </span><span class="comment">/* Size of UDP header */</span>
|
|
<a name="l01521"></a><a class="code" href="a00150.html#g17d111686f98e4c09db73a770ac3f1a4">01521</a> <span class="preprocessor">#define UIP_TCPH_LEN 20 </span><span class="comment">/* Size of TCP header */</span>
|
|
<a name="l01522"></a><a class="code" href="a00150.html#g6f2b90c597ec23f39ec716ccec11233c">01522</a> <span class="preprocessor">#define UIP_IPUDPH_LEN (UIP_UDPH_LEN + UIP_IPH_LEN) </span><span class="comment">/* Size of IP +</span>
|
|
<a name="l01523"></a>01523 <span class="comment"> UDP</span>
|
|
<a name="l01524"></a>01524 <span class="comment"> header */</span>
|
|
<a name="l01525"></a><a class="code" href="a00150.html#g15f2617f7dc1713f9d10282125c6027b">01525</a> <span class="preprocessor">#define UIP_IPTCPH_LEN (UIP_TCPH_LEN + UIP_IPH_LEN) </span><span class="comment">/* Size of IP +</span>
|
|
<a name="l01526"></a>01526 <span class="comment"> TCP</span>
|
|
<a name="l01527"></a>01527 <span class="comment"> header */</span>
|
|
<a name="l01528"></a><a class="code" href="a00150.html#gee37386b2ab828787c05227eb109def7">01528</a> <span class="preprocessor">#define UIP_TCPIP_HLEN UIP_IPTCPH_LEN</span>
|
|
<a name="l01529"></a>01529 <span class="preprocessor"></span>
|
|
<a name="l01530"></a>01530
|
|
<a name="l01531"></a>01531 <span class="preprocessor">#if UIP_FIXEDADDR</span>
|
|
<a name="l01532"></a>01532 <span class="preprocessor"></span><span class="keyword">extern</span> <span class="keyword">const</span> <a class="code" href="a00150.html#g1ef35301f43a5bbb9f89f07b5a36b9a0">uip_ipaddr_t</a> <a class="code" href="a00150.html#g7d3673f52f5846b6961d23b150decd54">uip_hostaddr</a>, <a class="code" href="a00150.html#g3237be0d9ec457de0177689ee23c0d5c">uip_netmask</a>, <a class="code" href="a00150.html#g20df5c82f2a15a508c19e505b5d9de2b">uip_draddr</a>;
|
|
<a name="l01533"></a>01533 <span class="preprocessor">#else </span><span class="comment">/* UIP_FIXEDADDR */</span>
|
|
<a name="l01534"></a>01534 <span class="keyword">extern</span> <a class="code" href="a00150.html#g1ef35301f43a5bbb9f89f07b5a36b9a0">uip_ipaddr_t</a> <a class="code" href="a00150.html#g7d3673f52f5846b6961d23b150decd54">uip_hostaddr</a>, <a class="code" href="a00150.html#g3237be0d9ec457de0177689ee23c0d5c">uip_netmask</a>, <a class="code" href="a00150.html#g20df5c82f2a15a508c19e505b5d9de2b">uip_draddr</a>;
|
|
<a name="l01535"></a>01535 <span class="preprocessor">#endif </span><span class="comment">/* UIP_FIXEDADDR */</span>
|
|
<a name="l01536"></a>01536
|
|
<a name="l01537"></a>01537
|
|
<a name="l01538"></a>01538 <span class="comment"></span>
|
|
<a name="l01539"></a>01539 <span class="comment">/**</span>
|
|
<a name="l01540"></a>01540 <span class="comment"> * Representation of a 48-bit Ethernet address.</span>
|
|
<a name="l01541"></a>01541 <span class="comment"> */</span>
|
|
<a name="l01542"></a><a class="code" href="a00089.html">01542</a> <span class="keyword">struct </span><a class="code" href="a00089.html">uip_eth_addr</a> {
|
|
<a name="l01543"></a><a class="code" href="a00089.html#aacd5fa1806e0f0dd0bc96dd36507ad8">01543</a> <a class="code" href="a00153.html#g4caecabca98b43919dd11be1c0d4cd8e">u8_t</a> <a class="code" href="a00089.html#aacd5fa1806e0f0dd0bc96dd36507ad8">addr</a>[6];
|
|
<a name="l01544"></a>01544 };
|
|
<a name="l01545"></a>01545 <span class="comment"></span>
|
|
<a name="l01546"></a>01546 <span class="comment">/**</span>
|
|
<a name="l01547"></a>01547 <span class="comment"> * Calculate the Internet checksum over a buffer.</span>
|
|
<a name="l01548"></a>01548 <span class="comment"> *</span>
|
|
<a name="l01549"></a>01549 <span class="comment"> * The Internet checksum is the one's complement of the one's</span>
|
|
<a name="l01550"></a>01550 <span class="comment"> * complement sum of all 16-bit words in the buffer.</span>
|
|
<a name="l01551"></a>01551 <span class="comment"> *</span>
|
|
<a name="l01552"></a>01552 <span class="comment"> * See RFC1071.</span>
|
|
<a name="l01553"></a>01553 <span class="comment"> *</span>
|
|
<a name="l01554"></a>01554 <span class="comment"> * \param buf A pointer to the buffer over which the checksum is to be</span>
|
|
<a name="l01555"></a>01555 <span class="comment"> * computed.</span>
|
|
<a name="l01556"></a>01556 <span class="comment"> *</span>
|
|
<a name="l01557"></a>01557 <span class="comment"> * \param len The length of the buffer over which the checksum is to</span>
|
|
<a name="l01558"></a>01558 <span class="comment"> * be computed.</span>
|
|
<a name="l01559"></a>01559 <span class="comment"> *</span>
|
|
<a name="l01560"></a>01560 <span class="comment"> * \return The Internet checksum of the buffer.</span>
|
|
<a name="l01561"></a>01561 <span class="comment"> */</span>
|
|
<a name="l01562"></a>01562 <a class="code" href="a00153.html#g77570ac4fcab86864fa1916e55676da2">u16_t</a> <a class="code" href="a00150.html#gb6683dd83fe1c8de9a24086d4b69e907">uip_chksum</a>(<a class="code" href="a00153.html#g77570ac4fcab86864fa1916e55676da2">u16_t</a> *buf, <a class="code" href="a00153.html#g77570ac4fcab86864fa1916e55676da2">u16_t</a> len);
|
|
<a name="l01563"></a>01563 <span class="comment"></span>
|
|
<a name="l01564"></a>01564 <span class="comment">/**</span>
|
|
<a name="l01565"></a>01565 <span class="comment"> * Calculate the IP header checksum of the packet header in uip_buf.</span>
|
|
<a name="l01566"></a>01566 <span class="comment"> *</span>
|
|
<a name="l01567"></a>01567 <span class="comment"> * The IP header checksum is the Internet checksum of the 20 bytes of</span>
|
|
<a name="l01568"></a>01568 <span class="comment"> * the IP header.</span>
|
|
<a name="l01569"></a>01569 <span class="comment"> *</span>
|
|
<a name="l01570"></a>01570 <span class="comment"> * \return The IP header checksum of the IP header in the uip_buf</span>
|
|
<a name="l01571"></a>01571 <span class="comment"> * buffer.</span>
|
|
<a name="l01572"></a>01572 <span class="comment"> */</span>
|
|
<a name="l01573"></a>01573 <a class="code" href="a00153.html#g77570ac4fcab86864fa1916e55676da2">u16_t</a> <a class="code" href="a00150.html#g2addf34c7d457c1a7899a7e2171ef1e9">uip_ipchksum</a>(<span class="keywordtype">void</span>);
|
|
<a name="l01574"></a>01574 <span class="comment"></span>
|
|
<a name="l01575"></a>01575 <span class="comment">/**</span>
|
|
<a name="l01576"></a>01576 <span class="comment"> * Calculate the TCP checksum of the packet in uip_buf and uip_appdata.</span>
|
|
<a name="l01577"></a>01577 <span class="comment"> *</span>
|
|
<a name="l01578"></a>01578 <span class="comment"> * The TCP checksum is the Internet checksum of data contents of the</span>
|
|
<a name="l01579"></a>01579 <span class="comment"> * TCP segment, and a pseudo-header as defined in RFC793.</span>
|
|
<a name="l01580"></a>01580 <span class="comment"> *</span>
|
|
<a name="l01581"></a>01581 <span class="comment"> * \return The TCP checksum of the TCP segment in uip_buf and pointed</span>
|
|
<a name="l01582"></a>01582 <span class="comment"> * to by uip_appdata.</span>
|
|
<a name="l01583"></a>01583 <span class="comment"> */</span>
|
|
<a name="l01584"></a>01584 <a class="code" href="a00153.html#g77570ac4fcab86864fa1916e55676da2">u16_t</a> <a class="code" href="a00150.html#g85b65e38aa74eba18979156f97a94a87">uip_tcpchksum</a>(<span class="keywordtype">void</span>);
|
|
<a name="l01585"></a>01585 <span class="comment"></span>
|
|
<a name="l01586"></a>01586 <span class="comment">/**</span>
|
|
<a name="l01587"></a>01587 <span class="comment"> * Calculate the UDP checksum of the packet in uip_buf and uip_appdata.</span>
|
|
<a name="l01588"></a>01588 <span class="comment"> *</span>
|
|
<a name="l01589"></a>01589 <span class="comment"> * The UDP checksum is the Internet checksum of data contents of the</span>
|
|
<a name="l01590"></a>01590 <span class="comment"> * UDP segment, and a pseudo-header as defined in RFC768.</span>
|
|
<a name="l01591"></a>01591 <span class="comment"> *</span>
|
|
<a name="l01592"></a>01592 <span class="comment"> * \return The UDP checksum of the UDP segment in uip_buf and pointed</span>
|
|
<a name="l01593"></a>01593 <span class="comment"> * to by uip_appdata.</span>
|
|
<a name="l01594"></a>01594 <span class="comment"> */</span>
|
|
<a name="l01595"></a>01595 <a class="code" href="a00153.html#g77570ac4fcab86864fa1916e55676da2">u16_t</a> <a class="code" href="a00150.html#g7023a34ba9e9d03b5fbedbcb32924453">uip_udpchksum</a>(<span class="keywordtype">void</span>);
|
|
<a name="l01596"></a>01596
|
|
<a name="l01597"></a>01597
|
|
<a name="l01598"></a>01598 <span class="preprocessor">#endif </span><span class="comment">/* __UIP_H__ */</span>
|
|
<a name="l01599"></a>01599
|
|
<a name="l01600"></a>01600 <span class="comment"></span>
|
|
<a name="l01601"></a>01601 <span class="comment">/** @} */</span>
|
|
</pre></div><hr size="1"><address style="align: right;"><small>Generated on Mon Jun 12 10:23:01 2006 for uIP 1.0 by
|
|
<a href="http://www.doxygen.org/index.html">
|
|
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6 </small></address>
|
|
</body>
|
|
</html>
|