espressif/openthread
1
0
Fork 0
mirror of https://github.com/espressif/openthread.git synced 2026-07-24 21:14:06 +00:00
Code Issues Packages Projects Releases Wiki Activity

[link-metrics] update link metrics callback parameter (#9343)

Browse Source 
This commit updates the type of parameter `status` in
`otLinkMetricsReportCallback` and `otLinkMetricsMgmtResponseCallback`
from `uint8_t` to `otLinkMetricsStatus` for better readability.
This commit is contained in:
Li Cao
2023-08-14 02:43:03 +08:00
committed by GitHub
parent 6f73ce204c
commit 73daf43bbd
7 changed files with 33 additions and 23 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 (349)
#define OPENTHREAD_API_VERSION (350)
/**
* @addtogroup api-instance
include/openthread/link_metrics.h
+4 -2
View File
@@ -118,7 +118,7 @@ typedef enum otLinkMetricsStatus
*/
typedef void (*otLinkMetricsReportCallback)(const otIp6Address *aSource,
const otLinkMetricsValues *aMetricsValues,
uint8_t aStatus,
otLinkMetricsStatus aStatus,
void *aContext);
/**
* Pointer is called when a Link Metrics Management Response is received.
@@ -128,7 +128,9 @@ typedef void (*otLinkMetricsReportCallback)(const otIp6Address *aSource,
* @param[in] aContext A pointer to application-specific context.
*
*/
typedef void (*otLinkMetricsMgmtResponseCallback)(const otIp6Address *aSource, uint8_t aStatus, void *aContext);
typedef void (*otLinkMetricsMgmtResponseCallback)(const otIp6Address *aSource,
otLinkMetricsStatus aStatus,
void *aContext);
/**
* Pointer is called when Enh-ACK Probing IE is received.
src/cli/cli.cpp
+7 -5
View File
@@ -3575,7 +3575,7 @@ exit:
#if OPENTHREAD_CONFIG_MLE_LINK_METRICS_INITIATOR_ENABLE
void Interpreter::HandleLinkMetricsReport(const otIp6Address *aAddress,
const otLinkMetricsValues *aMetricsValues,
uint8_t aStatus,
otLinkMetricsStatus aStatus,
void *aContext)
{
static_cast<Interpreter *>(aContext)->HandleLinkMetricsReport(aAddress, aMetricsValues, aStatus);
@@ -3608,7 +3608,7 @@ void Interpreter::PrintLinkMetricsValue(const otLinkMetricsValues *aMetricsValue
void Interpreter::HandleLinkMetricsReport(const otIp6Address *aAddress,
const otLinkMetricsValues *aMetricsValues,
uint8_t aStatus)
otLinkMetricsStatus aStatus)
{
OutputFormat("Received Link Metrics Report from: ");
OutputIp6AddressLine(*aAddress);
@@ -3629,12 +3629,14 @@ void Interpreter::HandleLinkMetricsReport(const otIp6Address *aAddress,
}
}
void Interpreter::HandleLinkMetricsMgmtResponse(const otIp6Address *aAddress, uint8_t aStatus, void *aContext)
void Interpreter::HandleLinkMetricsMgmtResponse(const otIp6Address *aAddress,
otLinkMetricsStatus aStatus,
void *aContext)
{
static_cast<Interpreter *>(aContext)->HandleLinkMetricsMgmtResponse(aAddress, aStatus);
}
void Interpreter::HandleLinkMetricsMgmtResponse(const otIp6Address *aAddress, uint8_t aStatus)
void Interpreter::HandleLinkMetricsMgmtResponse(const otIp6Address *aAddress, otLinkMetricsStatus aStatus)
{
OutputFormat("Received Link Metrics Management Response from: ");
OutputIp6AddressLine(*aAddress);
@@ -3664,7 +3666,7 @@ void Interpreter::HandleLinkMetricsEnhAckProbingIe(otShortAddress aS
}
}
const char *Interpreter::LinkMetricsStatusToStr(uint8_t aStatus)
const char *Interpreter::LinkMetricsStatusToStr(otLinkMetricsStatus aStatus)
{
static const char *const kStatusStrings[] = {
"Success", // (0) OT_LINK_METRICS_STATUS_SUCCESS
src/cli/cli.hpp
+7 -5
View File
@@ -512,16 +512,18 @@ private:
static void HandleLinkMetricsReport(const otIp6Address *aAddress,
const otLinkMetricsValues *aMetricsValues,
uint8_t aStatus,
otLinkMetricsStatus aStatus,
void *aContext);
void HandleLinkMetricsReport(const otIp6Address *aAddress,
const otLinkMetricsValues *aMetricsValues,
uint8_t aStatus);
otLinkMetricsStatus aStatus);
static void HandleLinkMetricsMgmtResponse(const otIp6Address *aAddress, uint8_t aStatus, void *aContext);
static void HandleLinkMetricsMgmtResponse(const otIp6Address *aAddress,
otLinkMetricsStatus aStatus,
void *aContext);
void HandleLinkMetricsMgmtResponse(const otIp6Address *aAddress, uint8_t aStatus);
void HandleLinkMetricsMgmtResponse(const otIp6Address *aAddress, otLinkMetricsStatus aStatus);
static void HandleLinkMetricsEnhAckProbingIe(otShortAddress aShortAddress,
const otExtAddress *aExtAddress,
@@ -532,7 +534,7 @@ private:
const otExtAddress *aExtAddress,
const otLinkMetricsValues *aMetricsValues);
const char *LinkMetricsStatusToStr(uint8_t aStatus);
const char *LinkMetricsStatusToStr(otLinkMetricsStatus aStatus);
#endif // OPENTHREAD_CONFIG_MLE_LINK_METRICS_INITIATOR_ENABLE
static void HandleDetachGracefullyResult(void *aContext);
src/core/thread/link_metrics.cpp
+2 -2
View File
@@ -219,7 +219,7 @@ void Initiator::HandleReport(const Message &aMessage, uint16_t aOffset, uint16_t
VerifyOrExit(hasStatus || hasReport);
mReportCallback.Invoke(&aAddress, hasStatus ? nullptr : &values,
hasStatus ? static_cast<Status>(status) : kStatusSuccess);
hasStatus ? MapEnum(static_cast<Status>(status)) : MapEnum(kStatusSuccess));
exit:
LogDebg("HandleReport, error:%s", ErrorToString(error));
@@ -337,7 +337,7 @@ Error Initiator::HandleManagementResponse(const Message &aMessage, const Ip6::Ad
VerifyOrExit(hasStatus, error = kErrorParse);
mMgmtResponseCallback.Invoke(&aAddress, status);
mMgmtResponseCallback.Invoke(&aAddress, MapEnum(static_cast<Status>(status)));
exit:
return error;
src/ncp/ncp_base.hpp
+6 -4
View File
@@ -312,16 +312,18 @@ protected:
#if OPENTHREAD_CONFIG_MLE_LINK_METRICS_INITIATOR_ENABLE
static void HandleLinkMetricsReport_Jump(const otIp6Address *aSource,
const otLinkMetricsValues *aMetricsValues,
uint8_t aStatus,
otLinkMetricsStatus aStatus,
void *aContext);
void HandleLinkMetricsReport(const otIp6Address *aSource,
const otLinkMetricsValues *aMetricsValues,
uint8_t aStatus);
otLinkMetricsStatus aStatus);
static void HandleLinkMetricsMgmtResponse_Jump(const otIp6Address *aSource, uint8_t aStatus, void *aContext);
static void HandleLinkMetricsMgmtResponse_Jump(const otIp6Address *aSource,
otLinkMetricsStatus aStatus,
void *aContext);
void HandleLinkMetricsMgmtResponse(const otIp6Address *aSource, uint8_t aStatus);
void HandleLinkMetricsMgmtResponse(const otIp6Address *aSource, otLinkMetricsStatus aStatus);
static void HandleLinkMetricsEnhAckProbingIeReport_Jump(otShortAddress aShortAddress,
const otExtAddress *aExtAddress,
src/ncp/ncp_base_mtd.cpp
+6 -4
View File
@@ -4230,7 +4230,7 @@ void NcpBase::HandleJoinerCallback(otError aError)
#if OPENTHREAD_CONFIG_MLE_LINK_METRICS_INITIATOR_ENABLE
void NcpBase::HandleLinkMetricsReport_Jump(const otIp6Address *aSource,
const otLinkMetricsValues *aMetricsValues,
uint8_t aStatus,
otLinkMetricsStatus aStatus,
void *aContext)
{
static_cast<NcpBase *>(aContext)->HandleLinkMetricsReport(aSource, aMetricsValues, aStatus);
@@ -4238,7 +4238,7 @@ void NcpBase::HandleLinkMetricsReport_Jump(const otIp6Address *aSource,
void NcpBase::HandleLinkMetricsReport(const otIp6Address *aSource,
const otLinkMetricsValues *aMetricsValues,
uint8_t aStatus)
otLinkMetricsStatus aStatus)
{
SuccessOrExit(mEncoder.BeginFrame(SPINEL_HEADER_FLAG | SPINEL_HEADER_IID_0, SPINEL_CMD_PROP_VALUE_IS,
SPINEL_PROP_THREAD_LINK_METRICS_QUERY_RESULT));
@@ -4253,12 +4253,14 @@ exit:
return;
}
void NcpBase::HandleLinkMetricsMgmtResponse_Jump(const otIp6Address *aSource, uint8_t aStatus, void *aContext)
void NcpBase::HandleLinkMetricsMgmtResponse_Jump(const otIp6Address *aSource,
otLinkMetricsStatus aStatus,
void *aContext)
{
static_cast<NcpBase *>(aContext)->HandleLinkMetricsMgmtResponse(aSource, aStatus);
}
void NcpBase::HandleLinkMetricsMgmtResponse(const otIp6Address *aSource, uint8_t aStatus)
void NcpBase::HandleLinkMetricsMgmtResponse(const otIp6Address *aSource, otLinkMetricsStatus aStatus)
{
SuccessOrExit(mEncoder.BeginFrame(SPINEL_HEADER_FLAG | SPINEL_HEADER_IID_0, SPINEL_CMD_PROP_VALUE_IS,
SPINEL_PROP_THREAD_LINK_METRICS_MGMT_RESPONSE));