SRP Server

This module includes configuration variables for the SRP Server.

Summary

Macros

OPENTHREAD_CONFIG_SRP_SERVER_ADVERTISING_PROXY_ENABLE 0
Define to 1 to enable Advertising Proxy for SRP Sever.
OPENTHREAD_CONFIG_SRP_SERVER_DEFAULT_ADDRESS_MODE OT_SRP_SERVER_ADDRESS_MODE_UNICAST
Specifies the default address mode used by the SRP server.
OPENTHREAD_CONFIG_SRP_SERVER_ENABLE 0
Define to 1 to enable SRP Server support.
OPENTHREAD_CONFIG_SRP_SERVER_PORT_SWITCH_ENABLE 1
Define to 1 to enable SRP server feature to save its own port in non-volatile settings.
OPENTHREAD_CONFIG_SRP_SERVER_SERVICE_UPDATE_TIMEOUT ((4 * 250u) + 250u)
Specifies the timeout value (in milliseconds) for the service update handler.
OPENTHREAD_CONFIG_SRP_SERVER_UDP_PORT_MAX 53554
Specifies the max port number in the port range reserved for SRP server.
OPENTHREAD_CONFIG_SRP_SERVER_UDP_PORT_MIN 53535
Specifies the min port number in the port range reserved for SRP server.

Macros

OPENTHREAD_CONFIG_SRP_SERVER_ADVERTISING_PROXY_ENABLE

 OPENTHREAD_CONFIG_SRP_SERVER_ADVERTISING_PROXY_ENABLE 0

Define to 1 to enable Advertising Proxy for SRP Sever.

OPENTHREAD_CONFIG_SRP_SERVER_DEFAULT_ADDRESS_MODE

 OPENTHREAD_CONFIG_SRP_SERVER_DEFAULT_ADDRESS_MODE OT_SRP_SERVER_ADDRESS_MODE_UNICAST

Specifies the default address mode used by the SRP server.

The address mode specifies how address and port number are determined by the SRP server and how this info is published in the Thread Network Data.

The value of this configuration should be from otSrpServerAddressMode enumeration.

OPENTHREAD_CONFIG_SRP_SERVER_ENABLE

 OPENTHREAD_CONFIG_SRP_SERVER_ENABLE 0

Define to 1 to enable SRP Server support.

OPENTHREAD_CONFIG_SRP_SERVER_PORT_SWITCH_ENABLE

 OPENTHREAD_CONFIG_SRP_SERVER_PORT_SWITCH_ENABLE 1

Define to 1 to enable SRP server feature to save its own port in non-volatile settings.

When enabled, the SRP server will save its port in the non-volatile settings. On a server restart (e.g., due to a device reset) it will restore the port and change to a different one. The info is written to Settings after the first service has been registered due to receiving an SRP Update.

OPENTHREAD_CONFIG_SRP_SERVER_SERVICE_UPDATE_TIMEOUT

 OPENTHREAD_CONFIG_SRP_SERVER_SERVICE_UPDATE_TIMEOUT ((4 * 250u) + 250u)

Specifies the timeout value (in milliseconds) for the service update handler.

The default timeout value is the sum of the maximum total mDNS probing delays and a loose IPC timeout of 250ms. It is recommended that this configuration should not use a value smaller than the default value here, if an Advertising Proxy is used to handle the service update events.

OPENTHREAD_CONFIG_SRP_SERVER_UDP_PORT_MAX

 OPENTHREAD_CONFIG_SRP_SERVER_UDP_PORT_MAX 53554

Specifies the max port number in the port range reserved for SRP server.

OPENTHREAD_CONFIG_SRP_SERVER_UDP_PORT_MIN

 OPENTHREAD_CONFIG_SRP_SERVER_UDP_PORT_MIN 53535

Specifies the min port number in the port range reserved for SRP server.

Resources

OpenThread API Reference topics originate from the source code, available on GitHub. For more information, or to contribute to our documentation, refer to Resources.