espressif/openthread
1
0
Fork 0
mirror of https://github.com/espressif/openthread.git synced 2026-08-04 18:07:47 +00:00
Code Issues Packages Projects Releases Wiki Activity

[dns-headers] fix typos, rename some methods (#6059)

Browse Source 
This commit fixes some typos in the documentation/comments and
renames some of methods getting number of RRs in a DNS header
section (`Get{Section}RecordCount` <- `Get{Section}RecordsCount`).
This commit is contained in:
Abtin Keshavarzian
2021-01-12 09:55:02 -08:00
committed by GitHub
parent c6ca43a4e1
commit 61d3c645aa
2 changed files with 20 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/core/net/dns_headers.cpp
+2 -2
View File
@@ -70,7 +70,7 @@ otError Header::ResponseCodeToError(Response aResponse)
break;
case kResponseNameError: // Name that ought to exist, does not exists.
case kResponseRecordNotExists: // Some RRset that out to exist, does not exist.
case kResponseRecordNotExists: // Some RRset that ought to exist, does not exist.
error = OT_ERROR_NOT_FOUND;
break;
@@ -83,7 +83,7 @@ otError Header::ResponseCodeToError(Response aResponse)
break;
case kResponseNameExists: // Some name that ought not to exist, does exist.
case kResponseRecordExists: // Some RRset that ought not to exits, does exist.
case kResponseRecordExists: // Some RRset that ought not to exist, does exist.
error = OT_ERROR_DUPLICATED;
break;
src/core/net/dns_headers.hpp
+18 -15
View File
@@ -260,7 +260,7 @@ public:
kResponseNotImplemented = 4, ///< Server does not support the query type (OpCode).
kResponseRefused = 5, ///< Server refused to perform operation for policy or security reasons.
kResponseNameExists = 6, ///< Some name that ought not to exist, does exist.
kResponseRecordExists = 7, ///< Some RRset that ought not to exits, does exist.
kResponseRecordExists = 7, ///< Some RRset that ought not to exist, does exist.
kResponseRecordNotExists = 8, ///< Some RRset that ought to exist, does not exist.
kResponseNotAuth = 9, ///< Service is not authoritative for zone.
kResponseNotZone = 10, ///< A name is not in the zone.
@@ -299,7 +299,7 @@ public:
* - kResponseNotImplemented (4) : Server does not support the query type (OpCode) -> OT_ERROR_NOT_IMPLEMENTED
* - kResponseRefused (5) : Server refused for policy/security reasons -> OT_ERROR_SECURITY
* - kResponseNameExists (6) : Some name that ought not to exist, does exist -> OT_ERROR_DUPLICATED
* - kResponseRecordExists (7) : Some RRset that ought not to exits, does exist -> OT_ERROR_DUPLICATED
* - kResponseRecordExists (7) : Some RRset that ought not to exist, does exist -> OT_ERROR_DUPLICATED
* - kResponseRecordNotExists (8) : Some RRset that ought to exist, does not exist -> OT_ERROR_NOT_FOUND
* - kResponseNotAuth (9) : Service is not authoritative for zone -> OT_ERROR_SECURITY
* - kResponseNotZone (10) : A name is not in the zone -> OT_ERROR_PARSE
@@ -351,7 +351,7 @@ public:
* @returns The number of entries in authority records section.
*
*/
uint16_t GetAuthorityRecordsCount(void) const { return HostSwap16(mNsCount); }
uint16_t GetAuthorityRecordCount(void) const { return HostSwap16(mNsCount); }
/**
* This method sets the number of entries in authority records section.
@@ -359,7 +359,7 @@ public:
* @param[in] aCount The number of entries in authority records section.
*
*/
void SetAuthorityRecordsCount(uint16_t aCount) { mNsCount = HostSwap16(aCount); }
void SetAuthorityRecordCount(uint16_t aCount) { mNsCount = HostSwap16(aCount); }
/**
* This method returns the number of entries in additional records section.
@@ -367,7 +367,7 @@ public:
* @returns The number of entries in additional records section.
*
*/
uint16_t GetAdditionalRecordsCount(void) const { return HostSwap16(mArCount); }
uint16_t GetAdditionalRecordCount(void) const { return HostSwap16(mArCount); }
/**
* This method sets the number of entries in additional records section.
@@ -375,7 +375,7 @@ public:
* @param[in] aCount The number of entries in additional records section.
*
*/
void SetAdditionalRecordsCount(uint16_t aCount) { mArCount = HostSwap16(aCount); }
void SetAdditionalRecordCount(uint16_t aCount) { mArCount = HostSwap16(aCount); }
private:
/**
@@ -394,7 +394,6 @@ private:
kTcFlagMask = 0x01 << kTcFlagOffset, // TC Flag mask.
kRdFlagOffset = 0, // RD Flag offset.
kRdFlagMask = 0x01 << kRdFlagOffset, // RD Flag mask.
kRaFlagOffset = 7, // RA Flag offset.
kRaFlagMask = 0x01 << kRaFlagOffset, // RA Flag mask.
kRCodeOffset = 0, // RCODE field offset.
@@ -466,7 +465,7 @@ public:
* @returns The number of records in Update section.
*
*/
uint16_t GetUpdateRecordCount(void) const { return GetAuthorityRecordsCount(); }
uint16_t GetUpdateRecordCount(void) const { return GetAuthorityRecordCount(); }
/**
* This method sets the number of records in Update section.
@@ -474,7 +473,7 @@ public:
* @param[in] aCount The number of records in Update section.
*
*/
void SetUpdateRecordCount(uint16_t aCount) { SetAuthorityRecordsCount(aCount); }
void SetUpdateRecordCount(uint16_t aCount) { SetAuthorityRecordCount(aCount); }
} OT_TOOL_PACKED_END;
@@ -918,7 +917,11 @@ public:
* Other record fields (TTL, address) remain unchanged/uninitialized.
*
*/
void Init(void) { ResourceRecord::Init(kTypeAaaa); }
void Init(void)
{
ResourceRecord::Init(kTypeAaaa);
SetLength(sizeof(Ip6::Address));
}
/**
* This method sets the IPv6 address of the resource record.
@@ -1200,7 +1203,7 @@ public:
*
* Other record fields (TTL, length, ...) remain unchanged/uninitialized.
*
* SIG(0) requires SIG RR to set class field as ANY or `kClassAnyANY (RFC 2931 - section 3).
* SIG(0) requires SIG RR to set class field as ANY or `kClassAny` (RFC 2931 - section 3).
*
* @param[in] aClass The class of the resource record.
*
@@ -1440,18 +1443,18 @@ public:
* This method clears the DNSSEC OK bit flag.
*
*/
void ClearDnsSecurityFlags(void) { mTtl &= ~kDnsSecFlag; }
void ClearDnsSecurityFlag(void) { mTtl &= ~kDnsSecFlag; }
/**
* This method sets the DNSSEC OK bit flag.
*
*/
void SetDnsSecurityFlags(void) { mTtl |= kDnsSecFlag; }
void SetDnsSecurityFlag(void) { mTtl |= kDnsSecFlag; }
private:
// The OPT RR re-purposes the existing CLASS and TTL fields in the
// RR The CLASS field (`uint16_t`) is used for requester UDP
// payload size The TTL field is used for extended Response Code,
// RR. The CLASS field (`uint16_t`) is used for requester UDP
// payload size. The TTL field is used for extended Response Code,
// version and flags as follows:
//
// 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5