| 1 | 583 | jeremybenn | /*
 | 
      
         | 2 |  |  |  * Copyright (c) 2001-2004 Swedish Institute of Computer Science.
 | 
      
         | 3 |  |  |  * All rights reserved.
 | 
      
         | 4 |  |  |  *
 | 
      
         | 5 |  |  |  * Redistribution and use in source and binary forms, with or without modification,
 | 
      
         | 6 |  |  |  * are permitted provided that the following conditions are met:
 | 
      
         | 7 |  |  |  *
 | 
      
         | 8 |  |  |  * 1. Redistributions of source code must retain the above copyright notice,
 | 
      
         | 9 |  |  |  *    this list of conditions and the following disclaimer.
 | 
      
         | 10 |  |  |  * 2. Redistributions in binary form must reproduce the above copyright notice,
 | 
      
         | 11 |  |  |  *    this list of conditions and the following disclaimer in the documentation
 | 
      
         | 12 |  |  |  *    and/or other materials provided with the distribution.
 | 
      
         | 13 |  |  |  * 3. The name of the author may not be used to endorse or promote products
 | 
      
         | 14 |  |  |  *    derived from this software without specific prior written permission.
 | 
      
         | 15 |  |  |  *
 | 
      
         | 16 |  |  |  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
 | 
      
         | 17 |  |  |  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 | 
      
         | 18 |  |  |  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
 | 
      
         | 19 |  |  |  * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 | 
      
         | 20 |  |  |  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
 | 
      
         | 21 |  |  |  * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 | 
      
         | 22 |  |  |  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 | 
      
         | 23 |  |  |  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
 | 
      
         | 24 |  |  |  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
 | 
      
         | 25 |  |  |  * OF SUCH DAMAGE.
 | 
      
         | 26 |  |  |  *
 | 
      
         | 27 |  |  |  * This file is part of the lwIP TCP/IP stack.
 | 
      
         | 28 |  |  |  *
 | 
      
         | 29 |  |  |  * Author: Adam Dunkels <adam@sics.se>
 | 
      
         | 30 |  |  |  *
 | 
      
         | 31 |  |  |  */
 | 
      
         | 32 |  |  | #ifndef __LWIP_API_H__
 | 
      
         | 33 |  |  | #define __LWIP_API_H__
 | 
      
         | 34 |  |  |  
 | 
      
         | 35 |  |  | #include "lwip/opt.h"
 | 
      
         | 36 |  |  | #include "lwip/pbuf.h"
 | 
      
         | 37 |  |  | #include "lwip/sys.h"
 | 
      
         | 38 |  |  |  
 | 
      
         | 39 |  |  | #include "lwip/ip.h"
 | 
      
         | 40 |  |  |  
 | 
      
         | 41 |  |  | #include "lwip/raw.h"
 | 
      
         | 42 |  |  | #include "lwip/udp.h"
 | 
      
         | 43 |  |  | #include "lwip/tcp.h"
 | 
      
         | 44 |  |  |  
 | 
      
         | 45 |  |  | #include "lwip/err.h"
 | 
      
         | 46 |  |  |  
 | 
      
         | 47 |  |  | #define NETCONN_NOCOPY 0x00
 | 
      
         | 48 |  |  | #define NETCONN_COPY   0x01
 | 
      
         | 49 |  |  |  
 | 
      
         | 50 |  |  | enum netconn_type {
 | 
      
         | 51 |  |  |   NETCONN_TCP,
 | 
      
         | 52 |  |  |   NETCONN_UDP,
 | 
      
         | 53 |  |  |   NETCONN_UDPLITE,
 | 
      
         | 54 |  |  |   NETCONN_UDPNOCHKSUM,
 | 
      
         | 55 |  |  |   NETCONN_RAW
 | 
      
         | 56 |  |  | };
 | 
      
         | 57 |  |  |  
 | 
      
         | 58 |  |  | enum netconn_state {
 | 
      
         | 59 |  |  |   NETCONN_NONE,
 | 
      
         | 60 |  |  |   NETCONN_WRITE,
 | 
      
         | 61 |  |  |   NETCONN_ACCEPT,
 | 
      
         | 62 |  |  |   NETCONN_RECV,
 | 
      
         | 63 |  |  |   NETCONN_CONNECT,
 | 
      
         | 64 |  |  |   NETCONN_CLOSE
 | 
      
         | 65 |  |  | };
 | 
      
         | 66 |  |  |  
 | 
      
         | 67 |  |  | enum netconn_evt {
 | 
      
         | 68 |  |  |   NETCONN_EVT_RCVPLUS,
 | 
      
         | 69 |  |  |   NETCONN_EVT_RCVMINUS,
 | 
      
         | 70 |  |  |   NETCONN_EVT_SENDPLUS,
 | 
      
         | 71 |  |  |   NETCONN_EVT_SENDMINUS
 | 
      
         | 72 |  |  | };
 | 
      
         | 73 |  |  |  
 | 
      
         | 74 |  |  | struct netbuf {
 | 
      
         | 75 |  |  |   struct pbuf *p, *ptr;
 | 
      
         | 76 |  |  |   struct ip_addr *fromaddr;
 | 
      
         | 77 |  |  |   u16_t fromport;
 | 
      
         | 78 |  |  |   err_t err;
 | 
      
         | 79 |  |  | };
 | 
      
         | 80 |  |  |  
 | 
      
         | 81 |  |  | struct netconn {
 | 
      
         | 82 |  |  |   enum netconn_type type;
 | 
      
         | 83 |  |  |   enum netconn_state state;
 | 
      
         | 84 |  |  |   union {
 | 
      
         | 85 |  |  |     struct tcp_pcb *tcp;
 | 
      
         | 86 |  |  |     struct udp_pcb *udp;
 | 
      
         | 87 |  |  |     struct raw_pcb *raw;
 | 
      
         | 88 |  |  |   } pcb;
 | 
      
         | 89 |  |  |   err_t err;
 | 
      
         | 90 |  |  |   sys_mbox_t mbox;
 | 
      
         | 91 |  |  |   sys_mbox_t recvmbox;
 | 
      
         | 92 |  |  |   sys_mbox_t acceptmbox;
 | 
      
         | 93 |  |  |   sys_sem_t sem;
 | 
      
         | 94 |  |  |   int socket;
 | 
      
         | 95 |  |  |   u16_t recv_avail;
 | 
      
         | 96 |  |  |   void (* callback)(struct netconn *, enum netconn_evt, u16_t len);
 | 
      
         | 97 |  |  | };
 | 
      
         | 98 |  |  |  
 | 
      
         | 99 |  |  | /* Network buffer functions: */
 | 
      
         | 100 |  |  | struct netbuf *   netbuf_new      (void);
 | 
      
         | 101 |  |  | void              netbuf_delete   (struct netbuf *buf);
 | 
      
         | 102 |  |  | void *            netbuf_alloc    (struct netbuf *buf, u16_t size);
 | 
      
         | 103 |  |  | void              netbuf_free     (struct netbuf *buf);
 | 
      
         | 104 |  |  | void              netbuf_ref      (struct netbuf *buf,
 | 
      
         | 105 |  |  |            void *dataptr, u16_t size);
 | 
      
         | 106 |  |  | void              netbuf_chain    (struct netbuf *head,
 | 
      
         | 107 |  |  |            struct netbuf *tail);
 | 
      
         | 108 |  |  |  
 | 
      
         | 109 |  |  | u16_t             netbuf_len      (struct netbuf *buf);
 | 
      
         | 110 |  |  | err_t             netbuf_data     (struct netbuf *buf,
 | 
      
         | 111 |  |  |            void **dataptr, u16_t *len);
 | 
      
         | 112 |  |  | s8_t              netbuf_next     (struct netbuf *buf);
 | 
      
         | 113 |  |  | void              netbuf_first    (struct netbuf *buf);
 | 
      
         | 114 |  |  |  
 | 
      
         | 115 |  |  | void              netbuf_copy     (struct netbuf *buf,
 | 
      
         | 116 |  |  |            void *dataptr, u16_t len);
 | 
      
         | 117 |  |  | void              netbuf_copy_partial(struct netbuf *buf, void *dataptr,
 | 
      
         | 118 |  |  |               u16_t len, u16_t offset);
 | 
      
         | 119 |  |  | struct ip_addr *  netbuf_fromaddr (struct netbuf *buf);
 | 
      
         | 120 |  |  | u16_t             netbuf_fromport (struct netbuf *buf);
 | 
      
         | 121 |  |  |  
 | 
      
         | 122 |  |  | /* Network connection functions: */
 | 
      
         | 123 |  |  | struct netconn *  netconn_new     (enum netconn_type type);
 | 
      
         | 124 |  |  | struct
 | 
      
         | 125 |  |  | netconn *netconn_new_with_callback(enum netconn_type t,
 | 
      
         | 126 |  |  |                                    void (*callback)(struct netconn *, enum netconn_evt, u16_t len));
 | 
      
         | 127 |  |  | struct
 | 
      
         | 128 |  |  | netconn *netconn_new_with_proto_and_callback(enum netconn_type t, u16_t proto,
 | 
      
         | 129 |  |  |                                    void (*callback)(struct netconn *, enum netconn_evt, u16_t len));
 | 
      
         | 130 |  |  | err_t             netconn_delete  (struct netconn *conn);
 | 
      
         | 131 |  |  | enum netconn_type netconn_type    (struct netconn *conn);
 | 
      
         | 132 |  |  | err_t             netconn_peer    (struct netconn *conn,
 | 
      
         | 133 |  |  |            struct ip_addr *addr,
 | 
      
         | 134 |  |  |            u16_t *port);
 | 
      
         | 135 |  |  | err_t             netconn_addr    (struct netconn *conn,
 | 
      
         | 136 |  |  |            struct ip_addr **addr,
 | 
      
         | 137 |  |  |            u16_t *port);
 | 
      
         | 138 |  |  | err_t             netconn_bind    (struct netconn *conn,
 | 
      
         | 139 |  |  |            struct ip_addr *addr,
 | 
      
         | 140 |  |  |            u16_t port);
 | 
      
         | 141 |  |  | err_t             netconn_connect (struct netconn *conn,
 | 
      
         | 142 |  |  |            struct ip_addr *addr,
 | 
      
         | 143 |  |  |            u16_t port);
 | 
      
         | 144 |  |  | err_t             netconn_disconnect (struct netconn *conn);
 | 
      
         | 145 |  |  | err_t             netconn_listen  (struct netconn *conn);
 | 
      
         | 146 |  |  | struct netconn *  netconn_accept  (struct netconn *conn);
 | 
      
         | 147 |  |  | struct netbuf *   netconn_recv    (struct netconn *conn);
 | 
      
         | 148 |  |  | err_t             netconn_send    (struct netconn *conn,
 | 
      
         | 149 |  |  |            struct netbuf *buf);
 | 
      
         | 150 |  |  | err_t             netconn_write   (struct netconn *conn,
 | 
      
         | 151 |  |  |            void *dataptr, u16_t size,
 | 
      
         | 152 |  |  |            u8_t copy);
 | 
      
         | 153 |  |  | err_t             netconn_close   (struct netconn *conn);
 | 
      
         | 154 |  |  |  
 | 
      
         | 155 |  |  | err_t             netconn_err     (struct netconn *conn);
 | 
      
         | 156 |  |  |  
 | 
      
         | 157 |  |  | #endif /* __LWIP_API_H__ */
 | 
      
         | 158 |  |  |  
 | 
      
         | 159 |  |  |  
 |