/* * Copyright (c) 2001-2004 Swedish Institute of Computer Science. * All rights reserved.  *  * Redistribution and use in source and binary forms, with or without modification,  * are permitted provided that the following conditions are met: * * 1. Redistributions of source code must retain the above copyright notice, *    this list of conditions and the following disclaimer. * 2. Redistributions in binary form must reproduce the above copyright notice, *    this list of conditions and the following disclaimer in the documentation *    and/or other materials provided with the distribution. * 3. The name of the author may not be used to endorse or promote products *    derived from this software without specific prior written permission.  * * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT  * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT  * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY  * OF SUCH DAMAGE. * * This file is part of the lwIP TCP/IP stack. *  * Author: Adam Dunkels <adam@sics.se> * */#ifndef __LWIP_API_MSG_H__#define __LWIP_API_MSG_H__#include "lwip/opt.h"#if LWIP_NETCONN /* don't build if not configured for use in lwipopts.h */#include "lwip/ip_addr.h"#include "lwip/err.h"#include "lwip/sys.h"#include "lwip/igmp.h"#include "lwip/api.h"#ifdef __cplusplusextern "C" {#endif/* IP addresses and port numbers are expected to be in * the same byte order as in the corresponding pcb. *//** This struct includes everything that is necessary to execute a function    for a netconn in another thread context (mainly used to process netconns    in the tcpip_thread context to be thread safe). */struct api_msg_msg {  /** The netconn which to process - always needed: it includes the semaphore      which is used to block the application thread until the function finished. */  struct netconn *conn;  /** Depending on the executed function, one of these union members is used */  union {    /** used for do_send */    struct netbuf *b;    /** used for do_newconn */    struct {      u8_t proto;    } n;    /** used for do_bind and do_connect */    struct {      struct ip_addr *ipaddr;      u16_t port;    } bc;    /** used for do_getaddr */    struct {      struct ip_addr *ipaddr;      u16_t *port;      u8_t local;    } ad;    /** used for do_write */    struct {      const void *dataptr;      int len;      u8_t apiflags;    } w;    /** used ofr do_recv */    struct {      u16_t len;    } r;#if LWIP_IGMP    /** used for do_join_leave_group */    struct {      struct ip_addr *multiaddr;      struct ip_addr *interface;      enum netconn_igmp join_or_leave;    } jl;#endif /* LWIP_IGMP */#if TCP_LISTEN_BACKLOG    struct {      u8_t backlog;    } lb;#endif /* TCP_LISTEN_BACKLOG */  } msg;};/** This struct contains a function to execute in another thread context and    a struct api_msg_msg that serves as an argument for this function.    This is passed to tcpip_apimsg to execute functions in tcpip_thread context. */struct api_msg {  /** function to execute in tcpip_thread context */  void (* function)(struct api_msg_msg *msg);  /** arguments for this function */  struct api_msg_msg msg;};#if LWIP_DNS/** As do_gethostbyname requires more arguments but doesn't require a netconn,    it has its own struct (to avoid struct api_msg getting bigger than necessary).    do_gethostbyname must be called using tcpip_callback instead of tcpip_apimsg    (see netconn_gethostbyname). */struct dns_api_msg {  /** Hostname to query or dotted IP address string */  const char *name;  /** Rhe resolved address is stored here */  struct ip_addr *addr;  /** This semaphore is posted when the name is resolved, the application thread      should wait on it. */  sys_sem_t sem;  /** Errors are given back here */  err_t *err;};#endif /* LWIP_DNS */void do_newconn         ( struct api_msg_msg *msg);void do_delconn         ( struct api_msg_msg *msg);void do_bind            ( struct api_msg_msg *msg);void do_connect         ( struct api_msg_msg *msg);void do_disconnect      ( struct api_msg_msg *msg);void do_listen          ( struct api_msg_msg *msg);void do_send            ( struct api_msg_msg *msg);void do_recv            ( struct api_msg_msg *msg);void do_write           ( struct api_msg_msg *msg);void do_getaddr         ( struct api_msg_msg *msg);void do_close           ( struct api_msg_msg *msg);#if LWIP_IGMPvoid do_join_leave_group( struct api_msg_msg *msg);#endif /* LWIP_IGMP */#if LWIP_DNSvoid do_gethostbyname(void *arg);#endif /* LWIP_DNS */struct netconn* netconn_alloc(enum netconn_type t, netconn_callback callback);void netconn_free(struct netconn *conn);#ifdef __cplusplus}#endif#endif /* LWIP_NETCONN */#endif /* __LWIP_API_MSG_H__ */