ot::Dns::LeaseOption class

Syntax

Show:

Summary

Declaration

from dns_types.hpp:2480

class LeaseOption : public Option { public: void InitAsShortVariant(uint32_t aLeaseInterval); void InitAsLongVariant(uint32_t aLeaseInterval, uint32_t aKeyLeaseInterval); bool IsShortVariant(void) const { return (GetOptionLength() == kShortLength); } bool IsValid(void) const; uint32_t GetLeaseInterval(void) const { return BigEndian::HostSwap32(mLeaseInterval); } uint32_t GetKeyLeaseInterval(void) const { return IsShortVariant() ? GetLeaseInterval() : BigEndian::HostSwap32(mKeyLeaseInterval); } Error ReadFrom(const Message &aMessage, uint16_t aOffset, uint16_t aLength); private: static constexpr uint16_t kShortLength = sizeof(uint32_t); static constexpr uint16_t kLongLength = sizeof(uint32_t) + sizeof(uint32_t); void SetLeaseInterval(uint32_t aLeaseInterval) { mLeaseInterval = BigEndian::HostSwap32(aLeaseInterval); } void SetKeyLeaseInterval(uint32_t aKeyLeaseInterval) { mKeyLeaseInterval = BigEndian::HostSwap32(aKeyLeaseInterval); } uint32_t mLeaseInterval; uint32_t mKeyLeaseInterval; };

Fields

Field

Declared as

ot::Dns::LeaseOption::kShortLength

ot::Dns::LeaseOption::kLongLength

ot::Dns::LeaseOption::mLeaseInterval

uint32_t

ot::Dns::LeaseOption::mKeyLeaseInterval

uint32_t

Methods

InitAsShortVariant()

Initializes the Update Lease Option using the short variant format which contains lease interval only.

InitAsLongVariant()

Initializes the Update Lease Option using the long variant format which contains both lease and key lease intervals.

IsShortVariant() const

Indicates whether or not the Update Lease Option follows the short variant format which contains only the lease interval.

IsValid() const

Tells whether this is a valid Lease Option. Validates that option follows either short or long variant format.

GetLeaseInterval() const

Returns the Update Lease OPT record's lease interval value.

GetKeyLeaseInterval() const

Returns the Update Lease OPT record's key lease interval value. If the Update Lease Option follows the short variant format the lease interval is returned as key lease interval.

ReadFrom()

Searches among the Options is a given message and reads and validates the Update Lease Option if found. Reads the Update Lease Option whether it follows the short or long variant formats.