udp_socket Struct Reference

UDP socket information structure. More...

#include <sock_var.h>

Collaboration diagram for udp_socket:

Data Fields
UDPSOCKET *	so_next
	Link to next tcp socket structure.
uint16_t	so_local_port
	Local port number in net byte order.
NETBUF *	so_rx_nb
	Received, but not read by application.
HANDLE	so_rx_rdy
	Receiver event queue.
int	so_rx_cnt
	Number of data bytes in the receive buffer.
int	so_rx_bsz
	Receive buffer size.
uint16_t	so_last_error
	Last error of socket.
uint32_t	so_remote_addr
	Remote IP address in net byte order. Important just in case of an error.
uint16_t	so_remote_port
	Remote port number in net byte order. Important just in case of an error.

---

Detailed Description

UDP socket information structure.

Applications should not rely on the content of this structure. It may change without notice.

Examples:

icmp-udp/icmp-udp.c, and snmpd/snmpd.c.

---

Field Documentation

UDPSOCKET* udp_socket::so_next

Link to next tcp socket structure.

Referenced by NutDumpSocketList(), NutUdpCreateSocket(), NutUdpDestroySocket(), and NutUdpFindSocket().

uint16_t udp_socket::so_local_port

Local port number in net byte order.

Referenced by NutDumpSocketList(), NutUdpCreateSocket(), NutUdpFindSocket(), and NutUdpOutput().

NETBUF* udp_socket::so_rx_nb

Received, but not read by application.

Referenced by NutUdpDestroySocket(), NutUdpInput(), and NutUdpReceiveFrom().

HANDLE udp_socket::so_rx_rdy

Receiver event queue.

Referenced by NutUdpInput(), NutUdpReceiveFrom(), and NutUdpSetSocketError().

int udp_socket::so_rx_cnt

Number of data bytes in the receive buffer.

Referenced by NutUdpInput(), and NutUdpReceiveFrom().

int udp_socket::so_rx_bsz

Receive buffer size.

Referenced by NutUdpGetSockOpt(), NutUdpInput(), and NutUdpSetSockOpt().

uint16_t udp_socket::so_last_error

Last error of socket.

Referenced by NutUdpError(), NutUdpReceiveFrom(), NutUdpSendTo(), and NutUdpSetSocketError().

uint32_t udp_socket::so_remote_addr

Remote IP address in net byte order. Important just in case of an error.

Referenced by NutUdpError(), and NutUdpSetSocketError().

uint16_t udp_socket::so_remote_port

Remote port number in net byte order. Important just in case of an error.

Referenced by NutUdpError(), and NutUdpSetSocketError().

---

The documentation for this struct was generated from the following file:

• include/sys/sock_var.h