Newer
Older
ubixos-old / doc / doxygen / html / udp_8h-source.html
@CloudNine CloudNine on 28 Apr 2004 7 KB doxygen documentation added
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>Ubixos: udp.h Source File</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.3.3 -->
<h1>udp.h</h1><div class="fragment"><pre>00001 <span class="comment">/*</span>
00002 <span class="comment"> * Copyright (c) 2001, Swedish Institute of Computer Science.</span>
00003 <span class="comment"> * All rights reserved. </span>
00004 <span class="comment"> *</span>
00005 <span class="comment"> * Redistribution and use in source and binary forms, with or without </span>
00006 <span class="comment"> * modification, are permitted provided that the following conditions </span>
00007 <span class="comment"> * are met: </span>
00008 <span class="comment"> * 1. Redistributions of source code must retain the above copyright </span>
00009 <span class="comment"> *    notice, this list of conditions and the following disclaimer. </span>
00010 <span class="comment"> * 2. Redistributions in binary form must reproduce the above copyright </span>
00011 <span class="comment"> *    notice, this list of conditions and the following disclaimer in the </span>
00012 <span class="comment"> *    documentation and/or other materials provided with the distribution. </span>
00013 <span class="comment"> * 3. Neither the name of the Institute nor the names of its contributors </span>
00014 <span class="comment"> *    may be used to endorse or promote products derived from this software </span>
00015 <span class="comment"> *    without specific prior written permission. </span>
00016 <span class="comment"> *</span>
00017 <span class="comment"> * THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND </span>
00018 <span class="comment"> * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE </span>
00019 <span class="comment"> * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE </span>
00020 <span class="comment"> * ARE DISCLAIMED.  IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE </span>
00021 <span class="comment"> * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL </span>
00022 <span class="comment"> * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS </span>
00023 <span class="comment"> * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) </span>
00024 <span class="comment"> * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT </span>
00025 <span class="comment"> * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY </span>
00026 <span class="comment"> * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF </span>
00027 <span class="comment"> * SUCH DAMAGE. </span>
00028 <span class="comment"> *</span>
00029 <span class="comment"> * This file is part of the lwIP TCP/IP stack.</span>
00030 <span class="comment"> * </span>
00031 <span class="comment"> * Author: Adam Dunkels &lt;adam@sics.se&gt;</span>
00032 <span class="comment"> *</span>
00033 <span class="comment"> * $Id$</span>
00034 <span class="comment"> */</span>
00035 <span class="preprocessor">#ifndef __LWIP_UDP_H__</span>
00036 <span class="preprocessor"></span><span class="preprocessor">#define __LWIP_UDP_H__</span>
00037 <span class="preprocessor"></span>
00038 <span class="preprocessor">#include "net/arch.h"</span>
00039 
00040 <span class="preprocessor">#include "net/pbuf.h"</span>
00041 <span class="comment">//UBU </span>
00042 <span class="preprocessor">#include "net/ipv4/inet.h"</span>
00043 <span class="comment">//UBU</span>
00044 <span class="preprocessor">#include "net/ipv4/ip.h"</span>
00045 
00046 <span class="preprocessor">#include "net/err.h"</span>
00047 
00048 <span class="preprocessor">#define UDP_HLEN 8</span>
00049 <span class="preprocessor"></span>
00050 <span class="keyword">struct </span>udp_hdr {
00051   PACK_STRUCT_FIELD(uInt16 src);
00052   PACK_STRUCT_FIELD(uInt16 dest);  <span class="comment">/* src/dest UDP ports */</span>
00053   PACK_STRUCT_FIELD(uInt16 len);
00054   PACK_STRUCT_FIELD(uInt16 chksum);
00055 } PACK_STRUCT_STRUCT;
00056 
00057 <span class="preprocessor">#define UDP_FLAGS_NOCHKSUM 0x01</span>
00058 <span class="preprocessor"></span><span class="preprocessor">#define UDP_FLAGS_UDPLITE  0x02</span>
00059 <span class="preprocessor"></span>
00060 <span class="keyword">struct </span>udp_pcb {
00061   <span class="keyword">struct </span>udp_pcb *next;
00062 
00063   <span class="keyword">struct </span>ip_addr local_ip, remote_ip;
00064   uInt16 local_port, remote_port;
00065   
00066   uInt8 flags;
00067   uInt16 chksum_len;
00068   
00069   void (* recv)(<span class="keywordtype">void</span> *arg, <span class="keyword">struct </span>udp_pcb *pcb, <span class="keyword">struct </span>pbuf *p,
00070                 <span class="keyword">struct </span>ip_addr *addr, uInt16 port);
00071   <span class="keywordtype">void</span> *recv_arg;  
00072 };
00073 
00074 <span class="comment">/* The following functions is the application layer interface to the</span>
00075 <span class="comment">   UDP code. */</span>
00076 <span class="keyword">struct </span>udp_pcb * udp_new        (<span class="keywordtype">void</span>);
00077 <span class="keywordtype">void</span>             udp_remove     (<span class="keyword">struct</span> udp_pcb *pcb);
00078 err_t            udp_bind       (<span class="keyword">struct</span> udp_pcb *pcb, <span class="keyword">struct</span> ip_addr *ipaddr,
00079                                  uInt16 port);
00080 err_t            udp_connect    (<span class="keyword">struct</span> udp_pcb *pcb, <span class="keyword">struct</span> ip_addr *ipaddr,
00081                                  uInt16 port);
00082 <span class="keywordtype">void</span>             udp_recv       (<span class="keyword">struct</span> udp_pcb *pcb,
00083                                  <span class="keywordtype">void</span> (* recv)(<span class="keywordtype">void</span> *arg, <span class="keyword">struct</span> udp_pcb *upcb,
00084                                                <span class="keyword">struct</span> pbuf *p,
00085                                                <span class="keyword">struct</span> ip_addr *addr,
00086                                                uInt16 port),
00087                                  <span class="keywordtype">void</span> *recv_arg);
00088 err_t            udp_send       (<span class="keyword">struct</span> udp_pcb *pcb, <span class="keyword">struct</span> pbuf *p);
00089 
00090 <span class="preprocessor">#define          udp_flags(pcb)  ((pcb)-&gt;flags)</span>
00091 <span class="preprocessor"></span><span class="preprocessor">#define          udp_setflags(pcb, f)  ((pcb)-&gt;flags = (f))</span>
00092 <span class="preprocessor"></span>
00093 
00094 <span class="comment">/* The following functions is the lower layer interface to UDP. */</span>
00095 uInt8             udp_lookup     (<span class="keyword">struct</span> ip_hdr *iphdr, <span class="keyword">struct</span> netif *inp);
00096 <span class="keywordtype">void</span>             udp_input      (<span class="keyword">struct</span> pbuf *p, <span class="keyword">struct</span> netif *inp);
00097 <span class="keywordtype">void</span>             udp_init       (<span class="keywordtype">void</span>);
00098 
00099 
00100 <span class="preprocessor">#endif </span><span class="comment">/* __LWIP_UDP_H__ */</span>
00101 
00102 
</pre></div><hr size="1"><address style="align: right;"><small>Generated on Wed Apr 28 17:49:42 2004 for Ubixos by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border=0 > 
</a>1.3.3 </small></address>
</body>
</html>