<!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>UbixOS V2: src/sys/include/net/udp.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.7 -->
<div class="tabs">
<ul>
<li><a href="main.html"><span>Main Page</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="dirs.html"><span>Directories</span></a></li>
<li>
<form action="search.php" method="get">
<table cellspacing="0" cellpadding="0" border="0">
<tr>
<td><label> <u>S</u>earch for </label></td>
<td><input type="text" name="query" value="" size="20" accesskey="s"/></td>
</tr>
</table>
</form>
</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>
<div class="nav">
<a class="el" href="dir_897b6a2d7bab147dd1db58381aad3984.html">src</a> » <a class="el" href="dir_832905b1f7f5feaf61a306b40c0ac817.html">sys</a> » <a class="el" href="dir_caf4200c438ae9601464168e21e8e4d8.html">include</a> » <a class="el" href="dir_c1d11d251a83b2498f44d410b793c5eb.html">net</a></div>
<h1>udp.h</h1><a href="udp_8h.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"> * Copyright (c) 2001, Swedish Institute of Computer Science.</span>
<a name="l00003"></a>00003 <span class="comment"> * All rights reserved. </span>
<a name="l00004"></a>00004 <span class="comment"> *</span>
<a name="l00005"></a>00005 <span class="comment"> * Redistribution and use in source and binary forms, with or without </span>
<a name="l00006"></a>00006 <span class="comment"> * modification, are permitted provided that the following conditions </span>
<a name="l00007"></a>00007 <span class="comment"> * are met: </span>
<a name="l00008"></a>00008 <span class="comment"> * 1. Redistributions of source code must retain the above copyright </span>
<a name="l00009"></a>00009 <span class="comment"> * notice, this list of conditions and the following disclaimer. </span>
<a name="l00010"></a>00010 <span class="comment"> * 2. Redistributions in binary form must reproduce the above copyright </span>
<a name="l00011"></a>00011 <span class="comment"> * notice, this list of conditions and the following disclaimer in the </span>
<a name="l00012"></a>00012 <span class="comment"> * documentation and/or other materials provided with the distribution. </span>
<a name="l00013"></a>00013 <span class="comment"> * 3. Neither the name of the Institute nor the names of its contributors </span>
<a name="l00014"></a>00014 <span class="comment"> * may be used to endorse or promote products derived from this software </span>
<a name="l00015"></a>00015 <span class="comment"> * without specific prior written permission. </span>
<a name="l00016"></a>00016 <span class="comment"> *</span>
<a name="l00017"></a>00017 <span class="comment"> * THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND </span>
<a name="l00018"></a>00018 <span class="comment"> * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE </span>
<a name="l00019"></a>00019 <span class="comment"> * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE </span>
<a name="l00020"></a>00020 <span class="comment"> * ARE DISCLAIMED. IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE </span>
<a name="l00021"></a>00021 <span class="comment"> * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL </span>
<a name="l00022"></a>00022 <span class="comment"> * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS </span>
<a name="l00023"></a>00023 <span class="comment"> * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) </span>
<a name="l00024"></a>00024 <span class="comment"> * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT </span>
<a name="l00025"></a>00025 <span class="comment"> * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY </span>
<a name="l00026"></a>00026 <span class="comment"> * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF </span>
<a name="l00027"></a>00027 <span class="comment"> * SUCH DAMAGE. </span>
<a name="l00028"></a>00028 <span class="comment"> *</span>
<a name="l00029"></a>00029 <span class="comment"> * This file is part of the lwIP TCP/IP stack.</span>
<a name="l00030"></a>00030 <span class="comment"> * </span>
<a name="l00031"></a>00031 <span class="comment"> * Author: Adam Dunkels <adam@sics.se></span>
<a name="l00032"></a>00032 <span class="comment"> *</span>
<a name="l00033"></a>00033 <span class="comment"> * $Id: udp_8h-source.html 88 2016-01-12 00:11:29Z reddawg $</span>
<a name="l00034"></a>00034 <span class="comment"> */</span>
<a name="l00035"></a>00035 <span class="preprocessor">#ifndef __LWIP_UDP_H__</span>
<a name="l00036"></a>00036 <span class="preprocessor"></span><span class="preprocessor">#define __LWIP_UDP_H__</span>
<a name="l00037"></a>00037 <span class="preprocessor"></span>
<a name="l00038"></a>00038 <span class="preprocessor">#include "<a class="code" href="arch_8h.html">net/arch.h</a>"</span>
<a name="l00039"></a>00039
<a name="l00040"></a>00040 <span class="preprocessor">#include "<a class="code" href="pbuf_8h.html">net/pbuf.h</a>"</span>
<a name="l00041"></a>00041 <span class="comment">//UBU </span>
<a name="l00042"></a>00042 <span class="preprocessor">#include "<a class="code" href="ipv4_2inet_8h.html">net/ipv4/inet.h</a>"</span>
<a name="l00043"></a>00043 <span class="comment">//UBU</span>
<a name="l00044"></a>00044 <span class="preprocessor">#include "<a class="code" href="ipv4_2ip_8h.html">net/ipv4/ip.h</a>"</span>
<a name="l00045"></a>00045
<a name="l00046"></a>00046 <span class="preprocessor">#include "<a class="code" href="err_8h.html">net/err.h</a>"</span>
<a name="l00047"></a>00047
<a name="l00048"></a><a class="code" href="udp_8h.html#5e211e5d295f6e70dee42f3083f89e71">00048</a> <span class="preprocessor">#define UDP_HLEN 8</span>
<a name="l00049"></a>00049 <span class="preprocessor"></span>
<a name="l00050"></a><a class="code" href="structudp__hdr.html">00050</a> <span class="keyword">struct </span><a class="code" href="structudp__hdr.html">udp_hdr</a> {
<a name="l00051"></a>00051 <a class="code" href="structudp__hdr.html#fed717f931fc0751ca53ada6e500117b">PACK_STRUCT_FIELD</a>(<a class="code" href="types_8h.html#3b65128d2644e9b80cec9a69bfa7e094">uInt16</a> src);
<a name="l00052"></a>00052 <a class="code" href="structudp__hdr.html#fed717f931fc0751ca53ada6e500117b">PACK_STRUCT_FIELD</a>(<a class="code" href="types_8h.html#3b65128d2644e9b80cec9a69bfa7e094">uInt16</a> dest); <span class="comment">/* src/dest UDP ports */</span>
<a name="l00053"></a>00053 <a class="code" href="structudp__hdr.html#fed717f931fc0751ca53ada6e500117b">PACK_STRUCT_FIELD</a>(<a class="code" href="types_8h.html#3b65128d2644e9b80cec9a69bfa7e094">uInt16</a> len);
<a name="l00054"></a>00054 <a class="code" href="structudp__hdr.html#fed717f931fc0751ca53ada6e500117b">PACK_STRUCT_FIELD</a>(<a class="code" href="types_8h.html#3b65128d2644e9b80cec9a69bfa7e094">uInt16</a> chksum);
<a name="l00055"></a>00055 } <a class="code" href="cc_8h.html#33623da05bb55497534c3dc26ebebeb2">PACK_STRUCT_STRUCT</a>;
<a name="l00056"></a>00056
<a name="l00057"></a><a class="code" href="udp_8h.html#3f1f7350e351cf43afc1cb92361539b7">00057</a> <span class="preprocessor">#define UDP_FLAGS_NOCHKSUM 0x01</span>
<a name="l00058"></a><a class="code" href="udp_8h.html#7bf6b42d94a2249626fd730c52a65cb2">00058</a> <span class="preprocessor"></span><span class="preprocessor">#define UDP_FLAGS_UDPLITE 0x02</span>
<a name="l00059"></a>00059 <span class="preprocessor"></span>
<a name="l00060"></a><a class="code" href="structudp__pcb.html">00060</a> <span class="keyword">struct </span><a class="code" href="structudp__pcb.html">udp_pcb</a> {
<a name="l00061"></a><a class="code" href="structudp__pcb.html#4bb1770f21ebaaa28f7f280f5f2697db">00061</a> <span class="keyword">struct </span><a class="code" href="structudp__pcb.html">udp_pcb</a> *<a class="code" href="structudp__pcb.html#4bb1770f21ebaaa28f7f280f5f2697db">next</a>;
<a name="l00062"></a>00062
<a name="l00063"></a><a class="code" href="structudp__pcb.html#719ac802c8824c1f64bb0d337b590b58">00063</a> <span class="keyword">struct </span><a class="code" href="structip__addr.html">ip_addr</a> local_ip, <a class="code" href="structudp__pcb.html#719ac802c8824c1f64bb0d337b590b58">remote_ip</a>;
<a name="l00064"></a><a class="code" href="structudp__pcb.html#c1831887907d6cb95e5784c87278136c">00064</a> <a class="code" href="types_8h.html#3b65128d2644e9b80cec9a69bfa7e094">uInt16</a> <a class="code" href="structudp__pcb.html#189bcb0abce9e46de6ec7115d11d439a">local_port</a>, <a class="code" href="structudp__pcb.html#c1831887907d6cb95e5784c87278136c">remote_port</a>;
<a name="l00065"></a>00065
<a name="l00066"></a><a class="code" href="structudp__pcb.html#826a7c3427775774f060314a0c51f72d">00066</a> <a class="code" href="types_8h.html#a4e0f27a9aca905e340c06d2dcae843c">uInt8</a> <a class="code" href="structudp__pcb.html#826a7c3427775774f060314a0c51f72d">flags</a>;
<a name="l00067"></a><a class="code" href="structudp__pcb.html#5381f996e4c16d8a91ec85bb425e3e2b">00067</a> <a class="code" href="types_8h.html#3b65128d2644e9b80cec9a69bfa7e094">uInt16</a> <a class="code" href="structudp__pcb.html#5381f996e4c16d8a91ec85bb425e3e2b">chksum_len</a>;
<a name="l00068"></a>00068
<a name="l00069"></a>00069 void (* <a class="code" href="structudp__pcb.html#fdbf1ee819ec8af2cdf561790a3086b6">recv</a>)(<span class="keywordtype">void</span> *arg, <span class="keyword">struct </span><a class="code" href="structudp__pcb.html">udp_pcb</a> *pcb, <span class="keyword">struct </span><a class="code" href="structpbuf.html">pbuf</a> *p,
<a name="l00070"></a>00070 <span class="keyword">struct </span><a class="code" href="structip__addr.html">ip_addr</a> *<a class="code" href="structip__addr.html#aca6b7136a4c4efb4e0da1384d76f4b5">addr</a>, <a class="code" href="types_8h.html#3b65128d2644e9b80cec9a69bfa7e094">uInt16</a> port);
<a name="l00071"></a><a class="code" href="structudp__pcb.html#11e4c40b8868aa40d923756a60598cab">00071</a> <span class="keywordtype">void</span> *<a class="code" href="structudp__pcb.html#11e4c40b8868aa40d923756a60598cab">recv_arg</a>;
<a name="l00072"></a>00072 };
<a name="l00073"></a>00073
<a name="l00074"></a>00074 <span class="comment">/* The following functions is the application layer interface to the</span>
<a name="l00075"></a>00075 <span class="comment"> UDP code. */</span>
<a name="l00076"></a>00076 <span class="keyword">struct </span><a class="code" href="structudp__pcb.html">udp_pcb</a> * <a class="code" href="udp_8h.html#a6d6430499acae43d342f0e68ddbb209">udp_new</a> (<span class="keywordtype">void</span>);
<a name="l00077"></a>00077 <span class="keywordtype">void</span> <a class="code" href="udp_8h.html#3aed8e469f74f960837ebf9f34acf646">udp_remove</a> (<span class="keyword">struct</span> <a class="code" href="structudp__pcb.html">udp_pcb</a> *pcb);
<a name="l00078"></a>00078 <a class="code" href="err_8h.html#b7190f3da5c85931fc059e0312bc1407">err_t</a> <a class="code" href="udp_8h.html#aec0b34185f62a12ad61ba5b43b60360">udp_bind</a> (<span class="keyword">struct</span> <a class="code" href="structudp__pcb.html">udp_pcb</a> *pcb, <span class="keyword">struct</span> <a class="code" href="structip__addr.html">ip_addr</a> *ipaddr,
<a name="l00079"></a>00079 <a class="code" href="types_8h.html#3b65128d2644e9b80cec9a69bfa7e094">uInt16</a> port);
<a name="l00080"></a>00080 <a class="code" href="err_8h.html#b7190f3da5c85931fc059e0312bc1407">err_t</a> <a class="code" href="udp_8h.html#87dbe1b8435cb7f2e2dbfb34e952ccc0">udp_connect</a> (<span class="keyword">struct</span> <a class="code" href="structudp__pcb.html">udp_pcb</a> *pcb, <span class="keyword">struct</span> <a class="code" href="structip__addr.html">ip_addr</a> *ipaddr,
<a name="l00081"></a>00081 <a class="code" href="types_8h.html#3b65128d2644e9b80cec9a69bfa7e094">uInt16</a> port);
<a name="l00082"></a>00082 <span class="keywordtype">void</span> <a class="code" href="udp_8h.html#e6e4e0150998bb6e38359418c7461eb1">udp_recv</a> (<span class="keyword">struct</span> <a class="code" href="structudp__pcb.html">udp_pcb</a> *pcb,
<a name="l00083"></a>00083 <span class="keywordtype">void</span> (* <a class="code" href="structudp__pcb.html#fdbf1ee819ec8af2cdf561790a3086b6">recv</a>)(<span class="keywordtype">void</span> *arg, <span class="keyword">struct</span> <a class="code" href="structudp__pcb.html">udp_pcb</a> *upcb,
<a name="l00084"></a>00084 <span class="keyword">struct</span> <a class="code" href="structpbuf.html">pbuf</a> *p,
<a name="l00085"></a>00085 <span class="keyword">struct</span> <a class="code" href="structip__addr.html">ip_addr</a> *addr,
<a name="l00086"></a>00086 <a class="code" href="types_8h.html#3b65128d2644e9b80cec9a69bfa7e094">uInt16</a> port),
<a name="l00087"></a>00087 <span class="keywordtype">void</span> *<a class="code" href="structudp__pcb.html#11e4c40b8868aa40d923756a60598cab">recv_arg</a>);
<a name="l00088"></a>00088 <a class="code" href="err_8h.html#b7190f3da5c85931fc059e0312bc1407">err_t</a> <a class="code" href="udp_8h.html#a4546c43981f043c0ae4514d625cc3fc">udp_send</a> (<span class="keyword">struct</span> <a class="code" href="structudp__pcb.html">udp_pcb</a> *pcb, <span class="keyword">struct</span> <a class="code" href="structpbuf.html">pbuf</a> *p);
<a name="l00089"></a>00089
<a name="l00090"></a><a class="code" href="udp_8h.html#37c8037a85578f1eeeef334f89a0a746">00090</a> <span class="preprocessor">#define udp_flags(pcb) ((pcb)->flags)</span>
<a name="l00091"></a><a class="code" href="udp_8h.html#9981d8c2b536c2d7051382c9cf27e5b1">00091</a> <span class="preprocessor"></span><span class="preprocessor">#define udp_setflags(pcb, f) ((pcb)->flags = (f))</span>
<a name="l00092"></a>00092 <span class="preprocessor"></span>
<a name="l00093"></a>00093
<a name="l00094"></a>00094 <span class="comment">/* The following functions is the lower layer interface to UDP. */</span>
<a name="l00095"></a>00095 <a class="code" href="types_8h.html#a4e0f27a9aca905e340c06d2dcae843c">uInt8</a> <a class="code" href="udp_8h.html#e941b362859d1f88b90f625a68eface8">udp_lookup</a> (<span class="keyword">struct</span> <a class="code" href="structip__hdr.html">ip_hdr</a> *iphdr, <span class="keyword">struct</span> <a class="code" href="structnetif.html">netif</a> *inp);
<a name="l00096"></a>00096 <span class="keywordtype">void</span> <a class="code" href="udp_8h.html#7b338a5515606bd51976fbc5bcec9611">udp_input</a> (<span class="keyword">struct</span> <a class="code" href="structpbuf.html">pbuf</a> *p, <span class="keyword">struct</span> <a class="code" href="structnetif.html">netif</a> *inp);
<a name="l00097"></a>00097 <span class="keywordtype">void</span> <a class="code" href="udp_8h.html#e7f7431ce99333577d7b82b26619309e">udp_init</a> (<span class="keywordtype">void</span>);
<a name="l00098"></a>00098
<a name="l00099"></a>00099
<a name="l00100"></a>00100 <span class="preprocessor">#endif </span><span class="comment">/* __LWIP_UDP_H__ */</span>
<a name="l00101"></a>00101
<a name="l00102"></a>00102
</pre></div><hr size="1"><address style="align: right;"><small>Generated on Tue Dec 12 08:52:04 2006 for UbixOS V2 by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.7 </small></address>
</body>
</html>
