Symbols

loading...

Files

loading (2/5)...

Summary Syntax Methods Related References Class Tree Instances

SourceVuESP-IDF Framework and ExamplesESP-IDFot::MeshCoP::JoinerPskd

ot::MeshCoP::JoinerPskd class

Represents a Joiner PSKd.

Syntax

Show:

Summary

Declaration

from meshcop.hpp:63

class JoinerPskd : public otJoinerPskd, public Clearable<JoinerPskd>, public Unequatable<JoinerPskd> { public: static constexpr uint8_t kMinLength = 6; static constexpr uint8_t kMaxLength = OT_JOINER_MAX_PSKD_LENGTH; bool IsValid(void) const { return IsPskdValid(m8); } Error SetFrom(const char *aPskdString); const char *GetAsCString(void) const { return m8; } uint8_t GetLength(void) const { return static_cast<uint8_t>(StringLength(m8, kMaxLength + 1)); } bool operator==(const JoinerPskd &aOther) const; static bool IsPskdValid(const char *aPskdString); };

Fields

Field

ot::MeshCoP::JoinerPskd::kMinLength

ot::MeshCoP::JoinerPskd::kMaxLength

Methods

IsValid() const

Indicates whether the PSKd if well-formed and valid. Per Thread specification, a Joining Device Credential is encoded as uppercase alphanumeric characters (base32-thread: 0-9, A-Z excluding I, O, Q, and Z for readability) with a minimum length of 6 such characters and a maximum length of 32 such characters.

SetFrom()

Sets the joiner PSKd from a given C string.

GetAsCString() const

Gets the PSKd as a null terminated C string. Must be used after the PSKd is validated, otherwise its behavior is undefined.

GetLength() const

Gets the PSKd string length. Must be used after the PSKd is validated, otherwise its behavior is undefined.

operator() const

Overloads operator `==` to evaluate whether or not two PSKds are equal.

IsPskdValid()

Indicates whether a given PSKd string if well-formed and valid. @sa IsValid().

References

Code

Location

Scope

Referrer

class JoinerPskd : public otJoinerPskd, public Clearable<JoinerPskd>, public Unequatable<JoinerPskd>

DefineCoreType(otJoinerPskd, MeshCoP::JoinerPskd);

meshcop.hpp:515

void CoapSecure::SetPsk(const MeshCoP::JoinerPskd &aPskd)

coap_secure.cpp:106

ot::Coap::CoapSecure::SetPsk()

ot::Coap::CoapSecure::SetPsk()::aPskd

static_assert(static_cast<uint16_t>(MeshCoP::JoinerPskd::kMaxLength) <=

coap_secure.cpp:108

ot::Coap::CoapSecure::SetPsk()

void SetPsk(const MeshCoP::JoinerPskd &aPskd);

coap_secure.hpp:195

ot::Coap::CoapSecure::SetPsk()

ot::Coap::CoapSecure::SetPsk()::aPskd

Error JoinerPskd::SetFrom(const char *aPskdString)

ot::MeshCoP::JoinerPskd::SetFrom()

bool JoinerPskd::operator==(const JoinerPskd &aOther) const

ot::MeshCoP::JoinerPskd::operator() const

ot::MeshCoP::JoinerPskd::operator() const::aOther

bool JoinerPskd::IsPskdValid(const char *aPskdString)

ot::MeshCoP::JoinerPskd::IsPskdValid()

bool operator==(const JoinerPskd &aOther) const;

meshcop.hpp:116

ot::MeshCoP::JoinerPskd::operator() const

ot::MeshCoP::JoinerPskd::operator() const::aOther

DefineCoreType(otJoinerPskd, MeshCoP::JoinerPskd);

meshcop.hpp:515

ot::CoreType::Type

Call Tree

All items filtered out

All items filtered out

Data Use

All items filtered out

All items filtered out

Class Tree

ot::MeshCoP::JoinerPskd is inherited by 1 classes:

ot::MeshCoP::JoinerPskd

Override Tree

All items filtered out

All items filtered out

Implementations

All items filtered out

All items filtered out

Instances

Instance

Scope

Location

Project

ot::MeshCoP::JoinerPskd::operator() const::aOther

ot::MeshCoP::JoinerPskd::operator() const

meshcop.hpp:116

ot::CoreType::Type

meshcop.hpp:515

ot::Coap::CoapSecure::SetPsk()::aPskd

ot::Coap::CoapSecure::SetPsk()

coap_secure.hpp:195

ot::Coap::CoapSecure::SetPsk()::aPskd

ot::Coap::CoapSecure::SetPsk()

coap_secure.cpp:106

ot::MeshCoP::JoinerPskd::operator() const::aOther

ot::MeshCoP::JoinerPskd::operator() const

Lifecycle

All items filtered out

All items filtered out