2 * Copyright (c) 2004, Swedish Institute of Computer Science.
\r
3 * All rights reserved.
\r
5 * Redistribution and use in source and binary forms, with or without
\r
6 * modification, are permitted provided that the following conditions
\r
8 * 1. Redistributions of source code must retain the above copyright
\r
9 * notice, this list of conditions and the following disclaimer.
\r
10 * 2. Redistributions in binary form must reproduce the above copyright
\r
11 * notice, this list of conditions and the following disclaimer in the
\r
12 * documentation and/or other materials provided with the distribution.
\r
13 * 3. Neither the name of the Institute nor the names of its contributors
\r
14 * may be used to endorse or promote products derived from this software
\r
15 * without specific prior written permission.
\r
17 * THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
\r
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
\r
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
\r
20 * ARE DISCLAIMED. IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
\r
21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
\r
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
\r
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
\r
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
\r
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
\r
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
\r
29 * This file is part of the uIP TCP/IP stack
\r
31 * Author: Adam Dunkels <adam@sics.se>
\r
33 * $Id: psock.h,v 1.3 2006/06/12 08:00:30 adam Exp $
\r
37 * \defgroup psock Protosockets library
\r
40 * The protosocket library provides an interface to the uIP stack that is
\r
41 * similar to the traditional BSD socket interface. Unlike programs
\r
42 * written for the ordinary uIP event-driven interface, programs
\r
43 * written with the protosocket library are executed in a sequential
\r
44 * fashion and does not have to be implemented as explicit state
\r
47 * Protosockets only work with TCP connections.
\r
49 * The protosocket library uses \ref pt protothreads to provide
\r
50 * sequential control flow. This makes the protosockets lightweight in
\r
51 * terms of memory, but also means that protosockets inherits the
\r
52 * functional limitations of protothreads. Each protosocket lives only
\r
53 * within a single function. Automatic variables (stack variables) are
\r
54 * not retained across a protosocket library function call.
\r
56 * \note Because the protosocket library uses protothreads, local
\r
57 * variables will not always be saved across a call to a protosocket
\r
58 * library function. It is therefore advised that local variables are
\r
59 * used with extreme care.
\r
61 * The protosocket library provides functions for sending data without
\r
62 * having to deal with retransmissions and acknowledgements, as well
\r
63 * as functions for reading data without having to deal with data
\r
64 * being split across more than one TCP segment.
\r
66 * Because each protosocket runs as a protothread, the protosocket has to be
\r
67 * started with a call to PSOCK_BEGIN() at the start of the function
\r
68 * in which the protosocket is used. Similarly, the protosocket protothread can
\r
69 * be terminated by a call to PSOCK_EXIT().
\r
75 * Protosocket library header file
\r
77 * Adam Dunkels <adam@sics.se>
\r
88 * The structure that holds the state of a buffer.
\r
90 * This structure holds the state of a uIP buffer. The structure has
\r
91 * no user-visible elements, but is used through the functions
\r
92 * provided by the library.
\r
97 unsigned short left;
\r
101 * The representation of a protosocket.
\r
103 * The protosocket structrure is an opaque structure with no user-visible
\r
107 struct pt pt, psockpt; /* Protothreads - one that's using the psock
\r
108 functions, and one that runs inside the
\r
109 psock functions. */
\r
110 const u8_t *sendptr; /* Pointer to the next data to be sent. */
\r
111 u8_t *readptr; /* Pointer to the next data to be read. */
\r
113 char *bufptr; /* Pointer to the buffer used for buffering
\r
116 u16_t sendlen; /* The number of bytes left to be sent. */
\r
117 u16_t readlen; /* The number of bytes left to be read. */
\r
119 struct psock_buf buf; /* The structure holding the state of the
\r
121 unsigned int bufsize; /* The size of the input buffer. */
\r
123 unsigned char state; /* The state of the protosocket. */
\r
126 void psock_init(struct psock *psock, char *buffer, unsigned int buffersize);
\r
128 * Initialize a protosocket.
\r
130 * This macro initializes a protosocket and must be called before the
\r
131 * protosocket is used. The initialization also specifies the input buffer
\r
132 * for the protosocket.
\r
134 * \param psock (struct psock *) A pointer to the protosocket to be
\r
137 * \param buffer (char *) A pointer to the input buffer for the
\r
140 * \param buffersize (unsigned int) The size of the input buffer.
\r
144 #define PSOCK_INIT(psock, buffer, buffersize) \
\r
145 psock_init(psock, buffer, buffersize)
\r
148 * Start the protosocket protothread in a function.
\r
150 * This macro starts the protothread associated with the protosocket and
\r
151 * must come before other protosocket calls in the function it is used.
\r
153 * \param psock (struct psock *) A pointer to the protosocket to be
\r
158 #define PSOCK_BEGIN(psock) PT_BEGIN(&((psock)->pt))
\r
160 PT_THREAD(psock_send(struct psock *psock, const char *buf, unsigned int len));
\r
164 * This macro sends data over a protosocket. The protosocket protothread blocks
\r
165 * until all data has been sent and is known to have been received by
\r
166 * the remote end of the TCP connection.
\r
168 * \param psock (struct psock *) A pointer to the protosocket over which
\r
169 * data is to be sent.
\r
171 * \param data (char *) A pointer to the data that is to be sent.
\r
173 * \param datalen (unsigned int) The length of the data that is to be
\r
178 #define PSOCK_SEND(psock, data, datalen) \
\r
179 PT_WAIT_THREAD(&((psock)->pt), psock_send(psock, data, datalen))
\r
182 * \brief Send a null-terminated string.
\r
183 * \param psock Pointer to the protosocket.
\r
184 * \param str The string to be sent.
\r
186 * This function sends a null-terminated string over the
\r
191 #define PSOCK_SEND_STR(psock, str) \
\r
192 PT_WAIT_THREAD(&((psock)->pt), psock_send(psock, str, strlen(str)))
\r
194 PT_THREAD(psock_generator_send(struct psock *psock,
\r
195 unsigned short (*f)(void *), void *arg));
\r
198 * \brief Generate data with a function and send it
\r
199 * \param psock Pointer to the protosocket.
\r
200 * \param generator Pointer to the generator function
\r
201 * \param arg Argument to the generator function
\r
203 * This function generates data and sends it over the
\r
204 * protosocket. This can be used to dynamically generate
\r
205 * data for a transmission, instead of generating the data
\r
206 * in a buffer beforehand. This function reduces the need for
\r
207 * buffer memory. The generator function is implemented by
\r
208 * the application, and a pointer to the function is given
\r
209 * as an argument with the call to PSOCK_GENERATOR_SEND().
\r
211 * The generator function should place the generated data
\r
212 * directly in the uip_appdata buffer, and return the
\r
213 * length of the generated data. The generator function is
\r
214 * called by the protosocket layer when the data first is
\r
215 * sent, and once for every retransmission that is needed.
\r
219 #define PSOCK_GENERATOR_SEND(psock, generator, arg) \
\r
220 PT_WAIT_THREAD(&((psock)->pt), \
\r
221 psock_generator_send(psock, generator, arg))
\r
225 * Close a protosocket.
\r
227 * This macro closes a protosocket and can only be called from within the
\r
228 * protothread in which the protosocket lives.
\r
230 * \param psock (struct psock *) A pointer to the protosocket that is to
\r
235 #define PSOCK_CLOSE(psock) uip_close()
\r
237 PT_THREAD(psock_readbuf(struct psock *psock));
\r
239 * Read data until the buffer is full.
\r
241 * This macro will block waiting for data and read the data into the
\r
242 * input buffer specified with the call to PSOCK_INIT(). Data is read
\r
243 * until the buffer is full..
\r
245 * \param psock (struct psock *) A pointer to the protosocket from which
\r
246 * data should be read.
\r
250 #define PSOCK_READBUF(psock) \
\r
251 PT_WAIT_THREAD(&((psock)->pt), psock_readbuf(psock))
\r
253 PT_THREAD(psock_readto(struct psock *psock, unsigned char c));
\r
255 * Read data up to a specified character.
\r
257 * This macro will block waiting for data and read the data into the
\r
258 * input buffer specified with the call to PSOCK_INIT(). Data is only
\r
259 * read until the specifieed character appears in the data stream.
\r
261 * \param psock (struct psock *) A pointer to the protosocket from which
\r
262 * data should be read.
\r
264 * \param c (char) The character at which to stop reading.
\r
268 #define PSOCK_READTO(psock, c) \
\r
269 PT_WAIT_THREAD(&((psock)->pt), psock_readto(psock, c))
\r
272 * The length of the data that was previously read.
\r
274 * This macro returns the length of the data that was previously read
\r
275 * using PSOCK_READTO() or PSOCK_READ().
\r
277 * \param psock (struct psock *) A pointer to the protosocket holding the data.
\r
281 #define PSOCK_DATALEN(psock) psock_datalen(psock)
\r
283 u16_t psock_datalen(struct psock *psock);
\r
286 * Exit the protosocket's protothread.
\r
288 * This macro terminates the protothread of the protosocket and should
\r
289 * almost always be used in conjunction with PSOCK_CLOSE().
\r
291 * \sa PSOCK_CLOSE_EXIT()
\r
293 * \param psock (struct psock *) A pointer to the protosocket.
\r
297 #define PSOCK_EXIT(psock) PT_EXIT(&((psock)->pt))
\r
300 * Close a protosocket and exit the protosocket's protothread.
\r
302 * This macro closes a protosocket and exits the protosocket's protothread.
\r
304 * \param psock (struct psock *) A pointer to the protosocket.
\r
308 #define PSOCK_CLOSE_EXIT(psock) \
\r
310 PSOCK_CLOSE(psock); \
\r
311 PSOCK_EXIT(psock); \
\r
315 * Declare the end of a protosocket's protothread.
\r
317 * This macro is used for declaring that the protosocket's protothread
\r
318 * ends. It must always be used together with a matching PSOCK_BEGIN()
\r
321 * \param psock (struct psock *) A pointer to the protosocket.
\r
325 #define PSOCK_END(psock) PT_END(&((psock)->pt))
\r
327 char psock_newdata(struct psock *s);
\r
330 * Check if new data has arrived on a protosocket.
\r
332 * This macro is used in conjunction with the PSOCK_WAIT_UNTIL()
\r
333 * macro to check if data has arrived on a protosocket.
\r
335 * \param psock (struct psock *) A pointer to the protosocket.
\r
339 #define PSOCK_NEWDATA(psock) psock_newdata(psock)
\r
342 * Wait until a condition is true.
\r
344 * This macro blocks the protothread until the specified condition is
\r
345 * true. The macro PSOCK_NEWDATA() can be used to check if new data
\r
346 * arrives when the protosocket is waiting.
\r
348 * Typically, this macro is used as follows:
\r
351 PT_THREAD(thread(struct psock *s, struct timer *t))
\r
355 PSOCK_WAIT_UNTIL(s, PSOCK_NEWADATA(s) || timer_expired(t));
\r
357 if(PSOCK_NEWDATA(s)) {
\r
358 PSOCK_READTO(s, '\n');
\r
360 handle_timed_out(s);
\r
367 * \param psock (struct psock *) A pointer to the protosocket.
\r
368 * \param condition The condition to wait for.
\r
372 #define PSOCK_WAIT_UNTIL(psock, condition) \
\r
373 PT_WAIT_UNTIL(&((psock)->pt), (condition));
\r
375 #define PSOCK_WAIT_THREAD(psock, condition) \
\r
376 PT_WAIT_THREAD(&((psock)->pt), (condition))
\r
378 #endif /* __PSOCK_H__ */
\r