Nino Der Kinderen / Mbed 2 deprecated InetTest

Embedded C project:18/12/2014

Dependencies:   DS1307 TextLCD mbed

NetServices/lwip/include/lwip/api_msg.h@0:8d87bc453349, 2014-12-18 (annotated)

Committer:
ninoderkinderen
Date:
Thu Dec 18 09:35:49 2014 +0000
Revision:
0:8d87bc453349
Programma embedded C

Who changed what in which revision?

UserRevisionLine numberNew contents of line
ninoderkinderen 0:8d87bc453349 1 /*
ninoderkinderen 0:8d87bc453349 2 * Copyright (c) 2001-2004 Swedish Institute of Computer Science.
ninoderkinderen 0:8d87bc453349 3 * All rights reserved.
ninoderkinderen 0:8d87bc453349 4 *
ninoderkinderen 0:8d87bc453349 5 * Redistribution and use in source and binary forms, with or without modification,
ninoderkinderen 0:8d87bc453349 6 * are permitted provided that the following conditions are met:
ninoderkinderen 0:8d87bc453349 7 *
ninoderkinderen 0:8d87bc453349 8 * 1. Redistributions of source code must retain the above copyright notice,
ninoderkinderen 0:8d87bc453349 9 * this list of conditions and the following disclaimer.
ninoderkinderen 0:8d87bc453349 10 * 2. Redistributions in binary form must reproduce the above copyright notice,
ninoderkinderen 0:8d87bc453349 11 * this list of conditions and the following disclaimer in the documentation
ninoderkinderen 0:8d87bc453349 12 * and/or other materials provided with the distribution.
ninoderkinderen 0:8d87bc453349 13 * 3. The name of the author may not be used to endorse or promote products
ninoderkinderen 0:8d87bc453349 14 * derived from this software without specific prior written permission.
ninoderkinderen 0:8d87bc453349 15 *
ninoderkinderen 0:8d87bc453349 16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
ninoderkinderen 0:8d87bc453349 17 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
ninoderkinderen 0:8d87bc453349 18 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
ninoderkinderen 0:8d87bc453349 19 * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
ninoderkinderen 0:8d87bc453349 20 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
ninoderkinderen 0:8d87bc453349 21 * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
ninoderkinderen 0:8d87bc453349 22 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
ninoderkinderen 0:8d87bc453349 23 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
ninoderkinderen 0:8d87bc453349 24 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
ninoderkinderen 0:8d87bc453349 25 * OF SUCH DAMAGE.
ninoderkinderen 0:8d87bc453349 26 *
ninoderkinderen 0:8d87bc453349 27 * This file is part of the lwIP TCP/IP stack.
ninoderkinderen 0:8d87bc453349 28 *
ninoderkinderen 0:8d87bc453349 29 * Author: Adam Dunkels <adam@sics.se>
ninoderkinderen 0:8d87bc453349 30 *
ninoderkinderen 0:8d87bc453349 31 */
ninoderkinderen 0:8d87bc453349 32 #ifndef __LWIP_API_MSG_H__
ninoderkinderen 0:8d87bc453349 33 #define __LWIP_API_MSG_H__
ninoderkinderen 0:8d87bc453349 34
ninoderkinderen 0:8d87bc453349 35 #include "lwip/opt.h"
ninoderkinderen 0:8d87bc453349 36
ninoderkinderen 0:8d87bc453349 37 #if LWIP_NETCONN /* don't build if not configured for use in lwipopts.h */
ninoderkinderen 0:8d87bc453349 38
ninoderkinderen 0:8d87bc453349 39 #include <stddef.h> /* for size_t */
ninoderkinderen 0:8d87bc453349 40
ninoderkinderen 0:8d87bc453349 41 #include "lwip/ip_addr.h"
ninoderkinderen 0:8d87bc453349 42 #include "lwip/err.h"
ninoderkinderen 0:8d87bc453349 43 #include "lwip/sys.h"
ninoderkinderen 0:8d87bc453349 44 #include "lwip/igmp.h"
ninoderkinderen 0:8d87bc453349 45 #include "lwip/api.h"
ninoderkinderen 0:8d87bc453349 46
ninoderkinderen 0:8d87bc453349 47 #ifdef __cplusplus
ninoderkinderen 0:8d87bc453349 48 extern "C" {
ninoderkinderen 0:8d87bc453349 49 #endif
ninoderkinderen 0:8d87bc453349 50
ninoderkinderen 0:8d87bc453349 51 #define NETCONN_SHUT_RD 1
ninoderkinderen 0:8d87bc453349 52 #define NETCONN_SHUT_WR 2
ninoderkinderen 0:8d87bc453349 53 #define NETCONN_SHUT_RDWR 3
ninoderkinderen 0:8d87bc453349 54
ninoderkinderen 0:8d87bc453349 55 /* IP addresses and port numbers are expected to be in
ninoderkinderen 0:8d87bc453349 56 * the same byte order as in the corresponding pcb.
ninoderkinderen 0:8d87bc453349 57 */
ninoderkinderen 0:8d87bc453349 58 /** This struct includes everything that is necessary to execute a function
ninoderkinderen 0:8d87bc453349 59 for a netconn in another thread context (mainly used to process netconns
ninoderkinderen 0:8d87bc453349 60 in the tcpip_thread context to be thread safe). */
ninoderkinderen 0:8d87bc453349 61 struct api_msg_msg {
ninoderkinderen 0:8d87bc453349 62 /** The netconn which to process - always needed: it includes the semaphore
ninoderkinderen 0:8d87bc453349 63 which is used to block the application thread until the function finished. */
ninoderkinderen 0:8d87bc453349 64 struct netconn *conn;
ninoderkinderen 0:8d87bc453349 65 /** The return value of the function executed in tcpip_thread. */
ninoderkinderen 0:8d87bc453349 66 err_t err;
ninoderkinderen 0:8d87bc453349 67 /** Depending on the executed function, one of these union members is used */
ninoderkinderen 0:8d87bc453349 68 union {
ninoderkinderen 0:8d87bc453349 69 /** used for do_send */
ninoderkinderen 0:8d87bc453349 70 struct netbuf *b;
ninoderkinderen 0:8d87bc453349 71 /** used for do_newconn */
ninoderkinderen 0:8d87bc453349 72 struct {
ninoderkinderen 0:8d87bc453349 73 u8_t proto;
ninoderkinderen 0:8d87bc453349 74 } n;
ninoderkinderen 0:8d87bc453349 75 /** used for do_bind and do_connect */
ninoderkinderen 0:8d87bc453349 76 struct {
ninoderkinderen 0:8d87bc453349 77 ip_addr_t *ipaddr;
ninoderkinderen 0:8d87bc453349 78 u16_t port;
ninoderkinderen 0:8d87bc453349 79 } bc;
ninoderkinderen 0:8d87bc453349 80 /** used for do_getaddr */
ninoderkinderen 0:8d87bc453349 81 struct {
ninoderkinderen 0:8d87bc453349 82 ip_addr_t *ipaddr;
ninoderkinderen 0:8d87bc453349 83 u16_t *port;
ninoderkinderen 0:8d87bc453349 84 u8_t local;
ninoderkinderen 0:8d87bc453349 85 } ad;
ninoderkinderen 0:8d87bc453349 86 /** used for do_write */
ninoderkinderen 0:8d87bc453349 87 struct {
ninoderkinderen 0:8d87bc453349 88 const void *dataptr;
ninoderkinderen 0:8d87bc453349 89 size_t len;
ninoderkinderen 0:8d87bc453349 90 u8_t apiflags;
ninoderkinderen 0:8d87bc453349 91 } w;
ninoderkinderen 0:8d87bc453349 92 /** used for do_recv */
ninoderkinderen 0:8d87bc453349 93 struct {
ninoderkinderen 0:8d87bc453349 94 u32_t len;
ninoderkinderen 0:8d87bc453349 95 } r;
ninoderkinderen 0:8d87bc453349 96 /** used for do_close (/shutdown) */
ninoderkinderen 0:8d87bc453349 97 struct {
ninoderkinderen 0:8d87bc453349 98 u8_t shut;
ninoderkinderen 0:8d87bc453349 99 } sd;
ninoderkinderen 0:8d87bc453349 100 #if LWIP_IGMP
ninoderkinderen 0:8d87bc453349 101 /** used for do_join_leave_group */
ninoderkinderen 0:8d87bc453349 102 struct {
ninoderkinderen 0:8d87bc453349 103 ip_addr_t *multiaddr;
ninoderkinderen 0:8d87bc453349 104 ip_addr_t *netif_addr;
ninoderkinderen 0:8d87bc453349 105 enum netconn_igmp join_or_leave;
ninoderkinderen 0:8d87bc453349 106 } jl;
ninoderkinderen 0:8d87bc453349 107 #endif /* LWIP_IGMP */
ninoderkinderen 0:8d87bc453349 108 #if TCP_LISTEN_BACKLOG
ninoderkinderen 0:8d87bc453349 109 struct {
ninoderkinderen 0:8d87bc453349 110 u8_t backlog;
ninoderkinderen 0:8d87bc453349 111 } lb;
ninoderkinderen 0:8d87bc453349 112 #endif /* TCP_LISTEN_BACKLOG */
ninoderkinderen 0:8d87bc453349 113 } msg;
ninoderkinderen 0:8d87bc453349 114 };
ninoderkinderen 0:8d87bc453349 115
ninoderkinderen 0:8d87bc453349 116 /** This struct contains a function to execute in another thread context and
ninoderkinderen 0:8d87bc453349 117 a struct api_msg_msg that serves as an argument for this function.
ninoderkinderen 0:8d87bc453349 118 This is passed to tcpip_apimsg to execute functions in tcpip_thread context. */
ninoderkinderen 0:8d87bc453349 119 struct api_msg {
ninoderkinderen 0:8d87bc453349 120 /** function to execute in tcpip_thread context */
ninoderkinderen 0:8d87bc453349 121 void (* function)(struct api_msg_msg *msg);
ninoderkinderen 0:8d87bc453349 122 /** arguments for this function */
ninoderkinderen 0:8d87bc453349 123 struct api_msg_msg msg;
ninoderkinderen 0:8d87bc453349 124 };
ninoderkinderen 0:8d87bc453349 125
ninoderkinderen 0:8d87bc453349 126 #if LWIP_DNS
ninoderkinderen 0:8d87bc453349 127 /** As do_gethostbyname requires more arguments but doesn't require a netconn,
ninoderkinderen 0:8d87bc453349 128 it has its own struct (to avoid struct api_msg getting bigger than necessary).
ninoderkinderen 0:8d87bc453349 129 do_gethostbyname must be called using tcpip_callback instead of tcpip_apimsg
ninoderkinderen 0:8d87bc453349 130 (see netconn_gethostbyname). */
ninoderkinderen 0:8d87bc453349 131 struct dns_api_msg {
ninoderkinderen 0:8d87bc453349 132 /** Hostname to query or dotted IP address string */
ninoderkinderen 0:8d87bc453349 133 const char *name;
ninoderkinderen 0:8d87bc453349 134 /** Rhe resolved address is stored here */
ninoderkinderen 0:8d87bc453349 135 ip_addr_t *addr;
ninoderkinderen 0:8d87bc453349 136 /** This semaphore is posted when the name is resolved, the application thread
ninoderkinderen 0:8d87bc453349 137 should wait on it. */
ninoderkinderen 0:8d87bc453349 138 sys_sem_t *sem;
ninoderkinderen 0:8d87bc453349 139 /** Errors are given back here */
ninoderkinderen 0:8d87bc453349 140 err_t *err;
ninoderkinderen 0:8d87bc453349 141 };
ninoderkinderen 0:8d87bc453349 142 #endif /* LWIP_DNS */
ninoderkinderen 0:8d87bc453349 143
ninoderkinderen 0:8d87bc453349 144 void do_newconn ( struct api_msg_msg *msg);
ninoderkinderen 0:8d87bc453349 145 void do_delconn ( struct api_msg_msg *msg);
ninoderkinderen 0:8d87bc453349 146 void do_bind ( struct api_msg_msg *msg);
ninoderkinderen 0:8d87bc453349 147 void do_connect ( struct api_msg_msg *msg);
ninoderkinderen 0:8d87bc453349 148 void do_disconnect ( struct api_msg_msg *msg);
ninoderkinderen 0:8d87bc453349 149 void do_listen ( struct api_msg_msg *msg);
ninoderkinderen 0:8d87bc453349 150 void do_send ( struct api_msg_msg *msg);
ninoderkinderen 0:8d87bc453349 151 void do_recv ( struct api_msg_msg *msg);
ninoderkinderen 0:8d87bc453349 152 void do_write ( struct api_msg_msg *msg);
ninoderkinderen 0:8d87bc453349 153 void do_getaddr ( struct api_msg_msg *msg);
ninoderkinderen 0:8d87bc453349 154 void do_close ( struct api_msg_msg *msg);
ninoderkinderen 0:8d87bc453349 155 void do_shutdown ( struct api_msg_msg *msg);
ninoderkinderen 0:8d87bc453349 156 #if LWIP_IGMP
ninoderkinderen 0:8d87bc453349 157 void do_join_leave_group( struct api_msg_msg *msg);
ninoderkinderen 0:8d87bc453349 158 #endif /* LWIP_IGMP */
ninoderkinderen 0:8d87bc453349 159
ninoderkinderen 0:8d87bc453349 160 #if LWIP_DNS
ninoderkinderen 0:8d87bc453349 161 void do_gethostbyname(void *arg);
ninoderkinderen 0:8d87bc453349 162 #endif /* LWIP_DNS */
ninoderkinderen 0:8d87bc453349 163
ninoderkinderen 0:8d87bc453349 164 struct netconn* netconn_alloc(enum netconn_type t, netconn_callback callback);
ninoderkinderen 0:8d87bc453349 165 void netconn_free(struct netconn *conn);
ninoderkinderen 0:8d87bc453349 166
ninoderkinderen 0:8d87bc453349 167 #ifdef __cplusplus
ninoderkinderen 0:8d87bc453349 168 }
ninoderkinderen 0:8d87bc453349 169 #endif
ninoderkinderen 0:8d87bc453349 170
ninoderkinderen 0:8d87bc453349 171 #endif /* LWIP_NETCONN */
ninoderkinderen 0:8d87bc453349 172
ninoderkinderen 0:8d87bc453349 173 #endif /* __LWIP_API_MSG_H__ */