ot::Cli::NetworkData class

Implements the Network Data CLI.

Syntax

Show:

Summary

Declaration

from cli_network_data.hpp:49

class NetworkData : private Utils { public: static constexpr uint16_t kFlagsStringSize = 17; typedef char FlagsString[kFlagsStringSize]; NetworkData(otInstance *aInstance, OutputImplementer &aOutputImplementer); otError Process(Arg aArgs[]); void OutputPrefix(const otBorderRouterConfig &aConfig); void OutputRoute(const otExternalRouteConfig &aConfig); void OutputService(const otServiceConfig &aConfig); static void PrefixFlagsToString(const otBorderRouterConfig &aConfig, FlagsString &aString); static void RouteFlagsToString(const otExternalRouteConfig &aConfig, FlagsString &aString); private: using Command = CommandEntry<NetworkData>; static constexpr uint16_t kAnyRloc16 = 0xffff; template <CommandId kCommandId> otError Process(Arg aArgs[]); otError GetNextPrefix(otNetworkDataIterator *aIterator, otBorderRouterConfig *aConfig, bool aLocal); otError GetNextRoute(otNetworkDataIterator *aIterator, otExternalRouteConfig *aConfig, bool aLocal); otError GetNextService(otNetworkDataIterator *aIterator, otServiceConfig *aConfig, bool aLocal); otError OutputBinary(bool aLocal); void OutputNetworkData(bool aLocal, uint16_t aRloc16); #if OPENTHREAD_CONFIG_BORDER_ROUTER_SIGNAL_NETWORK_DATA_FULL static void HandleNetdataFull(void *aContext) { static_cast<NetworkData *>(aContext)->HandleNetdataFull(); } void HandleNetdataFull(void) { mFullCallbackWasCalled = true; } bool mFullCallbackWasCalled; #endif };

Fields

Field

Description

Declared as

ot::Cli::NetworkData::kFlagsStringSize

This constant specifies the string size for representing Network Data prefix/route entry flags. BorderRouter (OnMeshPrefix) TLV uses `uint16_t` for its flags and ExternalRoute uses `uint8_t`, though some of the bits are not currently used and reserved for future, so 17 chars string (16 flags plus null char at end of string) covers current and future flags.

ot::Cli::NetworkData::kAnyRloc16

ot::Cli::NetworkData::mFullCallbackWasCalled

bool

Methods

Process()

@cli netdata show

 netdata show
 Prefixes:
 fd00:dead:beef:cafe::/64 paros med dc00
 Routes:
 fd49:7770:7fc5:0::/64 s med 4000
 Services:
 44970 5d c000 s 4000 0
 44970 01 9a04b000000e10 s 4000 1
 Contexts:
 fd00:dead:beef:cafe::/64 1 c
 Commissioning:
 1248 dc00 9988 00000000000120000000000000000000 e
 Done
 

 netdata show -x
 08040b02174703140040fd00deadbeefcafe0504dc00330007021140
 Done
 

 netdata show 0xdc00
 Prefixes:
 fd00:dead:beef:cafe::/64 paros med dc00
 Routes:
 Services:
 Done
 @cparam netdata show [@ca{-x}|@ca{rloc16}]
 *   The optional `-x` argument gets Network Data as hex-encoded TLVs.
 *   The optional `rloc16` argument gets all prefix/route/service entries associated with a given RLOC16.
 @par
 `netdata show` from OT CLI gets full Network Data received from the Leader. This command uses several
 API functions to combine prefixes, routes, and services, including #otNetDataGetNextOnMeshPrefix,
 #otNetDataGetNextRoute, #otNetDataGetNextService and #otNetDataGetNextLowpanContextInfo.
 @par
 On-mesh prefixes are listed under `Prefixes` header:
 * The on-mesh prefix
 * Flags
   * p: Preferred flag
   * a: Stateless IPv6 Address Autoconfiguration flag
   * d: DHCPv6 IPv6 Address Configuration flag
   * c: DHCPv6 Other Configuration flag
   * r: Default Route flag
   * o: On Mesh flag
   * s: Stable flag
   * n: Nd Dns flag
   * D: Domain Prefix flag (only available for Thread 1.2).
 * Preference `high`, `med`, or `low`
 * RLOC16 of device which added the on-mesh prefix
 @par
 External Routes are listed under `Routes` header:
 * The route prefix
 * Flags
   * s: Stable flag
   * n: NAT64 flag
 * Preference `high`, `med`, or `low`
 * RLOC16 of device which added the route prefix
 @par
 Service entries are listed under `Services` header:
 * Enterprise number
 * Service data (as hex bytes)
 * Server data (as hex bytes)
 * Flags
   * s: Stable flag
 * RLOC16 of devices which added the service entry
 * Service ID
 @par
 6LoWPAN Context IDs are listed under `Contexts` header:
 * The prefix
 * Context ID
 * Compress flag (`c` if marked or `-` otherwise).
 @par
 Commissioning Dataset information is printed under `Commissioning` header:
 * Session ID if present in Dataset or `-` otherwise
 * Border Agent RLOC16 (in hex) if present in Dataset or `-` otherwise
 * Joiner UDP port number if present in Dataset or `-` otherwise
 * Steering Data (as hex bytes) if present in Dataset or `-` otherwise
 * Flags:
   * e: If Dataset contains any extra unknown TLV
 @par
 @moreinfo{@netdata}.
 @csa{br omrprefix}
 @csa{br onlinkprefix}
 @sa otBorderRouterGetNetData