netbuf.h

00001 /*
00002  * Copyright (c) 2001-2004 Swedish Institute of Computer Science.
00003  * All rights reserved. 
00004  * 
00005  * Redistribution and use in source and binary forms, with or without modification, 
00006  * are permitted provided that the following conditions are met:
00007  *
00008  * 1. Redistributions of source code must retain the above copyright notice,
00009  *    this list of conditions and the following disclaimer.
00010  * 2. Redistributions in binary form must reproduce the above copyright notice,
00011  *    this list of conditions and the following disclaimer in the documentation
00012  *    and/or other materials provided with the distribution.
00013  * 3. The name of the author may not be used to endorse or promote products
00014  *    derived from this software without specific prior written permission. 
00015  *
00016  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED 
00017  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 
00018  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT 
00019  * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 
00020  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT 
00021  * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 
00022  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 
00023  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING 
00024  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY 
00025  * OF SUCH DAMAGE.
00026  *
00027  * This file is part of the lwIP TCP/IP stack.
00028  * 
00029  * Author: Adam Dunkels <adam@sics.se>
00030  *
00031  */
00032 #ifndef __LWIP_NETBUF_H__
00033 #define __LWIP_NETBUF_H__
00034 
00035 #include "lwip/opt.h"
00036 #include "lwip/pbuf.h"
00037 #include "lwip/ip_addr.h"
00038 
00039 #ifdef __cplusplus
00040 extern "C" {
00041 #endif
00042 
00043 /** This netbuf has dest-addr/port set */
00044 #define NETBUF_FLAG_DESTADDR    0x01
00045 /** This netbuf includes a checksum */
00046 #define NETBUF_FLAG_CHKSUM      0x02
00047 
00048 struct netbuf {
00049   struct pbuf *p, *ptr;
00050   ip_addr_t addr;
00051   u16_t port;
00052 #if LWIP_NETBUF_RECVINFO || LWIP_CHECKSUM_ON_COPY
00053 #if LWIP_CHECKSUM_ON_COPY
00054   u8_t flags;
00055 #endif /* LWIP_CHECKSUM_ON_COPY */
00056   u16_t toport_chksum;
00057 #if LWIP_NETBUF_RECVINFO
00058   ip_addr_t toaddr;
00059 #endif /* LWIP_NETBUF_RECVINFO */
00060 #endif /* LWIP_NETBUF_RECVINFO || LWIP_CHECKSUM_ON_COPY */
00061 };
00062 
00063 /* Network buffer functions: */
00064 struct netbuf *   netbuf_new      (void);
00065 void              netbuf_delete   (struct netbuf *buf);
00066 void *            netbuf_alloc    (struct netbuf *buf, u16_t size);
00067 void              netbuf_free     (struct netbuf *buf);
00068 err_t             netbuf_ref      (struct netbuf *buf,
00069                                    const void *dataptr, u16_t size);
00070 void              netbuf_chain    (struct netbuf *head,
00071            struct netbuf *tail);
00072 
00073 err_t             netbuf_data     (struct netbuf *buf,
00074                                    void **dataptr, u16_t *len);
00075 s8_t              netbuf_next     (struct netbuf *buf);
00076 void              netbuf_first    (struct netbuf *buf);
00077 
00078 
00079 #define netbuf_copy_partial(buf, dataptr, len, offset) \
00080   pbuf_copy_partial((buf)->p, (dataptr), (len), (offset))
00081 #define netbuf_copy(buf,dataptr,len) netbuf_copy_partial(buf, dataptr, len, 0)
00082 #define netbuf_take(buf, dataptr, len) pbuf_take((buf)->p, dataptr, len)
00083 #define netbuf_len(buf)              ((buf)->p->tot_len)
00084 #define netbuf_fromaddr(buf)         (&((buf)->addr))
00085 #define netbuf_set_fromaddr(buf, fromaddr) ip_addr_set((&(buf)->addr), fromaddr)
00086 #define netbuf_fromport(buf)         ((buf)->port)
00087 #if LWIP_NETBUF_RECVINFO
00088 #define netbuf_destaddr(buf)         (&((buf)->toaddr))
00089 #define netbuf_set_destaddr(buf, destaddr) ip_addr_set((&(buf)->addr), destaddr)
00090 #define netbuf_destport(buf)         (((buf)->flags & NETBUF_FLAG_DESTADDR) ? (buf)->toport_chksum : 0)
00091 #endif /* LWIP_NETBUF_RECVINFO */
00092 #if LWIP_CHECKSUM_ON_COPY
00093 #define netbuf_set_chksum(buf, chksum) do { (buf)->flags = NETBUF_FLAG_CHKSUM; \
00094                                             (buf)->toport_chksum = chksum; } while(0)
00095 #endif /* LWIP_CHECKSUM_ON_COPY */
00096 
00097 #ifdef __cplusplus
00098 }
00099 #endif
00100 
00101 #endif /* __LWIP_NETBUF_H__ */