espressif/openthread
1
0
Fork 0
mirror of https://github.com/espressif/openthread.git synced 2026-07-30 23:57:47 +00:00
Code Issues Packages Projects Releases Wiki Activity

[srp-client] update document about selected preferred server (#8125)

Browse Source 
This commit updates `otSrpClientEnableAutoStartMode` documentation
to describe how the preferred server is determined from Network Data
entries (different Network Data entry categories, their order of
preference, and how to handle when there are multiple options within
the same category).
This commit is contained in:
Abtin Keshavarzian
2022-09-06 15:27:22 -07:00
committed by GitHub
parent 1929c7c187
commit ccf8ea6923
3 changed files with 39 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files
include/openthread/instance.h
+1 -1
View File
@@ -53,7 +53,7 @@ extern "C" {
* @note This number versions both OpenThread platform and user APIs.
*
*/
#define OPENTHREAD_API_VERSION (240)
#define OPENTHREAD_API_VERSION (241)
/**
* @addtogroup api-instance
include/openthread/srp_client.h
+19 -5
View File
@@ -270,12 +270,26 @@ void otSrpClientSetCallback(otInstance *aInstance, otSrpClientCallback aCallback
* Config option `OPENTHREAD_CONFIG_SRP_CLIENT_AUTO_START_DEFAULT_MODE` specifies the default auto-start mode (whether
* it is enabled or disabled at the start of OT stack).
*
* When auto-start is enabled, the SRP client will monitor the Thread Network Data for SRP Server Service entries
* and automatically start and stop the client when an SRP server is detected.
* When auto-start is enabled, the SRP client will monitor the Thread Network Data to discover SRP servers and select
* the preferred server and automatically start and stop the client when an SRP server is detected.
*
* If multiple SRP servers are found, a random one will be selected. If the selected SRP server is no longer
* detected (not longer present in the Thread Network Data), the SRP client will be stopped and then it may switch
* to another SRP server (if available).
* There are three categories of Network Data entries indicating presence of SRP sever. They are preferred in the
* following order:
*
* 1) Preferred unicast entries where server address is included in the service data. If there are multiple options,
* the one with numerically lowest IPv6 address is preferred.
*
* 2) Anycast entries each having a seq number. A larger sequence number in the sense specified by Serial Number
* Arithmetic logic in RFC-1982 is considered more recent and therefore preferred. The largest seq number using
* serial number arithmetic is preferred if it is well-defined (i.e., the seq number is larger than all other
* seq numbers). If it is not well-defined, then the numerically largest seq number is preferred.
*
* 3) Unicast entries where the server address info is included in server data. If there are multiple options, the
* one with numerically lowest IPv6 address is preferred.
*
* When there is a change in the Network Data entries, client will check that the currently selected server is still
* present in the Network Data and is still the preferred one. Otherwise the client will switch to the new preferred
* server or stop if there is none.
*
* When the SRP client is explicitly started through a successful call to `otSrpClientStart()`, the given SRP server
* address in `otSrpClientStart()` will continue to be used regardless of the state of auto-start mode and whether the