Marco Zecchini
Rtos API example
netconn Struct Reference
A netconn descriptor. More...
#include <api.h>
Data Fields | |
| 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 synchronously 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 | |
| s32_t | send_timeout |
| timeout to wait for sending data (which means enqueueing data for sending in internal buffers) in milliseconds | |
| int | recv_timeout |
| timeout in milliseconds 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! | |
| int | 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 | |
| s16_t | linger |
| values <0 mean linger is disabled, values > 0 are seconds to linger | |
| 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 * | 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 205 of file FEATURE_LWIP/lwip-interface/lwip/src/include/lwip/api.h.
Field Documentation
| sys_mbox_t acceptmbox |
mbox where new connections are stored until processed by the application thread
Definition at line 229 of file FEATURE_LWIP/lwip-interface/lwip/src/include/lwip/api.h.
A callback function that is informed about events for this netconn.
Definition at line 270 of file FEATURE_LWIP/lwip-interface/lwip/src/include/lwip/api.h.
| struct api_msg* 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.
Definition at line 267 of file FEATURE_LWIP/lwip-interface/lwip/src/include/lwip/api.h.
| u8_t flags |
flags holding more netconn-internal state, see NETCONN_FLAG_* defines
Definition at line 259 of file FEATURE_LWIP/lwip-interface/lwip/src/include/lwip/api.h.
the last error this netconn had
Definition at line 218 of file FEATURE_LWIP/lwip-interface/lwip/src/include/lwip/api.h.
| s16_t linger |
values <0 mean linger is disabled, values > 0 are seconds to linger
Definition at line 256 of file FEATURE_LWIP/lwip-interface/lwip/src/include/lwip/api.h.
| sys_sem_t op_completed |
sem that is used to synchronously execute functions in the core context
Definition at line 221 of file FEATURE_LWIP/lwip-interface/lwip/src/include/lwip/api.h.
| int 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
Definition at line 252 of file FEATURE_LWIP/lwip-interface/lwip/src/include/lwip/api.h.
| int recv_bufsize |
maximum amount of bytes queued in recvmbox not used for TCP: adjust TCP_WND instead!
Definition at line 248 of file FEATURE_LWIP/lwip-interface/lwip/src/include/lwip/api.h.
| int recv_timeout |
timeout in milliseconds to wait for new data to be received (or connections to arrive for listening netconns)
Definition at line 243 of file FEATURE_LWIP/lwip-interface/lwip/src/include/lwip/api.h.
| sys_mbox_t recvmbox |
mbox where received packets are stored until they are fetched by the netconn application thread (can grow quite big)
Definition at line 225 of file FEATURE_LWIP/lwip-interface/lwip/src/include/lwip/api.h.
| s32_t send_timeout |
timeout to wait for sending data (which means enqueueing data for sending in internal buffers) in milliseconds
Definition at line 238 of file FEATURE_LWIP/lwip-interface/lwip/src/include/lwip/api.h.
| int socket |
only used for socket layer
Definition at line 233 of file FEATURE_LWIP/lwip-interface/lwip/src/include/lwip/api.h.
| enum netconn_state state |
current state of the netconn
Definition at line 209 of file FEATURE_LWIP/lwip-interface/lwip/src/include/lwip/api.h.
| enum netconn_type type |
type of the netconn (TCP, UDP or RAW)
Definition at line 207 of file FEATURE_LWIP/lwip-interface/lwip/src/include/lwip/api.h.
| 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.
Definition at line 263 of file FEATURE_LWIP/lwip-interface/lwip/src/include/lwip/api.h.
Generated on Sun Jul 17 2022 08:25:41 by
1.7.2