espressif/openthread
1
0
Fork 0
mirror of https://github.com/espressif/openthread.git synced 2026-08-14 14:47:46 +00:00
Code Issues Packages Projects Releases Wiki Activity

[network-diagnostic] add method documentation for GetNextDiagTlv (#4992)

Browse Source
This commit is contained in:
Abtin Keshavarzian
2020-05-21 12:05:13 -07:00
committed by Jonathan Hui
parent c4faeea067
commit c90f5f3f3e
1 changed files with 13 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/core/thread/network_diagnostic.hpp
+13
View File
@@ -100,6 +100,19 @@ public:
*/
otError SendDiagnosticReset(const Ip6::Address &aDestination, const uint8_t aTlvTypes[], uint8_t aCount);
/**
* This static method gets the next Network Diagnostic TLV in a given message.
*
* @param[in] aMessage A message.
* @param[inout] aIterator The Network Diagnostic iterator. To get the first TLV it should be set to
* OT_NETWORK_DIAGNOSTIC_ITERATOR_INIT.
* @param[out] aNetworkDiagTlv A reference to a Network Diagnostic TLV to output the next TLV.
*
* @retval OT_ERROR_NONE Successfully found the next Network Diagnostic TLV.
* @retval OT_ERROR_NOT_FOUND No subsequent Network Diagnostic TLV exists in the message.
* @retval OT_ERROR_PARSE Parsing the next Network Diagnostic failed.
*
*/
static otError GetNextDiagTlv(const Coap::Message & aMessage,
otNetworkDiagIterator &aIterator,
otNetworkDiagTlv & aNetworkDiagTlv);