FreeRTOS: Secure Sockets
Return to main page ↑
Configuration

Configuration settings of the library.
Configuration settings are C pre-processor constants. They can be set with a #define in the iot_config.h or by using a compiler option such as -D in gcc. If a configuration setting is not defined, the library will use a "sensible" default value (unless otherwise noted). Because they are compile-time constants, a library must be rebuilt if a configuration setting is changed.

configpagemarker

socketsconfigBYTE_ORDER

Byte order of the target MCU must be defined. For detail, please refer to Endian in freertos.org

Valid values are pdLITTLE_ENDIAN and pdBIG_ENDIAN.

If this configuration is not set, compiler will generate an error warning about it, which is written in iot_secure_sockets_config_defaults.h

Possible values: pdLITTLE_ENDIAN (little endian) or pdBIG_ENDIAN (big endian)
Recommended values: must be set correctly for the MCU
Default value (if undefined): None

socketsconfigDEFAULT_SEND_TIMEOUT

Default socket send timeout.

The user can change the send timeout for a socket using the SOCKETS_SetSockOpt API with the SOCKETS_SO_SNDTIMEO option.

The unit is milliseconds that SOCKETS_Send should wait before timing out. Setting to 0 causes send to wait forever.

This configuration is defined in iot_secure_sockets_config_defaults.h

Possible values: Any positive integer
Default value (if undefined): 10000

socketsconfigDEFAULT_RECV_TIMEOUT

Default socket receive timeout.

The user can change the receive timeout for a socket using the SOCKETS_SetSockOpt API with the SOCKETS_SO_RCVTIMEO option.

The unit is milliseconds that SOCKETS_Recv should wait before timing out. Setting to 0 causes receive to wait forever.

This configuration is defined in iot_secure_sockets_config_defaults.h

Possible values: Any positive integer
Default value (if undefined): 10000