ot::Ip6::Option class

Syntax

Show:

Summary

Declaration

from ip6_headers.hpp:417

class Option { public: enum Action : uint8_t { kActionSkip = 0x00, kActionDiscard = 0x40, kActionForceIcmp = 0x80, kActionIcmp = 0xc0, }; uint8_t GetType(void) const { return mType; } bool IsPadding(void) const { return (mType == kTypePad1) || (mType == kTypePadN); } Action GetAction(void) const { return static_cast<Action>(mType & kActionMask); } uint8_t GetLength(void) const { return mLength; } uint16_t GetSize(void) const; Error ParseFrom(const Message &aMessage, const OffsetRange &aOffsetRange); protected: static constexpr uint8_t kTypePad1 = 0x00; static constexpr uint8_t kTypePadN = 0x01; void SetType(uint8_t aType) { mType = aType; } void SetLength(uint8_t aLength) { mLength = aLength; } private: static constexpr uint8_t kActionMask = 0xc0; uint8_t mType; uint8_t mLength; };

Fields

Field

Declared as

ot::Ip6::Option::kTypePad1

ot::Ip6::Option::kTypePadN

ot::Ip6::Option::kActionMask

ot::Ip6::Option::mType

uint8_t

ot::Ip6::Option::mLength

uint8_t

Methods

GetType() const

Returns the IPv6 Option Type value.

IsPadding() const

Indicates whether IPv6 Option is padding (either Pad1 or PadN).

GetAction() const

Returns the IPv6 Option action for unrecognized IPv6 Options.

GetLength() const

Returns the IPv6 Option Length value.

GetSize() const

Returns the size (number of bytes) of the IPv6 Option. Returns the proper size of the Option independent of its type, particularly if Option is Pad1 (which does not follow the common Option header structure and has only Type field with no Length field). For other Option types, the returned size includes the Type and Length fields.

ParseFrom()

Parses and validates the IPv6 Option from a given message. The Option is read from @p aOffset in @p aMessage. This method then checks that the entire Option is present within @p aOffsetRange.