ot::Dns::Header class

Syntax

Show:

Summary

Declaration

from dns_types.hpp:74

class Header : public Clearable<Header> { public: Header(void) { Clear(); } uint16_t GetMessageId(void) const { return BigEndian::HostSwap16(mMessageId); } void SetMessageId(uint16_t aMessageId) { mMessageId = BigEndian::HostSwap16(aMessageId); } Error SetRandomMessageId(void); enum Type : uint8_t { kTypeQuery = 0, kTypeResponse = 1, }; Type GetType(void) const { return static_cast<Type>((mFlags[0] & kQrFlagMask) >> kQrFlagOffset); } void SetType(Type aType) { mFlags[0] &= ~kQrFlagMask; mFlags[0] |= static_cast<uint8_t>(aType) << kQrFlagOffset; } enum QueryType : uint8_t { kQueryTypeStandard = 0, kQueryTypeInverse = 1, kQueryTypeStatus = 2, kQueryTypeNotify = 4, kQueryTypeUpdate = 5, kQueryTypeDso = 6, }; QueryType GetQueryType(void) const { return static_cast<QueryType>((mFlags[0] & kOpCodeMask) >> kOpCodeOffset); } void SetQueryType(QueryType aType) { mFlags[0] &= ~kOpCodeMask; mFlags[0] |= static_cast<uint8_t>(aType) << kOpCodeOffset; } bool IsAuthoritativeAnswerFlagSet(void) const { return (mFlags[0] & kAaFlagMask) == kAaFlagMask; } void ClearAuthoritativeAnswerFlag(void) { mFlags[0] &= ~kAaFlagMask; } void SetAuthoritativeAnswerFlag(void) { mFlags[0] |= kAaFlagMask; } bool IsTruncationFlagSet(void) const { return (mFlags[0] & kTcFlagMask) == kTcFlagMask; } void ClearTruncationFlag(void) { mFlags[0] &= ~kTcFlagMask; } void SetTruncationFlag(void) { mFlags[0] |= kTcFlagMask; } bool IsRecursionDesiredFlagSet(void) const { return (mFlags[0] & kRdFlagMask) == kRdFlagMask; } void ClearRecursionDesiredFlag(void) { mFlags[0] &= ~kRdFlagMask; } void SetRecursionDesiredFlag(void) { mFlags[0] |= kRdFlagMask; } bool IsRecursionAvailableFlagSet(void) const { return (mFlags[1] & kRaFlagMask) == kRaFlagMask; } void ClearRecursionAvailableFlag(void) { mFlags[1] &= ~kRaFlagMask; } void SetRecursionAvailableFlag(void) { mFlags[1] |= kRaFlagMask; } enum Response : uint8_t { kResponseSuccess = 0, kResponseFormatError = 1, kResponseServerFailure = 2, kResponseNameError = 3, kResponseNotImplemented = 4, kResponseRefused = 5, kResponseNameExists = 6, kResponseRecordExists = 7, kResponseRecordNotExists = 8, kResponseNotAuth = 9, kResponseNotZone = 10, kDsoTypeNotImplemented = 11, kResponseBadName = 20, kResponseBadAlg = 21, kResponseBadTruncation = 22, }; Response GetResponseCode(void) const { return static_cast<Response>((mFlags[1] & kRCodeMask) >> kRCodeOffset); } void SetResponseCode(Response aResponse) { mFlags[1] &= ~kRCodeMask; mFlags[1] |= static_cast<uint8_t>(aResponse) << kRCodeOffset; } static Error ResponseCodeToError(Response aResponse); uint16_t GetQuestionCount(void) const { return BigEndian::HostSwap16(mQdCount); } void SetQuestionCount(uint16_t aCount) { mQdCount = BigEndian::HostSwap16(aCount); } uint16_t GetAnswerCount(void) const { return BigEndian::HostSwap16(mAnCount); } void SetAnswerCount(uint16_t aCount) { mAnCount = BigEndian::HostSwap16(aCount); } uint16_t GetAuthorityRecordCount(void) const { return BigEndian::HostSwap16(mNsCount); } void SetAuthorityRecordCount(uint16_t aCount) { mNsCount = BigEndian::HostSwap16(aCount); } uint16_t GetAdditionalRecordCount(void) const { return BigEndian::HostSwap16(mArCount); } void SetAdditionalRecordCount(uint16_t aCount) { mArCount = BigEndian::HostSwap16(aCount); } private: static constexpr uint8_t kQrFlagOffset = 7; static constexpr uint8_t kQrFlagMask = 0x01 << kQrFlagOffset; static constexpr uint8_t kOpCodeOffset = 3; static constexpr uint8_t kOpCodeMask = 0x0f << kOpCodeOffset; static constexpr uint8_t kAaFlagOffset = 2; static constexpr uint8_t kAaFlagMask = 0x01 << kAaFlagOffset; static constexpr uint8_t kTcFlagOffset = 1; static constexpr uint8_t kTcFlagMask = 0x01 << kTcFlagOffset; static constexpr uint8_t kRdFlagOffset = 0; static constexpr uint8_t kRdFlagMask = 0x01 << kRdFlagOffset; static constexpr uint8_t kRaFlagOffset = 7; static constexpr uint8_t kRaFlagMask = 0x01 << kRaFlagOffset; static constexpr uint8_t kRCodeOffset = 0; static constexpr uint8_t kRCodeMask = 0x0f << kRCodeOffset; uint16_t mMessageId; uint8_t mFlags[2]; uint16_t mQdCount; uint16_t mAnCount; uint16_t mNsCount; uint16_t mArCount; };

Fields

Methods

GetMessageId() const

Returns the Message ID.

SetMessageId()

Sets the Message ID.

SetRandomMessageId()

Sets the Message ID to a crypto-secure randomly generated number.

GetType() const

Returns the type of the message.

SetType()

Sets the type of the message.

GetQueryType() const

Returns the type of the query.

SetQueryType()

Sets the type of the query.

IsAuthoritativeAnswerFlagSet() const

Specifies in response message if the responding name server is an authority for the domain name in question section.

ClearAuthoritativeAnswerFlag()

Clears the Authoritative Answer flag (AA) in the header.

SetAuthoritativeAnswerFlag()

Sets the Authoritative Answer flag (AA) in the header.

IsTruncationFlagSet() const

Specifies if message is truncated.

ClearTruncationFlag()

Clears the Truncation flag (TC) in the header.

SetTruncationFlag()

Sets the Truncation flag (TC) in the header.

IsRecursionDesiredFlagSet() const

Specifies if resolver wants to direct the name server to pursue the query recursively.

ClearRecursionDesiredFlag()

Clears the Recursion Desired flag (RD) in the header.

SetRecursionDesiredFlag()

Sets the Recursion Desired flag (RD) in the header.

IsRecursionAvailableFlagSet() const

Denotes whether recursive query support is available in the name server.

ClearRecursionAvailableFlag()

Clears the Recursion Available flag (RA) in the header.

SetRecursionAvailableFlag()

Sets the Recursion Available flag (RA) in the header.

GetResponseCode() const

Returns the response code.

SetResponseCode()

Sets the response code.

ResponseCodeToError()

Converts a Response Code into a related `Error`. - kResponseSuccess (0) : Success (no error condition) -> kErrorNone - kResponseFormatError (1) : Server unable to interpret due to format error -> kErrorParse - kResponseServerFailure (2) : Server encountered an internal failure -> kErrorFailed - kResponseNameError (3) : Name that ought to exist, does not exists -> kErrorNotFound - kResponseNotImplemented (4) : Server does not support the query type (OpCode) -> kErrorNotImplemented - kResponseRefused (5) : Server refused for policy/security reasons -> kErrorSecurity - kResponseNameExists (6) : Some name that ought not to exist, does exist -> kErrorDuplicated - kResponseRecordExists (7) : Some RRset that ought not to exist, does exist -> kErrorDuplicated - kResponseRecordNotExists (8) : Some RRset that ought to exist, does not exist -> kErrorNotFound - kResponseNotAuth (9) : Service is not authoritative for zone -> kErrorSecurity - kResponseNotZone (10) : A name is not in the zone -> kErrorParse - kDsoTypeNotImplemented (11) : DSO TLV Type is not implemented -> kErrorNotImplemented - kResponseBadName (20) : Bad name -> kErrorParse - kResponseBadAlg (21) : Bad algorithm -> kErrorSecurity - kResponseBadTruncation (22) : Bad truncation -> kErrorParse - Other error -> kErrorFailed.