IPC@CHIP Documentation - SC12 @CHIP-RTOS V1.10

Comments
This data structure and specified constants are defined in the TCPIPAPI.H library header file.
typedef struct tag_getsockopt
{
int protocol_level; // Protocol level: IP level, TCP level or socket level
int optionName; // Option's name
char far *optionValue; // Pointer to the option value buffer (type varies)
int far *optionLength; // Length of option value buffer
} GetSocketOption;
// protocol levels
#define IP_PROTOIP_LEVEL 0
#define IP_PROTOTCP_LEVEL 6
#define SOCKET_LEVEL 0x7fff
// Remaining constants apply to the .optionName field
// IP level options
#define IPO_TTL 0x0001
#define IPO_TOS 0x0002
// TCP level options
#define TCP_NODELAY 0x0001
#define TCP_NOPUSH 0x0004
#define TCP_SLOW_START 0x0200
#define TCP_KEEPALIVE 0x4001
#define TCP_DELAY_ACK 0x4002
#define TCP_KEEPALIVE_INTV 0x4004
#define TCP_KEEPALIVE_CNT 0x4005
#define TCP_FINWT2TIME 0x4006
#define TCP_2MSLTIME 0x4007
#define TCP_MAXRT 0x0010
#define TCP_MAXREXMIT 0x4003
// Socket level options
#define SO_REUSEADDR 0x0004
#define SO_KEEPALIVE 0x0008
#define SO_SNDBUF 0x1001
#define SO_RCVBUF 0x1002
The type of data found at the location referenced by the optionValue member pointer varies depending on the particular
socket option that is being dealt with.
When manipulating socket options, the protocol_level at which the option resides and the name of the option
(optionName member) must be specified. The size of the buffer (in bytes) pointed to by the optionValue member
depends on the option, and this size must be specified in the optionLength field. These sizes are stated in the list of
options below. The API uses the optionValue and optionLength members to report option values.
The following list specifies the three different protocol levels and their valid socket options, including a short description and
the length of the option value. Protocol level and optionName constants referred to here are defined in TCPIPAPI.H header
file.
protocol_level=IP_PROTOIP_LEVEL (IP level options)
❍ optionName=IPO_TOS: Size: 8 bit, sizeof (char) - Set IP type of service, default 0
❍ optionName=IPO_TTL: Size: 8 bit, sizeof (char) - Set IP time-to-live router hops, default 64
protocol_level=IP_PROTOTCP_LEVEL (TCP level options)
❍ optionName=TCP_NODELAY: Size: 16 bit , sizeof (int) - 1: Disable nagle algorithm, default is 0: nagle algorithm is
enabled
❍ optionName=TCP_NOPUSH: Size: 16 bit , sizeof (int) - 1: Force TCP to delay sending any TCP data until a full sized
segment is buffered in the TCP buffers (useful if continuous large amount of data is sent as with FTP) default is 0
❍ optionName=TCP_SLOW_START: Size: 16 bit, sizeof (int) - 1: Enable the TCP slow start algorithm (default), 0:
disabled
❍ optionName=TCP_KEEPALIVE: Size: 16 bit, sizeof (int) - Set idle time seconds before sending keep alive probes.
Default 7200 seconds, minimum 10 seconds, maximum 32767 seconds
Notes:
1. The socket level option SO_KEEPALIVE (see below) must be enabled.
2. The minimum value was changed in @CHIP-RTOS 070 to 10 seconds (was 7200 seconds in @CHIP-RTOS
Page 165 / 400