netconn Struct Reference

A netconn descriptor.

#include <api.h>

Data Fields
sys_mbox_t	acceptmbox
	mbox where new connections are stored until processed by the application thread More...
netconn_callback	callback
	A callback function that is informed about events for this netconn. More...
struct api_msg_msg *	current_msg
	TCP: when data passed to netconn_write doesn't fit into the send buffer, this temporarily stores the message. More...
u8_t	flags
	only used for socket layer More...
err_t	last_err
	the last error this netconn had More...
sys_sem_t	op_completed
	sem that is used to synchronously execute functions in the core context More...
union {
struct ip_pcb *   ip
struct raw_pcb *   raw
struct tcp_pcb *   tcp
struct udp_pcb *   udp
}	pcb
	the lwIP internal protocol control block More...
sys_mbox_t	recvmbox
	mbox where received packets are stored until they are fetched by the netconn application thread (can grow quite big) More...
enum netconn_state	state
	current state of the netconn More...
enum netconn_type	type
	type of the netconn (TCP, UDP or RAW) More...
size_t	write_offset
	TCP: when data passed to netconn_write doesn't fit into the send buffer, this temporarily stores how much is already sent. More...

sys_mbox_t netconn::acceptmbox

mbox where new connections are stored until processed by the application thread

Referenced by accept_function(), err_tcp(), lwip_netconn_do_listen(), netconn_accept(), netconn_alloc(), netconn_drain(), netconn_free(), and netconn_new_with_proto_and_callback().

netconn_callback netconn::callback

A callback function that is informed about events for this netconn.

Referenced by accept_function(), and netconn_alloc().

struct api_msg_msg* netconn::current_msg

TCP: when data passed to netconn_write doesn't fit into the send buffer, this temporarily stores the message.

Also used during connect and close.

Referenced by err_tcp(), lwip_netconn_do_close(), lwip_netconn_do_close_internal(), lwip_netconn_do_connect(), lwip_netconn_do_connected(), lwip_netconn_do_delconn(), lwip_netconn_do_write(), lwip_netconn_do_writemore(), and netconn_alloc().

u8_t netconn::flags

only used for socket layer

flags holding more netconn-internal state, see NETCONN_FLAG_* defines

Referenced by lwip_netconn_do_listen(), lwip_netconn_do_write(), lwip_netconn_do_writemore(), netconn_alloc(), poll_tcp(), and sent_tcp().

struct ip_pcb* netconn::ip

Referenced by lwip_netconn_do_getaddr(), lwip_netconn_do_send(), netconn_sendto(), and pcb_new().

err_t netconn::last_err

the last error this netconn had

Referenced by accept_function(), err_tcp(), lwip_netconn_do_bind(), lwip_netconn_do_join_leave_group(), lwip_netconn_do_listen(), lwip_netconn_do_send(), lwip_netconn_do_write(), netconn_accept(), netconn_alloc(), and netconn_recv_data().

sys_sem_t netconn::op_completed

sem that is used to synchronously execute functions in the core context

Referenced by netconn_alloc(), netconn_free(), and netconn_new_with_proto_and_callback().

union { ... } netconn::pcb

the lwIP internal protocol control block

Referenced by accept_function(), err_tcp(), lwip_netconn_do_bind(), lwip_netconn_do_close(), lwip_netconn_do_close_internal(), lwip_netconn_do_connect(), lwip_netconn_do_delconn(), lwip_netconn_do_disconnect(), lwip_netconn_do_getaddr(), lwip_netconn_do_join_leave_group(), lwip_netconn_do_listen(), lwip_netconn_do_newconn(), lwip_netconn_do_recv(), lwip_netconn_do_send(), lwip_netconn_do_write(), lwip_netconn_do_writemore(), netconn_alloc(), netconn_drain(), netconn_free(), netconn_new_with_proto_and_callback(), netconn_sendto(), pcb_new(), poll_tcp(), recv_tcp(), recv_udp(), sent_tcp(), and setup_tcp().

struct raw_pcb* netconn::raw

Referenced by lwip_netconn_do_bind(), lwip_netconn_do_connect(), lwip_netconn_do_delconn(), lwip_netconn_do_getaddr(), lwip_netconn_do_send(), and pcb_new().

sys_mbox_t netconn::recvmbox

mbox where received packets are stored until they are fetched by the netconn application thread (can grow quite big)

Referenced by accept_function(), err_tcp(), lwip_netconn_do_listen(), netconn_alloc(), netconn_drain(), netconn_free(), netconn_new_with_proto_and_callback(), netconn_recv(), netconn_recv_data(), recv_raw(), recv_tcp(), and recv_udp().

enum netconn_state netconn::state

current state of the netconn

Referenced by err_tcp(), lwip_netconn_do_close(), lwip_netconn_do_close_internal(), lwip_netconn_do_connect(), lwip_netconn_do_connected(), lwip_netconn_do_delconn(), lwip_netconn_do_listen(), lwip_netconn_do_write(), lwip_netconn_do_writemore(), netconn_alloc(), poll_tcp(), and sent_tcp().

struct tcp_pcb* netconn::tcp

Referenced by accept_function(), err_tcp(), lwip_netconn_do_bind(), lwip_netconn_do_close(), lwip_netconn_do_close_internal(), lwip_netconn_do_connect(), lwip_netconn_do_delconn(), lwip_netconn_do_getaddr(), lwip_netconn_do_join_leave_group(), lwip_netconn_do_listen(), lwip_netconn_do_newconn(), lwip_netconn_do_recv(), lwip_netconn_do_send(), lwip_netconn_do_write(), lwip_netconn_do_writemore(), netconn_alloc(), netconn_drain(), netconn_free(), netconn_new_with_proto_and_callback(), pcb_new(), poll_tcp(), recv_tcp(), sent_tcp(), and setup_tcp().

enum netconn_type netconn::type

type of the netconn (TCP, UDP or RAW)

Referenced by accept_function(), lwip_netconn_do_bind(), lwip_netconn_do_close(), lwip_netconn_do_close_internal(), lwip_netconn_do_connect(), lwip_netconn_do_connected(), lwip_netconn_do_delconn(), lwip_netconn_do_disconnect(), lwip_netconn_do_getaddr(), lwip_netconn_do_join_leave_group(), lwip_netconn_do_listen(), lwip_netconn_do_recv(), lwip_netconn_do_send(), lwip_netconn_do_write(), netconn_alloc(), netconn_connect(), netconn_drain(), netconn_recv(), netconn_recv_data(), netconn_recved(), netconn_write_partly(), and pcb_new().

struct udp_pcb* netconn::udp

Referenced by lwip_netconn_do_bind(), lwip_netconn_do_connect(), lwip_netconn_do_delconn(), lwip_netconn_do_disconnect(), lwip_netconn_do_getaddr(), lwip_netconn_do_join_leave_group(), lwip_netconn_do_send(), pcb_new(), and recv_udp().

size_t netconn::write_offset

TCP: when data passed to netconn_write doesn't fit into the send buffer, this temporarily stores how much is already sent.

Referenced by lwip_netconn_do_close(), lwip_netconn_do_delconn(), lwip_netconn_do_write(), lwip_netconn_do_writemore(), and netconn_alloc().