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 
00038 #ifdef __cplusplus
00039 extern "C" {
00040 #endif
00041 
00042 struct netbuf {
00043   struct pbuf *p, *ptr;
00044   struct ip_addr *addr;
00045   u16_t port;
00046 };
00047 
00048 /* Network buffer functions: */
00049 struct netbuf *   netbuf_new      (void);
00050 void              netbuf_delete   (struct netbuf *buf);
00051 void *            netbuf_alloc    (struct netbuf *buf, u16_t size);
00052 void              netbuf_free     (struct netbuf *buf);
00053 err_t             netbuf_ref      (struct netbuf *buf,
00054            const void *dataptr, u16_t size);
00055 void              netbuf_chain    (struct netbuf *head,
00056            struct netbuf *tail);
00057 
00058 u16_t             netbuf_len      (struct netbuf *buf);
00059 err_t             netbuf_data     (struct netbuf *buf,
00060            void **dataptr, u16_t *len);
00061 s8_t              netbuf_next     (struct netbuf *buf);
00062 void              netbuf_first    (struct netbuf *buf);
00063 
00064 
00065 #define netbuf_copy_partial(buf, dataptr, len, offset) \
00066   pbuf_copy_partial((buf)->p, (dataptr), (len), (offset))
00067 #define netbuf_copy(buf,dataptr,len) netbuf_copy_partial(buf, dataptr, len, 0)
00068 #define netbuf_len(buf)              ((buf)->p->tot_len)
00069 #define netbuf_fromaddr(buf)         ((buf)->addr)
00070 #define netbuf_fromport(buf)         ((buf)->port)
00071 
00072 #ifdef __cplusplus
00073 }
00074 #endif
00075 
00076 #endif /* __LWIP_NETBUF_H__ */