espressif/openthread
1
0
Fork 0
mirror of https://github.com/espressif/openthread.git synced 2026-10-01 21:37:39 +00:00
Code Issues Packages Projects Releases Wiki Activity

[api] clarify NAT64 prefix discovery priority in api doc (#12180)

Browse Source 
This commit adds a `@note` to the documentation of
`otPlatInfraIfDiscoverNat64Prefix` functions to make it clear that any
prefix it supplies will have a lower priority than one discovered via
RA PREF64 option (RFC 8781).
This commit is contained in:
Yang Song
2026-01-27 15:59:11 -08:00
committed by GitHub
parent f121ebcffa
commit 8c74262dda
2 changed files with 12 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
include/openthread/instance.h
+1 -1
View File
@@ -52,7 +52,7 @@ extern "C" {
* *
* @note This number versions both OpenThread platform and user APIs. * @note This number versions both OpenThread platform and user APIs.
*/ */
#define OPENTHREAD_API_VERSION (574) #define OPENTHREAD_API_VERSION (575)
/** /**
* @addtogroup api-instance * @addtogroup api-instance
include/openthread/platform/infra_if.h
+11 -2
View File
@@ -147,8 +147,13 @@ extern otError otPlatInfraIfStateChanged(otInstance *aInstance, uint32_t aInfraI
* *
* @param[in] aInfraIfIndex The index of the infrastructure interface to discover the NAT64 prefix. * @param[in] aInfraIfIndex The index of the infrastructure interface to discover the NAT64 prefix.
* *
* @retval OT_ERROR_NONE Successfully request NAT64 prefix discovery. * @retval OT_ERROR_NONE Successfully requested NAT64 prefix discovery.
* @retval OT_ERROR_FAILED Failed to request NAT64 prefix discovery. * @retval OT_ERROR_FAILED Failed to request NAT64 prefix discovery.
* @retval OT_ERROR_NOT_IMPLEMENTED Platform does not support this discovery method. will rely on RA-based mechanism.
*
* @note This function requests the platform to discover a NAT64 prefix (e.g. using RFC 7050 DNS-based
* discovery). The priority of the discovered prefix is lower than that of the prefix discovered via Router
* Advertisements PREF64 option (RFC 8781).
*/ */
otError otPlatInfraIfDiscoverNat64Prefix(uint32_t aInfraIfIndex); otError otPlatInfraIfDiscoverNat64Prefix(uint32_t aInfraIfIndex);
@@ -162,6 +167,10 @@ otError otPlatInfraIfDiscoverNat64Prefix(uint32_t aInfraIfIndex);
* @param[in] aInstance The OpenThread instance structure. * @param[in] aInstance The OpenThread instance structure.
* @param[in] aInfraIfIndex The index of the infrastructure interface on which the NAT64 prefix is discovered. * @param[in] aInfraIfIndex The index of the infrastructure interface on which the NAT64 prefix is discovered.
* @param[in] aIp6Prefix A pointer to NAT64 prefix. * @param[in] aIp6Prefix A pointer to NAT64 prefix.
*
* @note This function is used to report a NAT64 prefix discovered by the platform (e.g. using RFC 7050 DNS-based
* discovery). The priority of the discovered prefix is lower than that of the prefix discovered via Router
* Advertisements PREF64 option (RFC 8781).
*/ */
extern void otPlatInfraIfDiscoverNat64PrefixDone(otInstance *aInstance, extern void otPlatInfraIfDiscoverNat64PrefixDone(otInstance *aInstance,
uint32_t aInfraIfIndex, uint32_t aInfraIfIndex,