ot::Ip4::Header class

Syntax

Show:

Summary

Declaration

class Header : public Clearable<Header> { public: static constexpr uint8_t kVersionIhlOffset = 0; static constexpr uint8_t kTrafficClassOffset = 1; static constexpr uint8_t kTotalLengthOffset = 2; static constexpr uint8_t kIdentificationOffset = 4; static constexpr uint8_t kFlagsFragmentOffset = 6; static constexpr uint8_t kTtlOffset = 8; static constexpr uint8_t kProtocolOffset = 9; static constexpr uint8_t kHeaderChecksumOffset = 10; static constexpr uint8_t kSourceAddressOffset = 12; static constexpr uint8_t kDestinationAddressOffset = 16; bool IsValid(void) const { return IsVersion4(); } void InitVersionIhl(void) { SetVersionIhl(kVersIhlInit); } void SetVersionIhl(uint8_t aVersionIhl) { mVersIhl = aVersionIhl; } bool IsVersion4(void) const { return (mVersIhl & kVersionMask) == kVersion4; } uint8_t GetDscpEcn(void) const { return mDscpEcn; } uint8_t GetDscp(void) const { return (mDscpEcn & kDscpMask) >> kDscpOffset; } void SetDscp(uint8_t aDscp) { mDscpEcn = static_cast<uint8_t>((mDscpEcn & ~kDscpMask) | (aDscp << kDscpOffset)); } Ecn GetEcn(void) const { return static_cast<Ecn>(mDscpEcn & kEcnMask); } void SetEcn(Ecn aEcn) { mDscpEcn = ((mDscpEcn & ~kEcnMask) | aEcn); } uint16_t GetTotalLength(void) const { return BigEndian::HostSwap16(mTotalLength); } void SetTotalLength(uint16_t aLength) { mTotalLength = BigEndian::HostSwap16(aLength); } uint8_t GetProtocol(void) const { return mProtocol; } void SetProtocol(uint8_t aProtocol) { mProtocol = aProtocol; } uint16_t GetChecksum(void) const { return BigEndian::HostSwap16(mHeaderChecksum); } void SetChecksum(uint16_t aChecksum) { mHeaderChecksum = BigEndian::HostSwap16(aChecksum); } uint16_t GetIdentification(void) const { return BigEndian::HostSwap16(mIdentification); } void SetIdentification(uint16_t aIdentification) { mIdentification = BigEndian::HostSwap16(aIdentification); } uint8_t GetTtl(void) const { return mTtl; } void SetTtl(uint8_t aTtl) { mTtl = aTtl; } Address &GetSource(void) { return mSource; } const Address &GetSource(void) const { return mSource; } void SetSource(const Address &aSource) { mSource = aSource; } Address &GetDestination(void) { return mDestination; } const Address &GetDestination(void) const { return mDestination; } void SetDestination(const Address &aDestination) { mDestination = aDestination; } Error ParseFrom(const Message &aMessage); bool GetDf(void) const { return BigEndian::HostSwap16(mFlagsFragmentOffset) & kFlagsDf; } bool GetMf(void) const { return BigEndian::HostSwap16(mFlagsFragmentOffset) & kFlagsMf; } uint16_t GetFragmentOffset(void) const { return BigEndian::HostSwap16(mFlagsFragmentOffset) & kFragmentOffsetMask; } private: static constexpr uint8_t kVersion4 = 0x40; static constexpr uint8_t kVersionMask = 0xf0; static constexpr uint8_t kIhlMask = 0x0f; static constexpr uint8_t kDscpOffset = 2; static constexpr uint16_t kDscpMask = 0xfc; static constexpr uint8_t kEcnOffset = 0; static constexpr uint8_t kEcnMask = 0x03; static constexpr uint16_t kFlagsMask = 0xe000; static constexpr uint16_t kFlagsDf = 0x4000; static constexpr uint16_t kFlagsMf = 0x2000; static constexpr uint16_t kFragmentOffsetMask = 0x1fff; static constexpr uint32_t kVersIhlInit = 0x45; uint8_t mVersIhl; uint8_t mDscpEcn; uint16_t mTotalLength; uint16_t mIdentification; uint16_t mFlagsFragmentOffset; uint8_t mTtl; uint8_t mProtocol; uint16_t mHeaderChecksum; Address mSource; Address mDestination; };