api_msg_msg Struct Reference

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).

#include <api_msg.h>

Data Fields
struct netconn *	conn
	The netconn which to process - always needed: it includes the semaphore which is used to block the application thread until the function finished. More...
err_t	err
	The return value of the function executed in tcpip_thread. More...
union {
struct {
ip_addr_t *   ipaddr
u8_t   local
u16_t *   port
}   ad
	used for do_getaddr More...
struct netbuf *   b
	used for do_send More...
struct {
ip_addr_t *   ipaddr
u16_t   port
}   bc
	used for do_bind and do_connect More...
struct {
u8_t   proto
}   n
	used for do_newconn More...
struct {
u32_t   len
}   r
	used for do_recv More...
struct {
u8_t   shut
}   sd
	used for do_close (/shutdown) More...
struct {
u8_t   apiflags
const void *   dataptr
size_t   len
}   w
	used for do_write More...
}	msg
	Depending on the executed function, one of these union members is used. More...

struct { ... } api_msg_msg::ad

used for do_getaddr

Referenced by do_getaddr(), and netconn_getaddr().

u8_t api_msg_msg::apiflags

struct netbuf* api_msg_msg::b

used for do_send

Referenced by do_send(), and netconn_send().

struct { ... } api_msg_msg::bc

used for do_bind and do_connect

Referenced by do_bind(), do_connect(), netconn_bind(), and netconn_connect().

struct netconn* api_msg_msg::conn

The netconn which to process - always needed: it includes the semaphore which is used to block the application thread until the function finished.

Referenced by do_bind(), do_close(), do_connect(), do_delconn(), do_disconnect(), do_getaddr(), do_listen(), do_newconn(), do_recv(), do_send(), do_write(), netconn_accept(), netconn_bind(), netconn_close_shutdown(), netconn_connect(), netconn_delete(), netconn_disconnect(), netconn_getaddr(), netconn_listen_with_backlog(), netconn_new_with_proto_and_callback(), netconn_recv_data(), netconn_recved(), netconn_send(), netconn_write(), pcb_new(), and tcpip_apimsg().

const void* api_msg_msg::dataptr

err_t api_msg_msg::err

The return value of the function executed in tcpip_thread.

Referenced by do_bind(), do_close(), do_close_internal(), do_connect(), do_connected(), do_delconn(), do_disconnect(), do_getaddr(), do_listen(), do_newconn(), do_recv(), do_send(), do_write(), do_writemore(), err_tcp(), pcb_new(), and tcpip_apimsg().

ip_addr_t* api_msg_msg::ipaddr

size_t api_msg_msg::len

u32_t api_msg_msg::len

u8_t api_msg_msg::local

union { ... } api_msg_msg::msg

Depending on the executed function, one of these union members is used.

Referenced by do_bind(), do_close(), do_close_internal(), do_connect(), do_delconn(), do_getaddr(), do_listen(), do_recv(), do_send(), do_write(), do_writemore(), netconn_bind(), netconn_close_shutdown(), netconn_connect(), netconn_getaddr(), netconn_listen_with_backlog(), netconn_new_with_proto_and_callback(), netconn_recv_data(), netconn_recved(), netconn_send(), netconn_write(), and pcb_new().

struct { ... } api_msg_msg::n

used for do_newconn

Referenced by netconn_new_with_proto_and_callback(), and pcb_new().

u16_t api_msg_msg::port

u16_t* api_msg_msg::port

u8_t api_msg_msg::proto

struct { ... } api_msg_msg::r

used for do_recv

Referenced by do_recv(), netconn_recv_data(), and netconn_recved().

struct { ... } api_msg_msg::sd

used for do_close (/shutdown)

Referenced by do_close(), do_close_internal(), do_delconn(), and netconn_close_shutdown().

u8_t api_msg_msg::shut

struct { ... } api_msg_msg::w

used for do_write

Referenced by do_write(), do_writemore(), and netconn_write().