<!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: api.h Source File</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.3.3 -->
<h1>api.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 <adam@sics.se></span>
00032 <span class="comment"> *</span>
00033 <span class="comment"> * $Id$</span>
00034 <span class="comment"> */</span>
00035 <span class="preprocessor">#ifndef __LWIP_API_H__</span>
00036 <span class="preprocessor"></span><span class="preprocessor">#define __LWIP_API_H__</span>
00037 <span class="preprocessor"></span>
00038 <span class="preprocessor">#include "net/opt.h"</span>
00039 <span class="preprocessor">#include "net/pbuf.h"</span>
00040 <span class="preprocessor">#include "net/sys.h"</span>
00041
00042 <span class="preprocessor">#include "net/ipv4/ip.h"</span>
00043
00044 <span class="preprocessor">#include "net/udp.h"</span>
00045 <span class="preprocessor">#include "net/tcp.h"</span>
00046
00047 <span class="preprocessor">#include "net/err.h"</span>
00048
00049 <span class="preprocessor">#define NETCONN_NOCOPY 0x00</span>
00050 <span class="preprocessor"></span><span class="preprocessor">#define NETCONN_COPY 0x01</span>
00051 <span class="preprocessor"></span>
00052 <span class="keyword">enum</span> netconn_type {
00053 NETCONN_TCP,
00054 NETCONN_UDP,
00055 NETCONN_UDPLITE,
00056 NETCONN_UDPNOCHKSUM
00057 };
00058
00059 <span class="keyword">enum</span> netconn_state {
00060 NETCONN_NONE,
00061 NETCONN_WRITE,
00062 NETCONN_ACCEPT,
00063 NETCONN_RECV,
00064 NETCONN_CONNECT,
00065 NETCONN_CLOSE
00066 };
00067
00068 <span class="keyword">struct </span>netbuf {
00069 <span class="keyword">struct </span>pbuf *p, *ptr;
00070 <span class="keyword">struct </span>ip_addr *fromaddr;
00071 uInt16 fromport;
00072 err_t err;
00073 };
00074
00075 <span class="keyword">struct </span>netconn {
00076 <span class="keyword">enum</span> netconn_type type;
00077 <span class="keyword">enum</span> netconn_state state;
00078 <span class="keyword">union </span>{
00079 <span class="keyword">struct </span>tcp_pcb *tcp;
00080 <span class="keyword">struct </span>udp_pcb *udp;
00081 } pcb;
00082 err_t err;
00083 sys_mbox_t mbox;
00084 sys_mbox_t recvmbox;
00085 sys_mbox_t acceptmbox;
00086 sys_sem_t sem;
00087 };
00088
00089 <span class="comment">/* Network buffer functions: */</span>
00090 <span class="keyword">struct </span>netbuf * netbuf_new (<span class="keywordtype">void</span>);
00091 <span class="keywordtype">void</span> netbuf_delete (<span class="keyword">struct</span> netbuf *buf);
00092 <span class="keywordtype">void</span> * netbuf_alloc (<span class="keyword">struct</span> netbuf *buf, uInt16 size);
00093 <span class="keywordtype">void</span> netbuf_free (<span class="keyword">struct</span> netbuf *buf);
00094 <span class="keywordtype">void</span> netbuf_ref (<span class="keyword">struct</span> netbuf *buf,
00095 <span class="keywordtype">void</span> *dataptr, uInt16 size);
00096 <span class="keywordtype">void</span> netbuf_chain (<span class="keyword">struct</span> netbuf *head,
00097 <span class="keyword">struct</span> netbuf *tail);
00098
00099 uInt16 netbuf_len (<span class="keyword">struct</span> netbuf *buf);
00100 err_t netbuf_data (<span class="keyword">struct</span> netbuf *buf,
00101 <span class="keywordtype">void</span> **dataptr, uInt16 *len);
00102 Int8 netbuf_next (<span class="keyword">struct</span> netbuf *buf);
00103 <span class="keywordtype">void</span> netbuf_first (<span class="keyword">struct</span> netbuf *buf);
00104
00105 <span class="keywordtype">void</span> netbuf_copy (<span class="keyword">struct</span> netbuf *buf,
00106 <span class="keywordtype">void</span> *dataptr, uInt16 len);
00107 <span class="keyword">struct </span>ip_addr * netbuf_fromaddr (<span class="keyword">struct</span> netbuf *buf);
00108 uInt16 netbuf_fromport (<span class="keyword">struct</span> netbuf *buf);
00109
00110 <span class="comment">/* Network connection functions: */</span>
00111 <span class="keyword">struct </span>netconn * netconn_new (<span class="keyword">enum</span> netconn_type type);
00112 err_t netconn_delete (<span class="keyword">struct</span> netconn *conn);
00113 <span class="keyword">enum</span> netconn_type netconn_type (<span class="keyword">struct</span> netconn *conn);
00114 err_t netconn_peer (<span class="keyword">struct</span> netconn *conn,
00115 <span class="keyword">struct</span> ip_addr **addr,
00116 uInt16 *port);
00117 err_t netconn_addr (<span class="keyword">struct</span> netconn *conn,
00118 <span class="keyword">struct</span> ip_addr **addr,
00119 uInt16 *port);
00120 err_t netconn_bind (<span class="keyword">struct</span> netconn *conn,
00121 <span class="keyword">struct</span> ip_addr *addr,
00122 uInt16 port);
00123 err_t netconn_connect (<span class="keyword">struct</span> netconn *conn,
00124 <span class="keyword">struct</span> ip_addr *addr,
00125 uInt16 port);
00126 err_t netconn_listen (<span class="keyword">struct</span> netconn *conn);
00127 <span class="keyword">struct </span>netconn * netconn_accept (<span class="keyword">struct</span> netconn *conn);
00128 <span class="keyword">struct </span>netbuf * netconn_recv (<span class="keyword">struct</span> netconn *conn);
00129 err_t netconn_send (<span class="keyword">struct</span> netconn *conn,
00130 <span class="keyword">struct</span> netbuf *buf);
00131 err_t netconn_write (<span class="keyword">struct</span> netconn *conn,
00132 <span class="keywordtype">void</span> *dataptr, uInt16 size,
00133 uInt8 copy);
00134 err_t netconn_close (<span class="keyword">struct</span> netconn *conn);
00135
00136 err_t netconn_err (<span class="keyword">struct</span> netconn *conn);
00137
00138 <span class="keywordtype">void</span> netbuf_copy_partial(<span class="keyword">struct</span> netbuf *buf, <span class="keywordtype">void</span> *dataptr, uInt16 len, uInt16 offset);
00139
00140 <span class="preprocessor">#endif </span><span class="comment">/* __LWIP_API_H__ */</span>
00141
00142
</pre></div><hr size="1"><address style="align: right;"><small>Generated on Wed Apr 28 17:49:29 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>
