Symbols ![]()
loading...
Files ![]()
loading...
ot::NetworkDiagnostic::Client class
This module includes definitions for sending and handling Network Diagnostic Commands.
Syntax
class Client;
class Server : public InstanceLocator, private NonCopyable
{
friend class Tmf::Agent;
friend class Client;
public:
explicit Server(Instance &aInstance);
#if OPENTHREAD_CONFIG_NET_DIAG_VENDOR_INFO_SET_API_ENABLE
const char *GetVendorName(void) const { return mVendorName; }
Error SetVendorName(const char *aVendorName);
const char *GetVendorModel(void) const { return mVendorModel; }
Error SetVendorModel(const char *aVendorModel);
const char *GetVendorSwVersion(void) const { return mVendorSwVersion; }
Error SetVendorSwVersion(const char *aVendorSwVersion);
const char *GetVendorAppUrl(void) const { return mVendorAppUrl; }
Error SetVendorAppUrl(const char *aVendorAppUrl);
#else
const char *GetVendorName(void) const { return kVendorName; }
const char *GetVendorModel(void) const { return kVendorModel; }
const char *GetVendorSwVersion(void) const { return kVendorSwVersion; }
const char *GetVendorAppUrl(void) const { return kVendorAppUrl; }
#endif
private:
static constexpr uint16_t kMaxChildEntries = 398;
static constexpr uint16_t kAnswerMessageLengthThreshold = 800;
#if OPENTHREAD_FTD
struct AnswerInfo
{
AnswerInfo(void)
: mAnswerIndex(0)
, mQueryId(0)
, mHasQueryId(false)
, mFirstAnswer(nullptr)
{
}
uint16_t mAnswerIndex;
uint16_t mQueryId;
bool mHasQueryId;
Message::Priority mPriority;
Coap::Message *mFirstAnswer;
};
#endif
static const char kVendorName[];
static const char kVendorModel[];
static const char kVendorSwVersion[];
static const char kVendorAppUrl[];
Error AppendDiagTlv(uint8_t aTlvType, Message &aMessage);
Error AppendIp6AddressList(Message &aMessage);
Error AppendMacCounters(Message &aMessage);
Error AppendRequestedTlvs(const Message &aRequest, Message &aResponse);
void PrepareMessageInfoForDest(const Ip6::Address &aDestination, Tmf::MessageInfo &aMessageInfo) const;
#if OPENTHREAD_MTD
void SendAnswer(const Ip6::Address &aDestination, const Message &aRequest);
#elif OPENTHREAD_FTD
Error AllocateAnswer(Coap::Message *&aAnswer, AnswerInfo &aInfo);
Error CheckAnswerLength(Coap::Message *&aAnswer, AnswerInfo &aInfo);
bool IsLastAnswer(const Coap::Message &aAnswer) const;
void FreeAllRelatedAnswers(Coap::Message &aFirstAnswer);
void PrepareAndSendAnswers(const Ip6::Address &aDestination, const Message &aRequest);
void SendNextAnswer(Coap::Message &aAnswer, const Ip6::Address &aDestination);
Error AppendChildTable(Message &aMessage);
Error AppendChildTableAsChildTlvs(Coap::Message *&aAnswer, AnswerInfo &aInfo);
Error AppendRouterNeighborTlvs(Coap::Message *&aAnswer, AnswerInfo &aInfo);
Error AppendChildTableIp6AddressList(Coap::Message *&aAnswer, AnswerInfo &aInfo);
Error AppendChildIp6AddressListTlv(Coap::Message &aAnswer, const Child &aChild);
static void HandleAnswerResponse(void *aContext,
otMessage *aMessage,
const otMessageInfo *aMessageInfo,
Error aResult);
void HandleAnswerResponse(Coap::Message &aNextAnswer,
Coap::Message *aResponse,
const Ip6::MessageInfo *aMessageInfo,
Error aResult);
#endif
template <Uri kUri> void HandleTmf(Coap::Message &aMessage, const Ip6::MessageInfo &aMessageInfo);
#if OPENTHREAD_CONFIG_NET_DIAG_VENDOR_INFO_SET_API_ENABLE
VendorNameTlv::StringType mVendorName;
VendorModelTlv::StringType mVendorModel;
VendorSwVersionTlv::StringType mVendorSwVersion;
VendorAppUrlTlv::StringType mVendorAppUrl;
#endif
#if OPENTHREAD_FTD
Coap::MessageQueue mAnswerQueue;
#endif
};
DeclareTmfHandler(Server, kUriDiagnosticGetRequest);
DeclareTmfHandler(Server, kUriDiagnosticGetQuery);
DeclareTmfHandler(Server, kUriDiagnosticGetAnswer);
#if OPENTHREAD_CONFIG_TMF_NETDIAG_CLIENT_ENABLE
class Client : public InstanceLocator,
private NonCopyable;
Implemented in ![]()
network_diagnostic.hpp:242
Fields
Field
Declared as
Callback<GetCallback>
References
Code
Location
Scope
Referrer
Class Tree
ot::NetworkDiagnostic::Client is inherited by 2 classess:
Instances
Instance
Scope
Location
Project