FreeRTOS
Macros
Secure Socket Options

Options for lOptionName in SOCKETS_SetSockOpt(). More...

Macros

#define SOCKETS_SO_RCVTIMEO   ( 0 )
 
#define SOCKETS_SO_SNDTIMEO   ( 1 )
 
#define SOCKETS_SO_SNDBUF   ( 4 )
 
#define SOCKETS_SO_RCVBUF   ( 5 )
 
#define SOCKETS_SO_SERVER_NAME_INDICATION   ( 6 )
 
#define SOCKETS_SO_TRUSTED_SERVER_CERTIFICATE   ( 7 )
 
#define SOCKETS_SO_REQUIRE_TLS   ( 8 )
 
#define SOCKETS_SO_NONBLOCK   ( 9 )
 
#define SOCKETS_SO_ALPN_PROTOCOLS   ( 10 )
 
#define SOCKETS_SO_WAKEUP_CALLBACK   ( 17 )
 

Detailed Description

Options for lOptionName in SOCKETS_SetSockOpt().

Macro Definition Documentation

◆ SOCKETS_SO_ALPN_PROTOCOLS

#define SOCKETS_SO_ALPN_PROTOCOLS   ( 10 )

Application protocol list to be included in TLS ClientHello.

Definition at line 158 of file aws_secure_sockets.h.

◆ SOCKETS_SO_NONBLOCK

#define SOCKETS_SO_NONBLOCK   ( 9 )

Socket is nonblocking.

Definition at line 157 of file aws_secure_sockets.h.

◆ SOCKETS_SO_RCVBUF

#define SOCKETS_SO_RCVBUF   ( 5 )

Set the size of the receive buffer (TCP only).

Definition at line 153 of file aws_secure_sockets.h.

◆ SOCKETS_SO_RCVTIMEO

#define SOCKETS_SO_RCVTIMEO   ( 0 )

Set the receive timeout.

Definition at line 150 of file aws_secure_sockets.h.

◆ SOCKETS_SO_REQUIRE_TLS

#define SOCKETS_SO_REQUIRE_TLS   ( 8 )

Toggle client enforcement of TLS.

Definition at line 156 of file aws_secure_sockets.h.

◆ SOCKETS_SO_SERVER_NAME_INDICATION

#define SOCKETS_SO_SERVER_NAME_INDICATION   ( 6 )

Toggle client use of TLS SNI.

Definition at line 154 of file aws_secure_sockets.h.

◆ SOCKETS_SO_SNDBUF

#define SOCKETS_SO_SNDBUF   ( 4 )

Set the size of the send buffer (TCP only).

Definition at line 152 of file aws_secure_sockets.h.

◆ SOCKETS_SO_SNDTIMEO

#define SOCKETS_SO_SNDTIMEO   ( 1 )

Set the send timeout.

Definition at line 151 of file aws_secure_sockets.h.

◆ SOCKETS_SO_TRUSTED_SERVER_CERTIFICATE

#define SOCKETS_SO_TRUSTED_SERVER_CERTIFICATE   ( 7 )

Override default TLS server certificate trust. Must be PEM encoded and length must include null terminator.

Definition at line 155 of file aws_secure_sockets.h.

◆ SOCKETS_SO_WAKEUP_CALLBACK

#define SOCKETS_SO_WAKEUP_CALLBACK   ( 17 )

Set the callback to be called whenever there is data available on the socket for reading.

Definition at line 159 of file aws_secure_sockets.h.