xref: /nrf52832-nimble/rt-thread/components/net/uip/doc/html/a00193.html (revision 104654410c56c573564690304ae786df310c91fc) 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
3<title>uIP 1.0: uip/psock.h Source File</title>
4<link href="doxygen.css" rel="stylesheet" type="text/css">
5<link href="tabs.css" rel="stylesheet" type="text/css">
6</head><body>
7<!-- Generated by Doxygen 1.4.6 -->
8<div class="tabs">
9  <ul>
10    <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
11    <li><a href="modules.html"><span>Modules</span></a></li>
12    <li><a href="classes.html"><span>Data&nbsp;Structures</span></a></li>
13    <li id="current"><a href="files.html"><span>Files</span></a></li>
14    <li><a href="examples.html"><span>Examples</span></a></li>
15  </ul></div>
16<div class="tabs">
17  <ul>
18    <li><a href="files.html"><span>File&nbsp;List</span></a></li>
19    <li><a href="globals.html"><span>Globals</span></a></li>
20  </ul></div>
21<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>
22<a name="l00002"></a>00002 <span class="comment"> * Copyright (c) 2004, Swedish Institute of Computer Science.</span>
23<a name="l00003"></a>00003 <span class="comment"> * All rights reserved.</span>
24<a name="l00004"></a>00004 <span class="comment"> *</span>
25<a name="l00005"></a>00005 <span class="comment"> * Redistribution and use in source and binary forms, with or without</span>
26<a name="l00006"></a>00006 <span class="comment"> * modification, are permitted provided that the following conditions</span>
27<a name="l00007"></a>00007 <span class="comment"> * are met:</span>
28<a name="l00008"></a>00008 <span class="comment"> * 1. Redistributions of source code must retain the above copyright</span>
29<a name="l00009"></a>00009 <span class="comment"> *    notice, this list of conditions and the following disclaimer.</span>
30<a name="l00010"></a>00010 <span class="comment"> * 2. Redistributions in binary form must reproduce the above copyright</span>
31<a name="l00011"></a>00011 <span class="comment"> *    notice, this list of conditions and the following disclaimer in the</span>
32<a name="l00012"></a>00012 <span class="comment"> *    documentation and/or other materials provided with the distribution.</span>
33<a name="l00013"></a>00013 <span class="comment"> * 3. Neither the name of the Institute nor the names of its contributors</span>
34<a name="l00014"></a>00014 <span class="comment"> *    may be used to endorse or promote products derived from this software</span>
35<a name="l00015"></a>00015 <span class="comment"> *    without specific prior written permission.</span>
36<a name="l00016"></a>00016 <span class="comment"> *</span>
37<a name="l00017"></a>00017 <span class="comment"> * THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND</span>
38<a name="l00018"></a>00018 <span class="comment"> * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE</span>
39<a name="l00019"></a>00019 <span class="comment"> * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE</span>
40<a name="l00020"></a>00020 <span class="comment"> * ARE DISCLAIMED.  IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE</span>
41<a name="l00021"></a>00021 <span class="comment"> * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL</span>
42<a name="l00022"></a>00022 <span class="comment"> * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS</span>
43<a name="l00023"></a>00023 <span class="comment"> * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)</span>
44<a name="l00024"></a>00024 <span class="comment"> * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT</span>
45<a name="l00025"></a>00025 <span class="comment"> * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY</span>
46<a name="l00026"></a>00026 <span class="comment"> * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF</span>
47<a name="l00027"></a>00027 <span class="comment"> * SUCH DAMAGE.</span>
48<a name="l00028"></a>00028 <span class="comment"> *</span>
49<a name="l00029"></a>00029 <span class="comment"> * This file is part of the uIP TCP/IP stack</span>
50<a name="l00030"></a>00030 <span class="comment"> *</span>
51<a name="l00031"></a>00031 <span class="comment"> * Author: Adam Dunkels &lt;[email protected]&gt;</span>
52<a name="l00032"></a>00032 <span class="comment"> *</span>
53<a name="l00033"></a>00033 <span class="comment"> * $Id: psock.h,v 1.3 2006/06/12 08:00:30 adam Exp $</span>
54<a name="l00034"></a>00034 <span class="comment"> */</span>
55<a name="l00035"></a>00035 <span class="comment"></span>
56<a name="l00036"></a>00036 <span class="comment">/**</span>
57<a name="l00037"></a>00037 <span class="comment"> * \defgroup psock Protosockets library</span>
58<a name="l00038"></a>00038 <span class="comment"> * @{</span>
59<a name="l00039"></a>00039 <span class="comment"> *</span>
60<a name="l00040"></a>00040 <span class="comment"> * The protosocket library provides an interface to the uIP stack that is</span>
61<a name="l00041"></a>00041 <span class="comment"> * similar to the traditional BSD socket interface. Unlike programs</span>
62<a name="l00042"></a>00042 <span class="comment"> * written for the ordinary uIP event-driven interface, programs</span>
63<a name="l00043"></a>00043 <span class="comment"> * written with the protosocket library are executed in a sequential</span>
64<a name="l00044"></a>00044 <span class="comment"> * fashion and does not have to be implemented as explicit state</span>
65<a name="l00045"></a>00045 <span class="comment"> * machines.</span>
66<a name="l00046"></a>00046 <span class="comment"> *</span>
67<a name="l00047"></a>00047 <span class="comment"> * Protosockets only work with TCP connections.</span>
68<a name="l00048"></a>00048 <span class="comment"> *</span>
69<a name="l00049"></a>00049 <span class="comment"> * The protosocket library uses \ref pt protothreads to provide</span>
70<a name="l00050"></a>00050 <span class="comment"> * sequential control flow. This makes the protosockets lightweight in</span>
71<a name="l00051"></a>00051 <span class="comment"> * terms of memory, but also means that protosockets inherits the</span>
72<a name="l00052"></a>00052 <span class="comment"> * functional limitations of protothreads. Each protosocket lives only</span>
73<a name="l00053"></a>00053 <span class="comment"> * within a single function. Automatic variables (stack variables) are</span>
74<a name="l00054"></a>00054 <span class="comment"> * not retained across a protosocket library function call.</span>
75<a name="l00055"></a>00055 <span class="comment"> *</span>
76<a name="l00056"></a>00056 <span class="comment"> * \note Because the protosocket library uses protothreads, local</span>
77<a name="l00057"></a>00057 <span class="comment"> * variables will not always be saved across a call to a protosocket</span>
78<a name="l00058"></a>00058 <span class="comment"> * library function. It is therefore advised that local variables are</span>
79<a name="l00059"></a>00059 <span class="comment"> * used with extreme care.</span>
80<a name="l00060"></a>00060 <span class="comment"> *</span>
81<a name="l00061"></a>00061 <span class="comment"> * The protosocket library provides functions for sending data without</span>
82<a name="l00062"></a>00062 <span class="comment"> * having to deal with retransmissions and acknowledgements, as well</span>
83<a name="l00063"></a>00063 <span class="comment"> * as functions for reading data without having to deal with data</span>
84<a name="l00064"></a>00064 <span class="comment"> * being split across more than one TCP segment.</span>
85<a name="l00065"></a>00065 <span class="comment"> *</span>
86<a name="l00066"></a>00066 <span class="comment"> * Because each protosocket runs as a protothread, the protosocket has to be</span>
87<a name="l00067"></a>00067 <span class="comment"> * started with a call to PSOCK_BEGIN() at the start of the function</span>
88<a name="l00068"></a>00068 <span class="comment"> * in which the protosocket is used. Similarly, the protosocket protothread can</span>
89<a name="l00069"></a>00069 <span class="comment"> * be terminated by a call to PSOCK_EXIT().</span>
90<a name="l00070"></a>00070 <span class="comment"> *</span>
91<a name="l00071"></a>00071 <span class="comment"> */</span>
92<a name="l00072"></a>00072 <span class="comment"></span>
93<a name="l00073"></a>00073 <span class="comment">/**</span>
94<a name="l00074"></a>00074 <span class="comment"> * \file</span>
95<a name="l00075"></a>00075 <span class="comment"> * Protosocket library header file</span>
96<a name="l00076"></a>00076 <span class="comment"> * \author</span>
97<a name="l00077"></a>00077 <span class="comment"> * Adam Dunkels &lt;[email protected]&gt;</span>
98<a name="l00078"></a>00078 <span class="comment"> *</span>
99<a name="l00079"></a>00079 <span class="comment"> */</span>
100<a name="l00080"></a>00080
101<a name="l00081"></a>00081 <span class="preprocessor">#ifndef __PSOCK_H__</span>
102<a name="l00082"></a>00082 <span class="preprocessor"></span><span class="preprocessor">#define __PSOCK_H__</span>
103<a name="l00083"></a>00083 <span class="preprocessor"></span>
104<a name="l00084"></a>00084 <span class="preprocessor">#include "<a class="code" href="a00140.html">uipopt.h</a>"</span>
105<a name="l00085"></a>00085 <span class="preprocessor">#include "<a class="code" href="a00128.html">pt.h</a>"</span>
106<a name="l00086"></a>00086
107<a name="l00087"></a>00087  <span class="comment">/*</span>
108<a name="l00088"></a>00088 <span class="comment"> * The structure that holds the state of a buffer.</span>
109<a name="l00089"></a>00089 <span class="comment"> *</span>
110<a name="l00090"></a>00090 <span class="comment"> * This structure holds the state of a uIP buffer. The structure has</span>
111<a name="l00091"></a>00091 <span class="comment"> * no user-visible elements, but is used through the functions</span>
112<a name="l00092"></a>00092 <span class="comment"> * provided by the library.</span>
113<a name="l00093"></a>00093 <span class="comment"> *</span>
114<a name="l00094"></a>00094 <span class="comment"> */</span>
115<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> {
116<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>;
117<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>;
118<a name="l00098"></a>00098 };
119<a name="l00099"></a>00099 <span class="comment"></span>
120<a name="l00100"></a>00100 <span class="comment">/**</span>
121<a name="l00101"></a>00101 <span class="comment"> * The representation of a protosocket.</span>
122<a name="l00102"></a>00102 <span class="comment"> *</span>
123<a name="l00103"></a>00103 <span class="comment"> * The protosocket structrure is an opaque structure with no user-visible</span>
124<a name="l00104"></a>00104 <span class="comment"> * elements.</span>
125<a name="l00105"></a>00105 <span class="comment"> */</span>
126<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> {
127<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>
128<a name="l00108"></a>00108 <span class="comment">                            functions, and one that runs inside the</span>
129<a name="l00109"></a>00109 <span class="comment">                            psock functions. */</span>
130<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>
131<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>
132<a name="l00112"></a>00112
133<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>
134<a name="l00114"></a>00114 <span class="comment">                            incoming data. */</span>
135<a name="l00115"></a>00115
136<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>
137<a name="l00117"></a><a class="code" href="a00082.html#a408ca8630154ebd039f37a828399f7b">00117</a>   <a class="code" href="a00153.html#g77570ac4fcab86864fa1916e55676da2">u16_t</a> <a class="code" href="a00082.html#a408ca8630154ebd039f37a828399f7b">readlen</a>;         <span class="comment">/* The number of bytes left to be read. */</span>
138<a name="l00118"></a>00118
139<a name="l00119"></a><a class="code" href="a00082.html#d6bd03239291629676e4c0286ebb650f">00119</a>   <span class="keyword">struct </span><a class="code" href="a00083.html">psock_buf</a> <a class="code" href="a00082.html#d6bd03239291629676e4c0286ebb650f">buf</a>;  <span class="comment">/* The structure holding the state of the</span>
140<a name="l00120"></a>00120 <span class="comment">                            input buffer. */</span>
141<a name="l00121"></a><a class="code" href="a00082.html#a6bfaf327ce839ba70accd71014398d0">00121</a>   <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="a00082.html#a6bfaf327ce839ba70accd71014398d0">bufsize</a>;  <span class="comment">/* The size of the input buffer. */</span>
142<a name="l00122"></a>00122
143<a name="l00123"></a><a class="code" href="a00082.html#fda184638130452f3570966acc5b97f9">00123</a>   <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> <a class="code" href="a00082.html#fda184638130452f3570966acc5b97f9">state</a>;   <span class="comment">/* The state of the protosocket. */</span>
144<a name="l00124"></a>00124 };
145<a name="l00125"></a>00125
146<a name="l00126"></a>00126 <span class="keywordtype">void</span> psock_init(<span class="keyword">struct</span> <a class="code" href="a00082.html">psock</a> *<a class="code" href="a00082.html">psock</a>, <span class="keywordtype">char</span> *buffer, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> buffersize);<span class="comment"></span>
147<a name="l00127"></a>00127 <span class="comment">/**</span>
148<a name="l00128"></a>00128 <span class="comment"> * Initialize a protosocket.</span>
149<a name="l00129"></a>00129 <span class="comment"> *</span>
150<a name="l00130"></a>00130 <span class="comment"> * This macro initializes a protosocket and must be called before the</span>
151<a name="l00131"></a>00131 <span class="comment"> * protosocket is used. The initialization also specifies the input buffer</span>
152<a name="l00132"></a>00132 <span class="comment"> * for the protosocket.</span>
153<a name="l00133"></a>00133 <span class="comment"> *</span>
154<a name="l00134"></a>00134 <span class="comment"> * \param psock (struct psock *) A pointer to the protosocket to be</span>
155<a name="l00135"></a>00135 <span class="comment"> * initialized</span>
156<a name="l00136"></a>00136 <span class="comment"> *</span>
157<a name="l00137"></a>00137 <span class="comment"> * \param buffer (char *) A pointer to the input buffer for the</span>
158<a name="l00138"></a>00138 <span class="comment"> * protosocket.</span>
159<a name="l00139"></a>00139 <span class="comment"> *</span>
160<a name="l00140"></a>00140 <span class="comment"> * \param buffersize (unsigned int) The size of the input buffer.</span>
161<a name="l00141"></a>00141 <span class="comment"> *</span>
162<a name="l00142"></a>00142 <span class="comment"> * \hideinitializer</span>
163<a name="l00143"></a>00143 <span class="comment"> */</span>
164<a name="l00144"></a><a class="code" href="a00158.html#g26ae707402e494f3895a9f012a93ea29">00144</a> <span class="preprocessor">#define PSOCK_INIT(psock, buffer, buffersize) \</span>
165<a name="l00145"></a>00145 <span class="preprocessor">  psock_init(psock, buffer, buffersize)</span>
166<a name="l00146"></a>00146 <span class="preprocessor"></span><span class="comment"></span>
167<a name="l00147"></a>00147 <span class="comment">/**</span>
168<a name="l00148"></a>00148 <span class="comment"> * Start the protosocket protothread in a function.</span>
169<a name="l00149"></a>00149 <span class="comment"> *</span>
170<a name="l00150"></a>00150 <span class="comment"> * This macro starts the protothread associated with the protosocket and</span>
171<a name="l00151"></a>00151 <span class="comment"> * must come before other protosocket calls in the function it is used.</span>
172<a name="l00152"></a>00152 <span class="comment"> *</span>
173<a name="l00153"></a>00153 <span class="comment"> * \param psock (struct psock *) A pointer to the protosocket to be</span>
174<a name="l00154"></a>00154 <span class="comment"> * started.</span>
175<a name="l00155"></a>00155 <span class="comment"> *</span>
176<a name="l00156"></a>00156 <span class="comment"> * \hideinitializer</span>
177<a name="l00157"></a>00157 <span class="comment"> */</span>
178<a name="l00158"></a><a class="code" href="a00158.html#g84901a5aa60040e96d272a69977edd22">00158</a> <span class="preprocessor">#define PSOCK_BEGIN(psock) PT_BEGIN(&amp;((psock)-&gt;pt))</span>
179<a name="l00159"></a>00159 <span class="preprocessor"></span>
180<a name="l00160"></a>00160 <a class="code" href="a00142.html#g3d4c8bd4aada659eb34f5d2ffd3e7901">PT_THREAD</a>(psock_send(<span class="keyword">struct</span> <a class="code" href="a00082.html">psock</a> *<a class="code" href="a00082.html">psock</a>, <span class="keyword">const</span> <span class="keywordtype">char</span> *buf, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> len));<span class="comment"></span>
181<a name="l00161"></a>00161 <span class="comment">/**</span>
182<a name="l00162"></a>00162 <span class="comment"> * Send data.</span>
183<a name="l00163"></a>00163 <span class="comment"> *</span>
184<a name="l00164"></a>00164 <span class="comment"> * This macro sends data over a protosocket. The protosocket protothread blocks</span>
185<a name="l00165"></a>00165 <span class="comment"> * until all data has been sent and is known to have been received by</span>
186<a name="l00166"></a>00166 <span class="comment"> * the remote end of the TCP connection.</span>
187<a name="l00167"></a>00167 <span class="comment"> *</span>
188<a name="l00168"></a>00168 <span class="comment"> * \param psock (struct psock *) A pointer to the protosocket over which</span>
189<a name="l00169"></a>00169 <span class="comment"> * data is to be sent.</span>
190<a name="l00170"></a>00170 <span class="comment"> *</span>
191<a name="l00171"></a>00171 <span class="comment"> * \param data (char *) A pointer to the data that is to be sent.</span>
192<a name="l00172"></a>00172 <span class="comment"> *</span>
193<a name="l00173"></a>00173 <span class="comment"> * \param datalen (unsigned int) The length of the data that is to be</span>
194<a name="l00174"></a>00174 <span class="comment"> * sent.</span>
195<a name="l00175"></a>00175 <span class="comment"> *</span>
196<a name="l00176"></a>00176 <span class="comment"> * \hideinitializer</span>
197<a name="l00177"></a>00177 <span class="comment"> */</span>
198<a name="l00178"></a><a class="code" href="a00158.html#g70d236d1cf34b4e21836edda60247b70">00178</a> <span class="preprocessor">#define PSOCK_SEND(psock, data, datalen)                \</span>
199<a name="l00179"></a>00179 <span class="preprocessor">    PT_WAIT_THREAD(&amp;((psock)-&gt;pt), psock_send(psock, data, datalen))</span>
200<a name="l00180"></a>00180 <span class="preprocessor"></span><span class="comment"></span>
201<a name="l00181"></a>00181 <span class="comment">/**</span>
202<a name="l00182"></a>00182 <span class="comment"> * \brief      Send a null-terminated string.</span>
203<a name="l00183"></a>00183 <span class="comment"> * \param psock Pointer to the protosocket.</span>
204<a name="l00184"></a>00184 <span class="comment"> * \param str  The string to be sent.</span>
205<a name="l00185"></a>00185 <span class="comment"> *</span>
206<a name="l00186"></a>00186 <span class="comment"> *             This function sends a null-terminated string over the</span>
207<a name="l00187"></a>00187 <span class="comment"> *             protosocket.</span>
208<a name="l00188"></a>00188 <span class="comment"> *</span>
209<a name="l00189"></a>00189 <span class="comment"> * \hideinitializer</span>
210<a name="l00190"></a>00190 <span class="comment"> */</span>
211<a name="l00191"></a><a class="code" href="a00158.html#gb0ad55aa96dd1d200cd0fc5a99f6a4f7">00191</a> <span class="preprocessor">#define PSOCK_SEND_STR(psock, str)                      \</span>
212<a name="l00192"></a>00192 <span class="preprocessor">    PT_WAIT_THREAD(&amp;((psock)-&gt;pt), psock_send(psock, str, strlen(str)))</span>
213<a name="l00193"></a>00193 <span class="preprocessor"></span>
214<a name="l00194"></a>00194 <a class="code" href="a00142.html#g3d4c8bd4aada659eb34f5d2ffd3e7901">PT_THREAD</a>(psock_generator_send(<span class="keyword">struct</span> <a class="code" href="a00082.html">psock</a> *<a class="code" href="a00082.html">psock</a>,
215<a name="l00195"></a>00195                                 <span class="keywordtype">unsigned</span> <span class="keywordtype">short</span> (*f)(<span class="keywordtype">void</span> *), <span class="keywordtype">void</span> *arg));
216<a name="l00196"></a>00196 <span class="comment"></span>
217<a name="l00197"></a>00197 <span class="comment">/**</span>
218<a name="l00198"></a>00198 <span class="comment"> * \brief      Generate data with a function and send it</span>
219<a name="l00199"></a>00199 <span class="comment"> * \param psock Pointer to the protosocket.</span>
220<a name="l00200"></a>00200 <span class="comment"> * \param generator Pointer to the generator function</span>
221<a name="l00201"></a>00201 <span class="comment"> * \param arg   Argument to the generator function</span>
222<a name="l00202"></a>00202 <span class="comment"> *</span>
223<a name="l00203"></a>00203 <span class="comment"> *             This function generates data and sends it over the</span>
224<a name="l00204"></a>00204 <span class="comment"> *             protosocket. This can be used to dynamically generate</span>
225<a name="l00205"></a>00205 <span class="comment"> *             data for a transmission, instead of generating the data</span>
226<a name="l00206"></a>00206 <span class="comment"> *             in a buffer beforehand. This function reduces the need for</span>
227<a name="l00207"></a>00207 <span class="comment"> *             buffer memory. The generator function is implemented by</span>
228<a name="l00208"></a>00208 <span class="comment"> *             the application, and a pointer to the function is given</span>
229<a name="l00209"></a>00209 <span class="comment"> *             as an argument with the call to PSOCK_GENERATOR_SEND().</span>
230<a name="l00210"></a>00210 <span class="comment"> *</span>
231<a name="l00211"></a>00211 <span class="comment"> *             The generator function should place the generated data</span>
232<a name="l00212"></a>00212 <span class="comment"> *             directly in the uip_appdata buffer, and return the</span>
233<a name="l00213"></a>00213 <span class="comment"> *             length of the generated data. The generator function is</span>
234<a name="l00214"></a>00214 <span class="comment"> *             called by the protosocket layer when the data first is</span>
235<a name="l00215"></a>00215 <span class="comment"> *             sent, and once for every retransmission that is needed.</span>
236<a name="l00216"></a>00216 <span class="comment"> *</span>
237<a name="l00217"></a>00217 <span class="comment"> * \hideinitializer</span>
238<a name="l00218"></a>00218 <span class="comment"> */</span>
239<a name="l00219"></a><a class="code" href="a00158.html#g10d9a9201cba1a6db623284c475c6cea">00219</a> <span class="preprocessor">#define PSOCK_GENERATOR_SEND(psock, generator, arg)     \</span>
240<a name="l00220"></a>00220 <span class="preprocessor">    PT_WAIT_THREAD(&amp;((psock)-&gt;pt),                                      \</span>
241<a name="l00221"></a>00221 <span class="preprocessor">                   psock_generator_send(psock, generator, arg))</span>
242<a name="l00222"></a>00222 <span class="preprocessor"></span>
243<a name="l00223"></a>00223 <span class="comment"></span>
244<a name="l00224"></a>00224 <span class="comment">/**</span>
245<a name="l00225"></a>00225 <span class="comment"> * Close a protosocket.</span>
246<a name="l00226"></a>00226 <span class="comment"> *</span>
247<a name="l00227"></a>00227 <span class="comment"> * This macro closes a protosocket and can only be called from within the</span>
248<a name="l00228"></a>00228 <span class="comment"> * protothread in which the protosocket lives.</span>
249<a name="l00229"></a>00229 <span class="comment"> *</span>
250<a name="l00230"></a>00230 <span class="comment"> * \param psock (struct psock *) A pointer to the protosocket that is to</span>
251<a name="l00231"></a>00231 <span class="comment"> * be closed.</span>
252<a name="l00232"></a>00232 <span class="comment"> *</span>
253<a name="l00233"></a>00233 <span class="comment"> * \hideinitializer</span>
254<a name="l00234"></a>00234 <span class="comment"> */</span>
255<a name="l00235"></a><a class="code" href="a00158.html#g5d56800f82bfc7bbf53bb4a659589812">00235</a> <span class="preprocessor">#define PSOCK_CLOSE(psock) uip_close()</span>
256<a name="l00236"></a>00236 <span class="preprocessor"></span>
257<a name="l00237"></a>00237 <a class="code" href="a00142.html#g3d4c8bd4aada659eb34f5d2ffd3e7901">PT_THREAD</a>(psock_readbuf(<span class="keyword">struct</span> psock *psock));<span class="comment"></span>
258<a name="l00238"></a>00238 <span class="comment">/**</span>
259<a name="l00239"></a>00239 <span class="comment"> * Read data until the buffer is full.</span>
260<a name="l00240"></a>00240 <span class="comment"> *</span>
261<a name="l00241"></a>00241 <span class="comment"> * This macro will block waiting for data and read the data into the</span>
262<a name="l00242"></a>00242 <span class="comment"> * input buffer specified with the call to PSOCK_INIT(). Data is read</span>
263<a name="l00243"></a>00243 <span class="comment"> * until the buffer is full..</span>
264<a name="l00244"></a>00244 <span class="comment"> *</span>
265<a name="l00245"></a>00245 <span class="comment"> * \param psock (struct psock *) A pointer to the protosocket from which</span>
266<a name="l00246"></a>00246 <span class="comment"> * data should be read.</span>
267<a name="l00247"></a>00247 <span class="comment"> *</span>
268<a name="l00248"></a>00248 <span class="comment"> * \hideinitializer</span>
269<a name="l00249"></a>00249 <span class="comment"> */</span>
270<a name="l00250"></a><a class="code" href="a00158.html#gd895ab98c54d9966ff554aa873151751">00250</a> <span class="preprocessor">#define PSOCK_READBUF(psock)                            \</span>
271<a name="l00251"></a>00251 <span class="preprocessor">  PT_WAIT_THREAD(&amp;((psock)-&gt;pt), psock_readbuf(psock))</span>
272<a name="l00252"></a>00252 <span class="preprocessor"></span>
273<a name="l00253"></a>00253 <a class="code" href="a00142.html#g3d4c8bd4aada659eb34f5d2ffd3e7901">PT_THREAD</a>(psock_readto(<span class="keyword">struct</span> psock *psock, <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> c));<span class="comment"></span>
274<a name="l00254"></a>00254 <span class="comment">/**</span>
275<a name="l00255"></a>00255 <span class="comment"> * Read data up to a specified character.</span>
276<a name="l00256"></a>00256 <span class="comment"> *</span>
277<a name="l00257"></a>00257 <span class="comment"> * This macro will block waiting for data and read the data into the</span>
278<a name="l00258"></a>00258 <span class="comment"> * input buffer specified with the call to PSOCK_INIT(). Data is only</span>
279<a name="l00259"></a>00259 <span class="comment"> * read until the specifieed character appears in the data stream.</span>
280<a name="l00260"></a>00260 <span class="comment"> *</span>
281<a name="l00261"></a>00261 <span class="comment"> * \param psock (struct psock *) A pointer to the protosocket from which</span>
282<a name="l00262"></a>00262 <span class="comment"> * data should be read.</span>
283<a name="l00263"></a>00263 <span class="comment"> *</span>
284<a name="l00264"></a>00264 <span class="comment"> * \param c (char) The character at which to stop reading.</span>
285<a name="l00265"></a>00265 <span class="comment"> *</span>
286<a name="l00266"></a>00266 <span class="comment"> * \hideinitializer</span>
287<a name="l00267"></a>00267 <span class="comment"> */</span>
288<a name="l00268"></a><a class="code" href="a00158.html#gb5d9c0becf7cb32d0aaef466839dd92e">00268</a> <span class="preprocessor">#define PSOCK_READTO(psock, c)                          \</span>
289<a name="l00269"></a>00269 <span class="preprocessor">  PT_WAIT_THREAD(&amp;((psock)-&gt;pt), psock_readto(psock, c))</span>
290<a name="l00270"></a>00270 <span class="preprocessor"></span><span class="comment"></span>
291<a name="l00271"></a>00271 <span class="comment">/**</span>
292<a name="l00272"></a>00272 <span class="comment"> * The length of the data that was previously read.</span>
293<a name="l00273"></a>00273 <span class="comment"> *</span>
294<a name="l00274"></a>00274 <span class="comment"> * This macro returns the length of the data that was previously read</span>
295<a name="l00275"></a>00275 <span class="comment"> * using PSOCK_READTO() or PSOCK_READ().</span>
296<a name="l00276"></a>00276 <span class="comment"> *</span>
297<a name="l00277"></a>00277 <span class="comment"> * \param psock (struct psock *) A pointer to the protosocket holding the data.</span>
298<a name="l00278"></a>00278 <span class="comment"> *</span>
299<a name="l00279"></a>00279 <span class="comment"> * \hideinitializer</span>
300<a name="l00280"></a>00280 <span class="comment"> */</span>
301<a name="l00281"></a><a class="code" href="a00158.html#g4ab2de595d36e9e55dd61f6ecd139162">00281</a> <span class="preprocessor">#define PSOCK_DATALEN(psock) psock_datalen(psock)</span>
302<a name="l00282"></a>00282 <span class="preprocessor"></span>
303<a name="l00283"></a>00283 <a class="code" href="a00153.html#g77570ac4fcab86864fa1916e55676da2">u16_t</a> <a class="code" href="a00158.html#g3178402dd725776415bf9745e7bf92ba">psock_datalen</a>(<span class="keyword">struct</span> psock *psock);
304<a name="l00284"></a>00284 <span class="comment"></span>
305<a name="l00285"></a>00285 <span class="comment">/**</span>
306<a name="l00286"></a>00286 <span class="comment"> * Exit the protosocket's protothread.</span>
307<a name="l00287"></a>00287 <span class="comment"> *</span>
308<a name="l00288"></a>00288 <span class="comment"> * This macro terminates the protothread of the protosocket and should</span>
309<a name="l00289"></a>00289 <span class="comment"> * almost always be used in conjunction with PSOCK_CLOSE().</span>
310<a name="l00290"></a>00290 <span class="comment"> *</span>
311<a name="l00291"></a>00291 <span class="comment"> * \sa PSOCK_CLOSE_EXIT()</span>
312<a name="l00292"></a>00292 <span class="comment"> *</span>
313<a name="l00293"></a>00293 <span class="comment"> * \param psock (struct psock *) A pointer to the protosocket.</span>
314<a name="l00294"></a>00294 <span class="comment"> *</span>
315<a name="l00295"></a>00295 <span class="comment"> * \hideinitializer</span>
316<a name="l00296"></a>00296 <span class="comment"> */</span>
317<a name="l00297"></a><a class="code" href="a00158.html#gfa11b2a1faf395ae2a6626e01c482d5d">00297</a> <span class="preprocessor">#define PSOCK_EXIT(psock) PT_EXIT(&amp;((psock)-&gt;pt))</span>
318<a name="l00298"></a>00298 <span class="preprocessor"></span><span class="comment"></span>
319<a name="l00299"></a>00299 <span class="comment">/**</span>
320<a name="l00300"></a>00300 <span class="comment"> * Close a protosocket and exit the protosocket's protothread.</span>
321<a name="l00301"></a>00301 <span class="comment"> *</span>
322<a name="l00302"></a>00302 <span class="comment"> * This macro closes a protosocket and exits the protosocket's protothread.</span>
323<a name="l00303"></a>00303 <span class="comment"> *</span>
324<a name="l00304"></a>00304 <span class="comment"> * \param psock (struct psock *) A pointer to the protosocket.</span>
325<a name="l00305"></a>00305 <span class="comment"> *</span>
326<a name="l00306"></a>00306 <span class="comment"> * \hideinitializer</span>
327<a name="l00307"></a>00307 <span class="comment"> */</span>
328<a name="l00308"></a><a class="code" href="a00158.html#gc7cc1dba1819f7fcdaa9ff9eed5a08f4">00308</a> <span class="preprocessor">#define PSOCK_CLOSE_EXIT(psock)         \</span>
329<a name="l00309"></a>00309 <span class="preprocessor">  do {                                          \</span>
330<a name="l00310"></a>00310 <span class="preprocessor">    PSOCK_CLOSE(psock);                 \</span>
331<a name="l00311"></a>00311 <span class="preprocessor">    PSOCK_EXIT(psock);                  \</span>
332<a name="l00312"></a>00312 <span class="preprocessor">  } while(0)</span>
333<a name="l00313"></a>00313 <span class="preprocessor"></span><span class="comment"></span>
334<a name="l00314"></a>00314 <span class="comment">/**</span>
335<a name="l00315"></a>00315 <span class="comment"> * Declare the end of a protosocket's protothread.</span>
336<a name="l00316"></a>00316 <span class="comment"> *</span>
337<a name="l00317"></a>00317 <span class="comment"> * This macro is used for declaring that the protosocket's protothread</span>
338<a name="l00318"></a>00318 <span class="comment"> * ends. It must always be used together with a matching PSOCK_BEGIN()</span>
339<a name="l00319"></a>00319 <span class="comment"> * macro.</span>
340<a name="l00320"></a>00320 <span class="comment"> *</span>
341<a name="l00321"></a>00321 <span class="comment"> * \param psock (struct psock *) A pointer to the protosocket.</span>
342<a name="l00322"></a>00322 <span class="comment"> *</span>
343<a name="l00323"></a>00323 <span class="comment"> * \hideinitializer</span>
344<a name="l00324"></a>00324 <span class="comment"> */</span>
345<a name="l00325"></a><a class="code" href="a00158.html#g4a264bb64ae706d53f572b1d9e4037a2">00325</a> <span class="preprocessor">#define PSOCK_END(psock) PT_END(&amp;((psock)-&gt;pt))</span>
346<a name="l00326"></a>00326 <span class="preprocessor"></span>
347<a name="l00327"></a>00327 <span class="keywordtype">char</span> <a class="code" href="a00158.html#g3b19f65e48079d8105be2a99b5b4b2ae">psock_newdata</a>(<span class="keyword">struct</span> psock *s);
348<a name="l00328"></a>00328 <span class="comment"></span>
349<a name="l00329"></a>00329 <span class="comment">/**</span>
350<a name="l00330"></a>00330 <span class="comment"> * Check if new data has arrived on a protosocket.</span>
351<a name="l00331"></a>00331 <span class="comment"> *</span>
352<a name="l00332"></a>00332 <span class="comment"> * This macro is used in conjunction with the PSOCK_WAIT_UNTIL()</span>
353<a name="l00333"></a>00333 <span class="comment"> * macro to check if data has arrived on a protosocket.</span>
354<a name="l00334"></a>00334 <span class="comment"> *</span>
355<a name="l00335"></a>00335 <span class="comment"> * \param psock (struct psock *) A pointer to the protosocket.</span>
356<a name="l00336"></a>00336 <span class="comment"> *</span>
357<a name="l00337"></a>00337 <span class="comment"> * \hideinitializer</span>
358<a name="l00338"></a>00338 <span class="comment"> */</span>
359<a name="l00339"></a><a class="code" href="a00158.html#g55ce98ea4d6f22e9d5068b904d4d2447">00339</a> <span class="preprocessor">#define PSOCK_NEWDATA(psock) psock_newdata(psock)</span>
360<a name="l00340"></a>00340 <span class="preprocessor"></span><span class="comment"></span>
361<a name="l00341"></a>00341 <span class="comment">/**</span>
362<a name="l00342"></a>00342 <span class="comment"> * Wait until a condition is true.</span>
363<a name="l00343"></a>00343 <span class="comment"> *</span>
364<a name="l00344"></a>00344 <span class="comment"> * This macro blocks the protothread until the specified condition is</span>
365<a name="l00345"></a>00345 <span class="comment"> * true. The macro PSOCK_NEWDATA() can be used to check if new data</span>
366<a name="l00346"></a>00346 <span class="comment"> * arrives when the protosocket is waiting.</span>
367<a name="l00347"></a>00347 <span class="comment"> *</span>
368<a name="l00348"></a>00348 <span class="comment"> * Typically, this macro is used as follows:</span>
369<a name="l00349"></a>00349 <span class="comment"> *</span>
370<a name="l00350"></a>00350 <span class="comment"> \code</span>
371<a name="l00351"></a>00351 <span class="comment"> PT_THREAD(thread(struct psock *s, struct timer *t))</span>
372<a name="l00352"></a>00352 <span class="comment"> {</span>
373<a name="l00353"></a>00353 <span class="comment">   PSOCK_BEGIN(s);</span>
374<a name="l00354"></a>00354 <span class="comment"></span>
375<a name="l00355"></a>00355 <span class="comment">   PSOCK_WAIT_UNTIL(s, PSOCK_NEWADATA(s) || timer_expired(t));</span>
376<a name="l00356"></a>00356 <span class="comment">   </span>
377<a name="l00357"></a>00357 <span class="comment">   if(PSOCK_NEWDATA(s)) {</span>
378<a name="l00358"></a>00358 <span class="comment">     PSOCK_READTO(s, '\n');</span>
379<a name="l00359"></a>00359 <span class="comment">   } else {</span>
380<a name="l00360"></a>00360 <span class="comment">     handle_timed_out(s);</span>
381<a name="l00361"></a>00361 <span class="comment">   }</span>
382<a name="l00362"></a>00362 <span class="comment">   </span>
383<a name="l00363"></a>00363 <span class="comment">   PSOCK_END(s);</span>
384<a name="l00364"></a>00364 <span class="comment"> }</span>
385<a name="l00365"></a>00365 <span class="comment"> \endcode</span>
386<a name="l00366"></a>00366 <span class="comment"> *</span>
387<a name="l00367"></a>00367 <span class="comment"> * \param psock (struct psock *) A pointer to the protosocket.</span>
388<a name="l00368"></a>00368 <span class="comment"> * \param condition The condition to wait for.</span>
389<a name="l00369"></a>00369 <span class="comment"> *</span>
390<a name="l00370"></a>00370 <span class="comment"> * \hideinitializer</span>
391<a name="l00371"></a>00371 <span class="comment"> */</span>
392<a name="l00372"></a><a class="code" href="a00158.html#g2ebfe5c8a7f3173714efdf2df74fc392">00372</a> <span class="preprocessor">#define PSOCK_WAIT_UNTIL(psock, condition)    \</span>
393<a name="l00373"></a>00373 <span class="preprocessor">  PT_WAIT_UNTIL(&amp;((psock)-&gt;pt), (condition));</span>
394<a name="l00374"></a>00374 <span class="preprocessor"></span>
395<a name="l00375"></a><a class="code" href="a00158.html#ga87ff36af81990e6ffe20d76d5e4606f">00375</a> <span class="preprocessor">#define PSOCK_WAIT_THREAD(psock, condition)   \</span>
396<a name="l00376"></a>00376 <span class="preprocessor">  PT_WAIT_THREAD(&amp;((psock)-&gt;pt), (condition))</span>
397<a name="l00377"></a>00377 <span class="preprocessor"></span>
398<a name="l00378"></a>00378 <span class="preprocessor">#endif </span><span class="comment">/* __PSOCK_H__ */</span>
399<a name="l00379"></a>00379 <span class="comment"></span>
400<a name="l00380"></a>00380 <span class="comment">/** @} */</span>
401</pre></div><hr size="1"><address style="align: right;"><small>Generated on Mon Jun 12 10:23:01 2006 for uIP 1.0 by&nbsp;
402<a href="http://www.doxygen.org/index.html">
403<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6 </small></address>
404</body>
405</html>
406