Dependents:   SimpleLCDClock readCard2Twitter_http AnalogClock_StepperMotor_NTP ServoCamV1

Embed: (wiki syntax)

« Back to documentation index

netconn Struct Reference

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 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
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_msgcurrent_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

sys_mbox_t acceptmbox

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

Definition at line 155 of file api.h.

netconn_callback callback

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

Definition at line 187 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 184 of file api.h.

u8_t flags

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

Definition at line 176 of file api.h.

err_t last_err

the last error this netconn had

Definition at line 147 of file api.h.

sys_sem_t op_completed

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

Definition at line 149 of file api.h.

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

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 168 of file api.h.

timeout to wait for new data to be received (or connections to arrive for listening netconns)

Definition at line 163 of file 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 152 of file api.h.

int socket

only used for socket layer

Definition at line 158 of file api.h.

enum netconn_state state

current state of the netconn

Definition at line 138 of file api.h.

enum netconn_type type

type of the netconn (TCP, UDP or RAW)

Definition at line 136 of file 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 180 of file api.h.