nRF5 SDK v16.0.0
Macros
BSD Socket Interface - Common module configuration

Macros

#define SOCKET_AUTOINIT_ENABLE
 Enable or disable automatic initialization of socket module. More...
 
#define SOCKET_ENABLE_API_PARAM_CHECK
 Enable or disable API parameter check. More...
 
#define SOCKET_CONFIG_LOG_ENABLED
 Enables logging in the module. More...
 
#define SOCKET_CONFIG_LOG_LEVEL
 Default Severity level. More...
 
#define SOCKET_CONFIG_INFO_COLOR
 ANSI escape code prefix. More...
 
#define SOCKET_CONFIG_DEBUG_COLOR
 ANSI escape code prefix. More...
 
#define SOCKET_MAX_SOCKET_COUNT
 The max number of sockets to support for socket module. More...
 
#define SOCKET_TRANSPORT_ENABLE
 Enable or disable transport layer in socket module. More...
 

Detailed Description

Macro Definition Documentation

#define SOCKET_AUTOINIT_ENABLE

Enable or disable automatic initialization of socket module.

The automatic setup allows the socket API to initialize the entire stack so that you can compile and run PC applications using the socket API with no modifications needed. Disabling autoinit is only recommended if you need to do custom modifications to the initialization procedure.

Set to 1 to activate.

Note
This is an NRF_CONFIG macro.
#define SOCKET_CONFIG_DEBUG_COLOR

ANSI escape code prefix.

Following options are available:

  • 0 - Default
  • 1 - Black
  • 2 - Red
  • 3 - Green
  • 4 - Yellow
  • 5 - Blue
  • 6 - Magenta
  • 7 - Cyan
  • 8 - White
Note
This is an NRF_CONFIG macro.
#define SOCKET_CONFIG_INFO_COLOR

ANSI escape code prefix.

Following options are available:

  • 0 - Default
  • 1 - Black
  • 2 - Red
  • 3 - Green
  • 4 - Yellow
  • 5 - Blue
  • 6 - Magenta
  • 7 - Cyan
  • 8 - White
Note
This is an NRF_CONFIG macro.
#define SOCKET_CONFIG_LOG_ENABLED

Enables logging in the module.

Set to 1 to activate.

Note
This is an NRF_CONFIG macro.
#define SOCKET_CONFIG_LOG_LEVEL

Default Severity level.

Following options are available:

  • 0 - Off
  • 1 - Error
  • 2 - Warning
  • 3 - Info
  • 4 - Debug
Note
This is an NRF_CONFIG macro.
#define SOCKET_ENABLE_API_PARAM_CHECK

Enable or disable API parameter check.

API parameter checks are added to ensure right parameters are passed to the module. These checks are useful during development phase, but redundant when in production. Disabling this can result in some code saving.

Set to 1 to activate.

Note
This is an NRF_CONFIG macro.
#define SOCKET_MAX_SOCKET_COUNT

The max number of sockets to support for socket module.

Minimum value: 1 Maximum value: 255

Note
This is an NRF_CONFIG macro.
#define SOCKET_TRANSPORT_ENABLE

Enable or disable transport layer in socket module.

The transport layer is required if you are going to use the Nordic IPv6 stack or the LwIP stack as used by Nordic. If you want to use the socket layer for configuration sockets only, you can disable transport as it can result in some code saving.

Set to 1 to activate.

Note
This is an NRF_CONFIG macro.

Documentation feedback | Developer Zone | Subscribe | Updated