api.h
上传用户:yyhongfa
上传日期:2013-01-18
资源大小:267k
文件大小:5k
开发平台:

C/C++

  1. /*
  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. #include "lwip/opt.h"
  35. #include "lwip/pbuf.h"
  36. #include "lwip/sys.h"
  37. #include "lwip/ip.h"
  38. #include "lwip/raw.h"
  39. #include "lwip/udp.h"
  40. #include "lwip/tcp.h"
  41. #include "lwip/err.h"
  42. #define NETCONN_NOCOPY 0x00
  43. #define NETCONN_COPY   0x01
  44. enum netconn_type {
  45.   NETCONN_TCP,
  46.   NETCONN_UDP,
  47.   NETCONN_UDPLITE,
  48.   NETCONN_UDPNOCHKSUM,
  49.   NETCONN_RAW
  50. };
  51. enum netconn_state {
  52.   NETCONN_NONE,
  53.   NETCONN_WRITE,
  54.   NETCONN_ACCEPT,
  55.   NETCONN_RECV,
  56.   NETCONN_CONNECT,
  57.   NETCONN_CLOSE
  58. };
  59. enum netconn_evt {
  60.   NETCONN_EVT_RCVPLUS,
  61.   NETCONN_EVT_RCVMINUS,
  62.   NETCONN_EVT_SENDPLUS,
  63.   NETCONN_EVT_SENDMINUS
  64. };
  65. struct netbuf {
  66.   struct pbuf *p, *ptr;
  67.   struct ip_addr *fromaddr;
  68.   u16_t fromport;
  69.   err_t err;
  70. };
  71. struct netconn {
  72.   enum netconn_type type;
  73.   enum netconn_state state;
  74.   union {
  75.     struct tcp_pcb *tcp;
  76.     struct udp_pcb *udp;
  77.     struct raw_pcb *raw;
  78.   } pcb;
  79.   err_t err;
  80.   sys_mbox_t mbox;
  81.   sys_mbox_t recvmbox;
  82.   sys_mbox_t acceptmbox;
  83.   sys_sem_t sem;
  84.   int socket;
  85.   u16_t recv_avail;
  86.   void (* callback)(struct netconn *, enum netconn_evt, u16_t len);
  87. };
  88. /* Network buffer functions: */
  89. struct netbuf *   netbuf_new      (void);
  90. void              netbuf_delete   (struct netbuf *buf);
  91. void *            netbuf_alloc    (struct netbuf *buf, u16_t size);
  92. void              netbuf_free     (struct netbuf *buf);
  93. void              netbuf_ref      (struct netbuf *buf,
  94.            void *dataptr, u16_t size);
  95. void              netbuf_chain    (struct netbuf *head,
  96.            struct netbuf *tail);
  97. u16_t             netbuf_len      (struct netbuf *buf);
  98. err_t             netbuf_data     (struct netbuf *buf,
  99.            void **dataptr, u16_t *len);
  100. s8_t              netbuf_next     (struct netbuf *buf);
  101. void              netbuf_first    (struct netbuf *buf);
  102. void              netbuf_copy     (struct netbuf *buf,
  103.            void *dataptr, u16_t len);
  104. void              netbuf_copy_partial(struct netbuf *buf, void *dataptr, 
  105.               u16_t len, u16_t offset);
  106. struct ip_addr *  netbuf_fromaddr (struct netbuf *buf);
  107. u16_t             netbuf_fromport (struct netbuf *buf);
  108. /* Network connection functions: */
  109. struct netconn *  netconn_new     (enum netconn_type type);
  110. struct
  111. netconn *netconn_new_with_callback(enum netconn_type t,
  112.                                    void (*callback)(struct netconn *, enum netconn_evt, u16_t len));
  113. struct
  114. netconn *netconn_new_with_proto_and_callback(enum netconn_type t, u16_t proto,
  115.                                    void (*callback)(struct netconn *, enum netconn_evt, u16_t len));
  116. err_t             netconn_delete  (struct netconn *conn);
  117. enum netconn_type netconn_type    (struct netconn *conn);
  118. err_t             netconn_peer    (struct netconn *conn,
  119.            struct ip_addr *addr,
  120.            u16_t *port);
  121. err_t             netconn_addr    (struct netconn *conn,
  122.            struct ip_addr **addr,
  123.            u16_t *port);
  124. err_t             netconn_bind    (struct netconn *conn,
  125.            struct ip_addr *addr,
  126.            u16_t port);
  127. err_t             netconn_connect (struct netconn *conn,
  128.            struct ip_addr *addr,
  129.            u16_t port);
  130. err_t             netconn_disconnect (struct netconn *conn);
  131. err_t             netconn_listen  (struct netconn *conn);
  132. struct netconn *  netconn_accept  (struct netconn *conn);
  133. struct netbuf *   netconn_recv    (struct netconn *conn);
  134. err_t             netconn_send    (struct netconn *conn,
  135.            struct netbuf *buf);
  136. err_t             netconn_write   (struct netconn *conn,
  137.            void *dataptr, u16_t size,
  138.            u8_t copy);
  139. err_t             netconn_close   (struct netconn *conn);
  140. err_t             netconn_err     (struct netconn *conn);
  141. #endif /* __LWIP_API_H__ */