Nut/OS: tcp_socket Struct Reference

Nut/OS 5.0.5

API Reference

TCP socket information structure. More...

#include <sock_var.h>

Collaboration diagram for tcp_socket:

Data Fields
TCPSOCKET *	so_next
	Link to next tcp socket structure.
void *	so_device
	Always zero.
uint8_t	so_devtype
	Device type, always IFTYP_TCPSOCK.
int(*	so_devread )(TCPSOCKET , void , int)
	Read from device.
int(*	so_devwrite )(TCPSOCKET , const void , int)
	Write to device.
int(*	so_devwrite_P )(TCPSOCKET *, PGM_P, int)
	Write to device.
int(*	so_devioctl )(TCPSOCKET , int, void )
	Driver control function.
uint16_t	so_devocnt
	Number of data bytes in output buffer.
uint8_t *	so_devobuf
	Pointer to output buffer.
uint16_t	so_devobsz
	Output buffer size.
volatile uint8_t	so_state
	Connection state, see tcp_fsm.h.
uint32_t	so_local_addr
	Local IP address in net byte order.
uint16_t	so_local_port
	Local port number in net byte order.
uint32_t	so_remote_addr
	Remote IP address in net byte order.
uint16_t	so_remote_port
	Remote port number in net byte order.
uint8_t	so_tx_flags
	Flags used during transmissions - see below.
uint32_t	so_tx_isn
	Initial sequence number.
uint32_t	so_tx_una
	Unacknowledged sequence number.
uint32_t	so_tx_nxt
	Next sequence number to send.
uint32_t	so_tx_wl1
	Sequence number of last window update.
uint32_t	so_tx_wl2
	Acknowledged sequence of last window update.
uint16_t	so_tx_win
	Peer's receive window.
uint8_t	so_tx_dup
	Duplicate ACK counter.
NETBUF *	so_tx_nbq
	Network buffers waiting to be acknowledged.
HANDLE	so_tx_tq
	Threads waiting for transmit buffer space.
uint32_t	so_rx_isn
	Initial sequence number of remote.
uint32_t	so_rx_nxt
	Next sequence number to receive.
uint16_t	so_rx_win
	Local receive window.
int	so_rx_cnt
	Number of data bytes in the receive buffer.
int	so_rx_bsz
	Receive buffer size.
int	so_rd_cnt
	Number of bytes read from buffer top.
int_fast8_t	so_rx_apc
	Number of packets received in advance.
NETBUF *	so_rx_buf
	Data waiting to be read by application.
HANDLE	so_rx_tq
	Threads waiting for received data.
NETBUF *	so_rx_nbq
	Network buffers received in advance.
uint16_t	so_mss
	MSS, limited by remote option or MTU.
uint32_t	so_rtt_seq
	Sequence number for RTT calculation.
uint16_t	so_rtto
	Current retransmission timeout.
uint16_t	so_retransmits
	Number of retransmits.
uint16_t	so_time_wait
	Time wait counter.
uint16_t	so_retran_time
	Retransmit time counter.
uint16_t	so_last_error
	Last error code.
HANDLE	so_pc_tq
	Listening thread.
HANDLE	so_ac_tq
	Connecting thread.
uint32_t	so_read_to
	Read timeout.
uint32_t	so_write_to
	Write timeout.
uint32_t	so_oos_drop
	Out of sequence dropped.

Detailed Description

TCP socket information structure.

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

Examples:: ftpd/ftpserv.c, httpd/httpserv.c, httpd_simple/httpd_simple.c, httpd_upnp/httpserv.c, inetq/inetq.c, portdio/portdio.c, rs232d/rs232d.c, and tcps/tcps.c.

Field Documentation

TCPSOCKET* tcp_socket::so_next

Link to next tcp socket structure.

Examples:: httpd/httpserv.c.

Referenced by NutDumpSocketList(), NutTcpConnect(), NutTcpCreateSocket(), NutTcpDestroySocket(), NutTcpFindSocket(), and NutTcpSm().

void* tcp_socket::so_device

Always zero.

uint8_t tcp_socket::so_devtype

Device type, always IFTYP_TCPSOCK.

Referenced by NutTcpCreateSocket().

int(* tcp_socket::so_devread)(TCPSOCKET *, void *, int)

Read from device.

Referenced by NutTcpCreateSocket().

int(* tcp_socket::so_devwrite)(TCPSOCKET *, const void *, int)

Write to device.

Referenced by NutTcpCreateSocket().

int(* tcp_socket::so_devwrite_P)(TCPSOCKET *, PGM_P, int)

Write to device.

Referenced by NutTcpCreateSocket().

int(* tcp_socket::so_devioctl)(TCPSOCKET *, int, void *)

Driver control function.

Referenced by NutTcpCreateSocket().

uint16_t tcp_socket::so_devocnt

Number of data bytes in output buffer.

Referenced by NutTcpDestroySocket(), NutTcpDeviceIOCtl(), and NutTcpDeviceWrite().

uint8_t* tcp_socket::so_devobuf

Pointer to output buffer.

Referenced by NutTcpDestroySocket(), and NutTcpDeviceWrite().

uint16_t tcp_socket::so_devobsz

Output buffer size.

Referenced by NutTcpCreateSocket(), and NutTcpDeviceWrite().

volatile uint8_t tcp_socket::so_state

Connection state, see tcp_fsm.h.

Examples:: httpd/httpserv.c.

Referenced by NutDumpSocketList(), NutTcpAbortSocket(), NutTcpConnect(), NutTcpCreateSocket(), NutTcpDeviceWrite(), NutTcpFindSocket(), NutTcpReceive(), NutTcpSend(), NutTcpSetSockOpt(), NutTcpSm(), NutTcpStateActiveOpenEvent(), NutTcpStateCloseEvent(), and NutTcpStatePassiveOpenEvent().

uint32_t tcp_socket::so_local_addr

Local IP address in net byte order.

Referenced by NutDumpSocketList(), NutFtpProcessPassiv(), NutTcpConnect(), and NutTcpOutput().

uint16_t tcp_socket::so_local_port

Local port number in net byte order.

Referenced by NutDumpSocketList(), NutTcpAccept(), NutTcpConnect(), NutTcpFindSocket(), NutTcpOutput(), and NutTcpStatePassiveOpenEvent().

uint32_t tcp_socket::so_remote_addr

Remote IP address in net byte order.

Examples:: ftpd/ftpserv.c.

Referenced by NutDumpSocketList(), NutFtpProcessPort(), NutTcpConnect(), NutTcpFindSocket(), NutTcpOutput(), and NutTcpStateRetranTimeout().

uint16_t tcp_socket::so_remote_port

Remote port number in net byte order.

Referenced by NutDumpSocketList(), NutTcpConnect(), NutTcpFindSocket(), and NutTcpOutput().

uint8_t tcp_socket::so_tx_flags

Flags used during transmissions - see below.

Referenced by NutTcpOutput(), NutTcpSend(), NutTcpSm(), and NutTcpStateWindowEvent().

uint32_t tcp_socket::so_tx_isn

Initial sequence number.

Referenced by NutTcpCreateSocket().

uint32_t tcp_socket::so_tx_una

Unacknowledged sequence number.

Referenced by NutTcpCreateSocket(), and NutTcpSend().

uint32_t tcp_socket::so_tx_nxt

Next sequence number to send.

Referenced by NutTcpCreateSocket(), NutTcpOutput(), and NutTcpSend().

uint32_t tcp_socket::so_tx_wl1

Sequence number of last window update.

uint32_t tcp_socket::so_tx_wl2

Acknowledged sequence of last window update.

uint16_t tcp_socket::so_tx_win

Peer's receive window.

uint8_t tcp_socket::so_tx_dup

Duplicate ACK counter.

NETBUF* tcp_socket::so_tx_nbq

Network buffers waiting to be acknowledged.

Referenced by NutTcpDiscardBuffers(), NutTcpOutput(), NutTcpSm(), and NutTcpStateRetranTimeout().

HANDLE tcp_socket::so_tx_tq

Threads waiting for transmit buffer space.

Referenced by NutTcpAbortSocket(), and NutTcpSend().

uint32_t tcp_socket::so_rx_isn

Initial sequence number of remote.

uint32_t tcp_socket::so_rx_nxt

Next sequence number to receive.

Referenced by NutTcpOutput().

uint16_t tcp_socket::so_rx_win

Local receive window.

Referenced by NutTcpCreateSocket(), NutTcpOutput(), NutTcpReceive(), and NutTcpSetSockOpt().

int tcp_socket::so_rx_cnt

Number of data bytes in the receive buffer.

Referenced by NutTcpDeviceIOCtl(), and NutTcpReceive().

int tcp_socket::so_rx_bsz

Receive buffer size.

Referenced by NutTcpCreateSocket(), NutTcpGetSockOpt(), NutTcpReceive(), and NutTcpSetSockOpt().

int tcp_socket::so_rd_cnt

Number of bytes read from buffer top.

Referenced by NutTcpDeviceIOCtl(), and NutTcpReceive().

int_fast8_t tcp_socket::so_rx_apc

Number of packets received in advance.

Referenced by NutTcpReceive().

NETBUF* tcp_socket::so_rx_buf

Data waiting to be read by application.

Referenced by NutTcpDiscardBuffers(), and NutTcpReceive().

HANDLE tcp_socket::so_rx_tq

Threads waiting for received data.

Referenced by NutTcpAbortSocket(), and NutTcpReceive().

NETBUF* tcp_socket::so_rx_nbq

Network buffers received in advance.

Referenced by NutTcpDiscardBuffers().

uint16_t tcp_socket::so_mss

MSS, limited by remote option or MTU.

Referenced by NutFtpOpenSession(), NutFtpTransferFile(), NutTcpCreateSocket(), NutTcpGetSockOpt(), NutTcpOutput(), NutTcpReceive(), NutTcpSend(), and NutTcpSetSockOpt().

uint32_t tcp_socket::so_rtt_seq

Sequence number for RTT calculation.

Referenced by NutTcpOutput().

uint16_t tcp_socket::so_rtto

Current retransmission timeout.

Referenced by NutTcpCalcRtt(), NutTcpCreateSocket(), and NutTcpSm().

uint16_t tcp_socket::so_retransmits

Number of retransmits.

Referenced by NutTcpStateRetranTimeout().

uint16_t tcp_socket::so_time_wait

Time wait counter.

Referenced by NutTcpAbortSocket(), and NutTcpSm().

uint16_t tcp_socket::so_retran_time

Retransmit time counter.

Referenced by NutTcpAbortSocket(), NutTcpCalcRtt(), NutTcpOutput(), NutTcpSm(), and NutTcpStateRetranTimeout().

uint16_t tcp_socket::so_last_error

Last error code.

Referenced by NutTcpAbortSocket(), NutTcpConnect(), NutTcpDeviceWrite(), NutTcpError(), NutTcpGetSockOpt(), NutTcpOutput(), NutTcpReceive(), NutTcpSend(), NutTcpSetSockOpt(), NutTcpStateCloseEvent(), and NutTcpStatePassiveOpenEvent().

HANDLE tcp_socket::so_pc_tq

Listening thread.

Referenced by NutTcpAbortSocket(), and NutTcpStatePassiveOpenEvent().

HANDLE tcp_socket::so_ac_tq

Connecting thread.

Referenced by NutTcpAbortSocket(), and NutTcpStateActiveOpenEvent().

uint32_t tcp_socket::so_read_to

Read timeout.

Referenced by NutTcpReceive(), and NutTcpStatePassiveOpenEvent().

uint32_t tcp_socket::so_write_to

Write timeout.

Referenced by NutTcpGetSockOpt(), NutTcpSend(), and NutTcpSetSockOpt().

uint32_t tcp_socket::so_oos_drop

Out of sequence dropped.

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

include/sys/sock_var.h

tcp_socket

All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Defines

© 2000-2010 by contributors - visit http://www.ethernut.de/