📄 a00193.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/psock.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/psock.h</h1><a href="a00127.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) 2004, 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 uIP 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: psock.h,v 1.3 2006/06/12 08:00:30 adam Exp $</span><a name="l00034"></a>00034 <span class="comment"> */</span><a name="l00035"></a>00035 <span class="comment"></span><a name="l00036"></a>00036 <span class="comment">/**</span><a name="l00037"></a>00037 <span class="comment"> * \defgroup psock Protosockets library</span><a name="l00038"></a>00038 <span class="comment"> * @{</span><a name="l00039"></a>00039 <span class="comment"> *</span><a name="l00040"></a>00040 <span class="comment"> * The protosocket library provides an interface to the uIP stack that is</span><a name="l00041"></a>00041 <span class="comment"> * similar to the traditional BSD socket interface. Unlike programs</span><a name="l00042"></a>00042 <span class="comment"> * written for the ordinary uIP event-driven interface, programs</span><a name="l00043"></a>00043 <span class="comment"> * written with the protosocket library are executed in a sequential</span><a name="l00044"></a>00044 <span class="comment"> * fashion and does not have to be implemented as explicit state</span><a name="l00045"></a>00045 <span class="comment"> * machines.</span><a name="l00046"></a>00046 <span class="comment"> *</span><a name="l00047"></a>00047 <span class="comment"> * Protosockets only work with TCP connections.</span><a name="l00048"></a>00048 <span class="comment"> *</span><a name="l00049"></a>00049 <span class="comment"> * The protosocket library uses \ref pt protothreads to provide</span><a name="l00050"></a>00050 <span class="comment"> * sequential control flow. This makes the protosockets lightweight in</span><a name="l00051"></a>00051 <span class="comment"> * terms of memory, but also means that protosockets inherits the</span><a name="l00052"></a>00052 <span class="comment"> * functional limitations of protothreads. Each protosocket lives only</span><a name="l00053"></a>00053 <span class="comment"> * within a single function. Automatic variables (stack variables) are</span><a name="l00054"></a>00054 <span class="comment"> * not retained across a protosocket library function call.</span><a name="l00055"></a>00055 <span class="comment"> *</span><a name="l00056"></a>00056 <span class="comment"> * \note Because the protosocket library uses protothreads, local</span><a name="l00057"></a>00057 <span class="comment"> * variables will not always be saved across a call to a protosocket</span><a name="l00058"></a>00058 <span class="comment"> * library function. It is therefore advised that local variables are</span><a name="l00059"></a>00059 <span class="comment"> * used with extreme care.</span><a name="l00060"></a>00060 <span class="comment"> *</span><a name="l00061"></a>00061 <span class="comment"> * The protosocket library provides functions for sending data without</span><a name="l00062"></a>00062 <span class="comment"> * having to deal with retransmissions and acknowledgements, as well</span><a name="l00063"></a>00063 <span class="comment"> * as functions for reading data without having to deal with data</span><a name="l00064"></a>00064 <span class="comment"> * being split across more than one TCP segment.</span><a name="l00065"></a>00065 <span class="comment"> *</span><a name="l00066"></a>00066 <span class="comment"> * Because each protosocket runs as a protothread, the protosocket has to be</span><a name="l00067"></a>00067 <span class="comment"> * started with a call to PSOCK_BEGIN() at the start of the function</span><a name="l00068"></a>00068 <span class="comment"> * in which the protosocket is used. Similarly, the protosocket protothread can</span><a name="l00069"></a>00069 <span class="comment"> * be terminated by a call to PSOCK_EXIT().</span><a name="l00070"></a>00070 <span class="comment"> *</span><a name="l00071"></a>00071 <span class="comment"> */</span><a name="l00072"></a>00072 <span class="comment"></span><a name="l00073"></a>00073 <span class="comment">/**</span><a name="l00074"></a>00074 <span class="comment"> * \file</span><a name="l00075"></a>00075 <span class="comment"> * Protosocket library header file</span><a name="l00076"></a>00076 <span class="comment"> * \author</span><a name="l00077"></a>00077 <span class="comment"> * Adam Dunkels <adam@sics.se></span><a name="l00078"></a>00078 <span class="comment"> *</span><a name="l00079"></a>00079 <span class="comment"> */</span><a name="l00080"></a>00080 <a name="l00081"></a>00081 <span class="preprocessor">#ifndef __PSOCK_H__</span><a name="l00082"></a>00082 <span class="preprocessor"></span><span class="preprocessor">#define __PSOCK_H__</span><a name="l00083"></a>00083 <span class="preprocessor"></span><a name="l00084"></a>00084 <span class="preprocessor">#include "<a class="code" href="a00140.html">uipopt.h</a>"</span><a name="l00085"></a>00085 <span class="preprocessor">#include "<a class="code" href="a00128.html">pt.h</a>"</span><a name="l00086"></a>00086 <a name="l00087"></a>00087 <span class="comment">/*</span><a name="l00088"></a>00088 <span class="comment"> * The structure that holds the state of a buffer.</span><a name="l00089"></a>00089 <span class="comment"> *</span><a name="l00090"></a>00090 <span class="comment"> * This structure holds the state of a uIP buffer. The structure has</span><a name="l00091"></a>00091 <span class="comment"> * no user-visible elements, but is used through the functions</span><a name="l00092"></a>00092 <span class="comment"> * provided by the library.</span><a name="l00093"></a>00093 <span class="comment"> *</span><a name="l00094"></a>00094 <span class="comment"> */</span><a name="l00095"></a><a class="code" href="a00083.html">00095</a> <span class="keyword">struct </span><a class="code" href="a00083.html">psock_buf</a> {<a name="l00096"></a><a class="code" href="a00083.html#5e8637b1514d03eb3eb12dc9a502e27e">00096</a> <a class="code" href="a00153.html#g4caecabca98b43919dd11be1c0d4cd8e">u8_t</a> *<a class="code" href="a00083.html#5e8637b1514d03eb3eb12dc9a502e27e">ptr</a>;<a name="l00097"></a><a class="code" href="a00083.html#20fae11b540a561c622a0d74cb4b9f97">00097</a> <span class="keywordtype">unsigned</span> <span class="keywordtype">short</span> <a class="code" href="a00083.html#20fae11b540a561c622a0d74cb4b9f97">left</a>;<a name="l00098"></a>00098 };<a name="l00099"></a>00099 <span class="comment"></span><a name="l00100"></a>00100 <span class="comment">/**</span><a name="l00101"></a>00101 <span class="comment"> * The representation of a protosocket.</span><a name="l00102"></a>00102 <span class="comment"> *</span><a name="l00103"></a>00103 <span class="comment"> * The protosocket structrure is an opaque structure with no user-visible</span><a name="l00104"></a>00104 <span class="comment"> * elements.</span><a name="l00105"></a>00105 <span class="comment"> */</span><a name="l00106"></a><a class="code" href="a00082.html">00106</a> <span class="keyword">struct </span><a class="code" href="a00082.html">psock</a> {<a name="l00107"></a><a class="code" href="a00082.html#17aacf7c5e2046c1f3ab50faa1b2f7eb">00107</a> <span class="keyword">struct </span><a class="code" href="a00084.html">pt</a> pt, <a class="code" href="a00082.html#17aacf7c5e2046c1f3ab50faa1b2f7eb">psockpt</a>; <span class="comment">/* Protothreads - one that's using the psock</span><a name="l00108"></a>00108 <span class="comment"> functions, and one that runs inside the</span><a name="l00109"></a>00109 <span class="comment"> psock functions. */</span><a name="l00110"></a><a class="code" href="a00082.html#31f25efccba9fd043047133d0d0ba5ab">00110</a> <span class="keyword">const</span> <a class="code" href="a00153.html#g4caecabca98b43919dd11be1c0d4cd8e">u8_t</a> *<a class="code" href="a00082.html#31f25efccba9fd043047133d0d0ba5ab">sendptr</a>; <span class="comment">/* Pointer to the next data to be sent. */</span><a name="l00111"></a><a class="code" href="a00082.html#b973f2e16c2883a8a0164d716cce5a31">00111</a> <a class="code" href="a00153.html#g4caecabca98b43919dd11be1c0d4cd8e">u8_t</a> *<a class="code" href="a00082.html#b973f2e16c2883a8a0164d716cce5a31">readptr</a>; <span class="comment">/* Pointer to the next data to be read. */</span><a name="l00112"></a>00112 <a name="l00113"></a><a class="code" href="a00082.html#c3d1bfbb1abde31973c015de97ce2f84">00113</a> <span class="keywordtype">char</span> *<a class="code" href="a00082.html#c3d1bfbb1abde31973c015de97ce2f84">bufptr</a>; <span class="comment">/* Pointer to the buffer used for buffering</span><a name="l00114"></a>00114 <span class="comment"> incoming data. */</span><a name="l00115"></a>00115 <a name="l00116"></a><a class="code" href="a00082.html#19b82696bd84a803250cbf9812f2f125">00116</a> <a class="code" href="a00153.html#g77570ac4fcab86864fa1916e55676da2">u16_t</a> <a class="code" href="a00082.html#19b82696bd84a803250cbf9812f2f125">sendlen</a>; <span class="comment">/* The number of bytes left to be sent. */</span>⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -