@CHIP-RTOS C Library - TCP/IP API

setsockopt

Set options on a socket.

int setsockopt ( int sd,
                 const SetSocketOption far *sockoptptr,
                 int *error);

Parameters

sd

Socket descriptor.

sockoptptr

Pointer to SetSocketOption type that specifies the socket options (see tcpipapi.h).

error

Output parameter:  Failure code, 0 on success.

Return Value

0 = success
Non-zero = Failure (see error output parameter)

Comments

This API function makes it possible to manipulate options associated with a socket.  Prior to calling this function the caller must fill in a SetSocketOption type data structure.  The socket options of an incoming connection (using accept) will be the same as the socket options of the listening socket.

SC1x3/SC2x Comments

This legacy version of setsockopt() specified here is not compatible to the BSD 4.4 Socket API.   The setsockopt() function can be used in BSD 4.4 compatible mode if the compilation switch

     #define BSD44_SOCKET_API_STYLE

is defined in the user application prior to including the Beck C-Library header files.   Using this switch the C-Library TCPIP_Socket.H include file redefines setsockopt() to setsockopt_bsd().  The parameters to setsockopt_bsd() are identical to the parameters of the BSD4.4 socket setsockopt() function.

See Also

opensocket        accept        getsockopt
opensocket_ext        setsockopt_bsd        

RTOS API

This library function invokes a RTOS software interrupt. Refer to this RTOS API function's documentation for more details.

Supported since or modified in @CHIP-RTOS version

SC12	SC13	SC11	SC1x3	SC2x
V1.00	V1.00	V1.00	V0.90	V1.00