« Back to documentation index
netconn Struct Reference
A netconn descriptor.
More...
#include <api.h >
enum netconn_type type type of the netconn (TCP, UDP or RAW) enum netconn_state state current state of the netconn err_t last_err the last error this netconn had sys_sem_t op_completed sem that is used to synchroneously execute functions in the core context sys_mbox_t recvmbox mbox where received packets are stored until they are fetched by the netconn application thread (can grow quite big) sys_mbox_t acceptmbox mbox where new connections are stored until processed by the application thread int socket only used for socket layer int recv_timeout timeout to wait for new data to be received (or connections to arrive for listening netconns) int recv_bufsize maximum amount of bytes queued in recvmbox not used for TCP: adjust TCP_WND instead! s16_t recv_avail number of bytes currently in recvmbox to be received, tested against recv_bufsize to limit bytes on recvmbox for UDP and RAW, used for FIONREAD u8_t flags flags holding more netconn-internal state, see NETCONN_FLAG_* defines 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. 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. netconn_callback callback A callback function that is informed about events for this netconn.
Detailed Description
A netconn descriptor.
Definition at line 134 of file api.h .
Field Documentation
mbox where new connections are stored until processed by the application thread
Definition at line 156 of file api.h .
A callback function that is informed about events for this netconn.
Definition at line 188 of file api.h .
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.
Definition at line 185 of file api.h .
flags holding more netconn-internal state, see NETCONN_FLAG_* defines
Definition at line 177 of file api.h .
the last error this netconn had
Definition at line 147 of file api.h .
sem that is used to synchroneously execute functions in the core context
Definition at line 149 of file api.h .
number of bytes currently in recvmbox to be received, tested against recv_bufsize to limit bytes on recvmbox for UDP and RAW, used for FIONREAD
Definition at line 174 of file api.h .
maximum amount of bytes queued in recvmbox not used for TCP: adjust TCP_WND instead!
Definition at line 170 of file api.h .
timeout to wait for new data to be received (or connections to arrive for listening netconns)
Definition at line 165 of file api.h .
mbox where received packets are stored until they are fetched by the netconn application thread (can grow quite big)
Definition at line 152 of file api.h .
only used for socket layer
Definition at line 160 of file api.h .
current state of the netconn
Definition at line 138 of file api.h .
type of the netconn (TCP, UDP or RAW)
Definition at line 136 of file api.h .
TCP: when data passed to netconn_write doesn't fit into the send buffer, this temporarily stores how much is already sent.
Definition at line 181 of file api.h .
1.7.2