Symbols

loading (3/5)...

Files

loading (4/5)...

Summary Syntax Methods References Class Tree Instances

SourceVuESP-IDF Framework and ExamplesESP-IDFot::Dhcp6::Client

ot::Dhcp6::Client class

Implements DHCPv6 Client.

Syntax

Show:

Summary

Declaration

from dhcp6_client.hpp:68

class Client : public InstanceLocator, private NonCopyable { public: explicit Client(Instance &aInstance); void UpdateAddresses(void); private: static constexpr uint32_t kTrickleTimerImin = 1; static constexpr uint32_t kTrickleTimerImax = 120; enum IaStatus : uint8_t { kIaStatusInvalid, kIaStatusSolicit, kIaStatusSoliciting, kIaStatusSolicitReplied, }; struct IdentityAssociation { Ip6::Netif::UnicastAddress mNetifAddress; uint32_t mPreferredLifetime; uint32_t mValidLifetime; uint16_t mPrefixAgentRloc; IaStatus mStatus; }; void Start(void); void Stop(void); static bool MatchNetifAddressWithPrefix(const Ip6::Netif::UnicastAddress &aNetifAddress, const Ip6::Prefix &aIp6Prefix); void Solicit(uint16_t aRloc16); void AddIdentityAssociation(uint16_t aRloc16, otIp6Prefix &aIp6Prefix); void RemoveIdentityAssociation(uint16_t aRloc16, otIp6Prefix &aIp6Prefix); bool ProcessNextIdentityAssociation(void); Error AppendHeader(Message &aMessage); Error AppendClientIdentifier(Message &aMessage); Error AppendIaNa(Message &aMessage, uint16_t aRloc16); Error AppendIaAddress(Message &aMessage, uint16_t aRloc16); Error AppendElapsedTime(Message &aMessage); Error AppendRapidCommit(Message &aMessage); void HandleUdpReceive(Message &aMessage, const Ip6::MessageInfo &aMessageInfo); void ProcessReply(Message &aMessage); uint16_t FindOption(Message &aMessage, uint16_t aOffset, uint16_t aLength, Code aCode); Error ProcessServerIdentifier(Message &aMessage, uint16_t aOffset); Error ProcessClientIdentifier(Message &aMessage, uint16_t aOffset); Error ProcessIaNa(Message &aMessage, uint16_t aOffset); Error ProcessStatusCode(Message &aMessage, uint16_t aOffset); Error ProcessIaAddress(Message &aMessage, uint16_t aOffset); static void HandleTrickleTimer(TrickleTimer &aTrickleTimer); void HandleTrickleTimer(void); using ClientSocket = Ip6::Udp::SocketIn<Client, &Client::HandleUdpReceive>; ClientSocket mSocket; TrickleTimer mTrickleTimer; TransactionId mTransactionId; TimeMilli mStartTime; IdentityAssociation mIdentityAssociations[OPENTHREAD_CONFIG_DHCP6_CLIENT_NUM_PREFIXES]; IdentityAssociation *mIdentityAssociationCurrent; };

Fields

Field

Declared as

ot::Dhcp6::Client::kTrickleTimerImin

ot::Dhcp6::Client::kTrickleTimerImax

ot::Dhcp6::Client::mSocket

ClientSocket

ot::Dhcp6::Client::mTrickleTimer

TrickleTimer

ot::Dhcp6::Client::mTransactionId

TransactionId

ot::Dhcp6::Client::mStartTime

TimeMilli

ot::Dhcp6::Client::mIdentityAssociations

IdentityAssociation[OPENTHREAD_CONFIG_DHCP6_CLIENT_NUM_PREFIXES]

ot::Dhcp6::Client::mIdentityAssociationCurrent

IdentityAssociation *

Methods

UpdateAddresses()

Update addresses that shall be automatically created using DHCP.

Start()

Stop()

MatchNetifAddressWithPrefix()

Solicit()

AddIdentityAssociation()

RemoveIdentityAssociation()

ProcessNextIdentityAssociation()

AppendHeader()

AppendClientIdentifier()

AppendIaNa()

AppendIaAddress()

AppendElapsedTime()

AppendRapidCommit()

HandleUdpReceive()

ProcessReply()

FindOption()

ProcessServerIdentifier()

ProcessClientIdentifier()

ProcessIaNa()

ProcessStatusCode()

ProcessIaAddress()

HandleTrickleTimer()

FindOption()

References

Code

Location

Scope

Referrer

class Client : public InstanceLocator, private NonCopyable

dhcp6_client.hpp:68

Client::Client(Instance &aInstance)

dhcp6_client.cpp:45

ot::Dhcp6::Client::Client()

bool Client::MatchNetifAddressWithPrefix(const Ip6::Netif::UnicastAddress &aNetifAddress, const Ip6::Prefix &aIp6Prefix)

dhcp6_client.cpp:55

ot::Dhcp6::Client::MatchNetifAddressWithPrefix()

void Client::UpdateAddresses(void)

dhcp6_client.cpp:60

ot::Dhcp6::Client::UpdateAddresses()

void Client::Start(void)

dhcp6_client.cpp:161

ot::Dhcp6::Client::Start()

void Client::Stop(void)

dhcp6_client.cpp:174

ot::Dhcp6::Client::Stop()

bool Client::ProcessNextIdentityAssociation(void)

dhcp6_client.cpp:180

ot::Dhcp6::Client::ProcessNextIdentityAssociation()

void Client::HandleTrickleTimer(TrickleTimer &aTrickleTimer) { aTrickleTimer.Get<Client>().HandleTrickleTimer(); }

dhcp6_client.cpp:213

ot::Dhcp6::Client::HandleTrickleTimer()

void Client::HandleTrickleTimer(void)

dhcp6_client.cpp:215

ot::Dhcp6::Client::HandleTrickleTimer()

void Client::Solicit(uint16_t aRloc16)

dhcp6_client.cpp:252

ot::Dhcp6::Client::Solicit()

Error Client::AppendHeader(Message &aMessage)

dhcp6_client.cpp:287

ot::Dhcp6::Client::AppendHeader()

Error Client::AppendElapsedTime(Message &aMessage)

dhcp6_client.cpp:297

ot::Dhcp6::Client::AppendElapsedTime()

Error Client::AppendClientIdentifier(Message &aMessage)

dhcp6_client.cpp:306

ot::Dhcp6::Client::AppendClientIdentifier()

Error Client::AppendIaNa(Message &aMessage, uint16_t aRloc16)

dhcp6_client.cpp:321

ot::Dhcp6::Client::AppendIaNa()

Error Client::AppendIaAddress(Message &aMessage, uint16_t aRloc16)

dhcp6_client.cpp:357

ot::Dhcp6::Client::AppendIaAddress()

Error Client::AppendRapidCommit(Message &aMessage)

dhcp6_client.cpp:382

ot::Dhcp6::Client::AppendRapidCommit()

void Client::HandleUdpReceive(Message &aMessage, const Ip6::MessageInfo &aMessageInfo)

dhcp6_client.cpp:390

ot::Dhcp6::Client::HandleUdpReceive()

void Client::ProcessReply(Message &aMessage)

dhcp6_client.cpp:408

ot::Dhcp6::Client::ProcessReply()

uint16_t Client::FindOption(Message &aMessage, uint16_t aOffset, uint16_t aLength, Dhcp6::Code aCode)

dhcp6_client.cpp:440

ot::Dhcp6::Client::FindOption()

Error Client::ProcessServerIdentifier(Message &aMessage, uint16_t aOffset)

dhcp6_client.cpp:464

ot::Dhcp6::Client::ProcessServerIdentifier()

Error Client::ProcessClientIdentifier(Message &aMessage, uint16_t aOffset)

dhcp6_client.cpp:480

ot::Dhcp6::Client::ProcessClientIdentifier()

Error Client::ProcessIaNa(Message &aMessage, uint16_t aOffset)

dhcp6_client.cpp:497

ot::Dhcp6::Client::ProcessIaNa()

Error Client::ProcessStatusCode(Message &aMessage, uint16_t aOffset)

dhcp6_client.cpp:533

ot::Dhcp6::Client::ProcessStatusCode()

Error Client::ProcessIaAddress(Message &aMessage, uint16_t aOffset)

dhcp6_client.cpp:546

ot::Dhcp6::Client::ProcessIaAddress()

Dhcp6::Client mDhcp6Client;

instance.hpp:496

ot::Instance

ot::Instance::mDhcp6Client

template <> inline Dhcp6::Client &Instance::Get(void) { return mDhcp6Client; }

instance.hpp:944

ot::Instance

ot::Instance::Get()

Get<Dhcp6::Client>().UpdateAddresses();

mle.cpp:1156

ot::Mle::Mle::HandleNotifierEvents()

Call Tree

All items filtered out

Data Use

All items filtered out

Class Tree

ot::Dhcp6::Client is inherited by 2 classess:

ot::Dhcp6::Client

ot::NonCopyable

ot::InstanceLocator

Override Tree

All items filtered out

Implementations

All items filtered out

Instances

Instance

Scope

Location

Project

ot::Instance::mDhcp6Client

return

Lifecycle

All items filtered out