Donatien Garnier
ZG2100 Network interface source
lwip/include/lwip/netbuf.h@0:b802fc31f1db, 2010-07-09 (annotated)
- Committer:
- donatien
- Date:
- Fri Jul 09 15:37:23 2010 +0000
- Revision:
- 0:b802fc31f1db
- Child:
- 1:3a7c15057192
Who changed what in which revision?
| User | Revision | Line number | New contents of line |
|---|---|---|---|
| donatien | 0:b802fc31f1db | 1 | /* |
| donatien | 0:b802fc31f1db | 2 | * Copyright (c) 2001-2004 Swedish Institute of Computer Science. |
| donatien | 0:b802fc31f1db | 3 | * All rights reserved. |
| donatien | 0:b802fc31f1db | 4 | * |
| donatien | 0:b802fc31f1db | 5 | * Redistribution and use in source and binary forms, with or without modification, |
| donatien | 0:b802fc31f1db | 6 | * are permitted provided that the following conditions are met: |
| donatien | 0:b802fc31f1db | 7 | * |
| donatien | 0:b802fc31f1db | 8 | * 1. Redistributions of source code must retain the above copyright notice, |
| donatien | 0:b802fc31f1db | 9 | * this list of conditions and the following disclaimer. |
| donatien | 0:b802fc31f1db | 10 | * 2. Redistributions in binary form must reproduce the above copyright notice, |
| donatien | 0:b802fc31f1db | 11 | * this list of conditions and the following disclaimer in the documentation |
| donatien | 0:b802fc31f1db | 12 | * and/or other materials provided with the distribution. |
| donatien | 0:b802fc31f1db | 13 | * 3. The name of the author may not be used to endorse or promote products |
| donatien | 0:b802fc31f1db | 14 | * derived from this software without specific prior written permission. |
| donatien | 0:b802fc31f1db | 15 | * |
| donatien | 0:b802fc31f1db | 16 | * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED |
| donatien | 0:b802fc31f1db | 17 | * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF |
| donatien | 0:b802fc31f1db | 18 | * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT |
| donatien | 0:b802fc31f1db | 19 | * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, |
| donatien | 0:b802fc31f1db | 20 | * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT |
| donatien | 0:b802fc31f1db | 21 | * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS |
| donatien | 0:b802fc31f1db | 22 | * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN |
| donatien | 0:b802fc31f1db | 23 | * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING |
| donatien | 0:b802fc31f1db | 24 | * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY |
| donatien | 0:b802fc31f1db | 25 | * OF SUCH DAMAGE. |
| donatien | 0:b802fc31f1db | 26 | * |
| donatien | 0:b802fc31f1db | 27 | * This file is part of the lwIP TCP/IP stack. |
| donatien | 0:b802fc31f1db | 28 | * |
| donatien | 0:b802fc31f1db | 29 | * Author: Adam Dunkels <adam@sics.se> |
| donatien | 0:b802fc31f1db | 30 | * |
| donatien | 0:b802fc31f1db | 31 | */ |
| donatien | 0:b802fc31f1db | 32 | #ifndef __LWIP_NETBUF_H__ |
| donatien | 0:b802fc31f1db | 33 | #define __LWIP_NETBUF_H__ |
| donatien | 0:b802fc31f1db | 34 | |
| donatien | 0:b802fc31f1db | 35 | #include "lwip/opt.h" |
| donatien | 0:b802fc31f1db | 36 | #include "lwip/pbuf.h" |
| donatien | 0:b802fc31f1db | 37 | #include "lwip/ip_addr.h" |
| donatien | 0:b802fc31f1db | 38 | |
| donatien | 0:b802fc31f1db | 39 | #ifdef __cplusplus |
| donatien | 0:b802fc31f1db | 40 | extern "C" { |
| donatien | 0:b802fc31f1db | 41 | #endif |
| donatien | 0:b802fc31f1db | 42 | |
| donatien | 0:b802fc31f1db | 43 | struct netbuf { |
| donatien | 0:b802fc31f1db | 44 | struct pbuf *p, *ptr; |
| donatien | 0:b802fc31f1db | 45 | ip_addr_t *addr; |
| donatien | 0:b802fc31f1db | 46 | u16_t port; |
| donatien | 0:b802fc31f1db | 47 | #if LWIP_NETBUF_RECVINFO |
| donatien | 0:b802fc31f1db | 48 | ip_addr_t *toaddr; |
| donatien | 0:b802fc31f1db | 49 | u16_t toport; |
| donatien | 0:b802fc31f1db | 50 | #endif /* LWIP_NETBUF_RECVINFO */ |
| donatien | 0:b802fc31f1db | 51 | }; |
| donatien | 0:b802fc31f1db | 52 | |
| donatien | 0:b802fc31f1db | 53 | /* Network buffer functions: */ |
| donatien | 0:b802fc31f1db | 54 | struct netbuf * netbuf_new (void); |
| donatien | 0:b802fc31f1db | 55 | void netbuf_delete (struct netbuf *buf); |
| donatien | 0:b802fc31f1db | 56 | void * netbuf_alloc (struct netbuf *buf, u16_t size); |
| donatien | 0:b802fc31f1db | 57 | void netbuf_free (struct netbuf *buf); |
| donatien | 0:b802fc31f1db | 58 | err_t netbuf_ref (struct netbuf *buf, |
| donatien | 0:b802fc31f1db | 59 | const void *dataptr, u16_t size); |
| donatien | 0:b802fc31f1db | 60 | void netbuf_chain (struct netbuf *head, |
| donatien | 0:b802fc31f1db | 61 | struct netbuf *tail); |
| donatien | 0:b802fc31f1db | 62 | |
| donatien | 0:b802fc31f1db | 63 | err_t netbuf_data (struct netbuf *buf, |
| donatien | 0:b802fc31f1db | 64 | void **dataptr, u16_t *len); |
| donatien | 0:b802fc31f1db | 65 | s8_t netbuf_next (struct netbuf *buf); |
| donatien | 0:b802fc31f1db | 66 | void netbuf_first (struct netbuf *buf); |
| donatien | 0:b802fc31f1db | 67 | |
| donatien | 0:b802fc31f1db | 68 | |
| donatien | 0:b802fc31f1db | 69 | #define netbuf_copy_partial(buf, dataptr, len, offset) \ |
| donatien | 0:b802fc31f1db | 70 | pbuf_copy_partial((buf)->p, (dataptr), (len), (offset)) |
| donatien | 0:b802fc31f1db | 71 | #define netbuf_copy(buf,dataptr,len) netbuf_copy_partial(buf, dataptr, len, 0) |
| donatien | 0:b802fc31f1db | 72 | #define netbuf_take(buf, dataptr, len) pbuf_take((buf)->p, dataptr, len) |
| donatien | 0:b802fc31f1db | 73 | #define netbuf_len(buf) ((buf)->p->tot_len) |
| donatien | 0:b802fc31f1db | 74 | #define netbuf_fromaddr(buf) ((buf)->addr) |
| donatien | 0:b802fc31f1db | 75 | #define netbuf_fromport(buf) ((buf)->port) |
| donatien | 0:b802fc31f1db | 76 | #if LWIP_NETBUF_RECVINFO |
| donatien | 0:b802fc31f1db | 77 | #define netbuf_destaddr(buf) ((buf)->toaddr) |
| donatien | 0:b802fc31f1db | 78 | #define netbuf_destport(buf) ((buf)->toport) |
| donatien | 0:b802fc31f1db | 79 | #endif /* LWIP_NETBUF_RECVINFO */ |
| donatien | 0:b802fc31f1db | 80 | |
| donatien | 0:b802fc31f1db | 81 | #ifdef __cplusplus |
| donatien | 0:b802fc31f1db | 82 | } |
| donatien | 0:b802fc31f1db | 83 | #endif |
| donatien | 0:b802fc31f1db | 84 | |
| donatien | 0:b802fc31f1db | 85 | #endif /* __LWIP_NETBUF_H__ */ |