Fix typos and formatting in the dns protocol docs

This commit is contained in:
Daniel Thayer 2013-10-15 16:44:28 -05:00
parent e36fcf0190
commit bc337f3d5a
2 changed files with 26 additions and 24 deletions

View file

@ -8,7 +8,8 @@ export {
const EDNS = 41; ##< An OPT RR TYPE value described by EDNS. const EDNS = 41; ##< An OPT RR TYPE value described by EDNS.
const ANY = 255; ##< A QTYPE value describing a request for all records. const ANY = 255; ##< A QTYPE value describing a request for all records.
## Mapping of DNS query type codes to human readable string representation. ## Mapping of DNS query type codes to human readable string
## representation.
const query_types = { const query_types = {
[1] = "A", [2] = "NS", [3] = "MD", [4] = "MF", [1] = "A", [2] = "NS", [3] = "MD", [4] = "MF",
[5] = "CNAME", [6] = "SOA", [7] = "MB", [8] = "MG", [5] = "CNAME", [6] = "SOA", [7] = "MB", [8] = "MG",
@ -64,8 +65,8 @@ export {
[32768] = "DNS_SEC_OK", # accepts DNS Sec RRs [32768] = "DNS_SEC_OK", # accepts DNS Sec RRs
} &default="?"; } &default="?";
## Possible values of the CLASS field in resource records or QCLASS field ## Possible values of the CLASS field in resource records or QCLASS
## in query messages. ## field in query messages.
const classes = { const classes = {
[1] = "C_INTERNET", [1] = "C_INTERNET",
[2] = "C_CSNET", [2] = "C_CSNET",

View file

@ -22,8 +22,8 @@ export {
id: conn_id &log; id: conn_id &log;
## The transport layer protocol of the connection. ## The transport layer protocol of the connection.
proto: transport_proto &log; proto: transport_proto &log;
## A 16 bit identifier assigned by the program that generated the ## A 16-bit identifier assigned by the program that generated
## DNS query. Also used in responses to match up replies to ## the DNS query. Also used in responses to match up replies to
## outstanding queries. ## outstanding queries.
trans_id: count &log &optional; trans_id: count &log &optional;
## The domain name that is the subject of the DNS query. ## The domain name that is the subject of the DNS query.
@ -40,17 +40,17 @@ export {
rcode: count &log &optional; rcode: count &log &optional;
## A descriptive name for the response code value. ## A descriptive name for the response code value.
rcode_name: string &log &optional; rcode_name: string &log &optional;
## The Authoritative Answer bit for response messages specifies that ## The Authoritative Answer bit for response messages specifies
## the responding name server is an authority for the domain name ## that the responding name server is an authority for the
## in the question section. ## domain name in the question section.
AA: bool &log &default=F; AA: bool &log &default=F;
## The Truncation bit specifies that the message was truncated. ## The Truncation bit specifies that the message was truncated.
TC: bool &log &default=F; TC: bool &log &default=F;
## The Recursion Desired bit in a request message indicates that ## The Recursion Desired bit in a request message indicates that
## the client wants recursive service for this query. ## the client wants recursive service for this query.
RD: bool &log &default=F; RD: bool &log &default=F;
## The Recursion Available bit in a response message indicates that ## The Recursion Available bit in a response message indicates
## the name server supports recursive queries. ## that the name server supports recursive queries.
RA: bool &log &default=F; RA: bool &log &default=F;
## A reserved field that is currently supposed to be zero in all ## A reserved field that is currently supposed to be zero in all
## queries and responses. ## queries and responses.
@ -58,19 +58,19 @@ export {
## The set of resource descriptions in the query answer. ## The set of resource descriptions in the query answer.
answers: vector of string &log &optional; answers: vector of string &log &optional;
## The caching intervals of the associated RRs described by the ## The caching intervals of the associated RRs described by the
## ``answers`` field. ## *answers* field.
TTLs: vector of interval &log &optional; TTLs: vector of interval &log &optional;
## The DNS query was rejected by the server. ## The DNS query was rejected by the server.
rejected: bool &log &default=F; rejected: bool &log &default=F;
## This value indicates if this request/response pair is ready to be ## This value indicates if this request/response pair is ready
## logged. ## to be logged.
ready: bool &default=F; ready: bool &default=F;
## The total number of resource records in a reply message's answer ## The total number of resource records in a reply message's
## section. ## answer section.
total_answers: count &optional; total_answers: count &optional;
## The total number of resource records in a reply message's answer, ## The total number of resource records in a reply message's
## authority, and additional sections. ## answer, authority, and additional sections.
total_replies: count &optional; total_replies: count &optional;
}; };
@ -78,9 +78,10 @@ export {
## record as it is sent to the logging framework. ## record as it is sent to the logging framework.
global log_dns: event(rec: Info); global log_dns: event(rec: Info);
## This is called by the specific dns_*_reply events with a "reply" which ## This is called by the specific dns_*_reply events with a "reply"
## may not represent the full data available from the resource record, but ## which may not represent the full data available from the resource
## it's generally considered a summarization of the response(s). ## record, but it's generally considered a summarization of the
## responses.
## ##
## c: The connection record for which to fill in DNS reply data. ## c: The connection record for which to fill in DNS reply data.
## ##
@ -95,7 +96,7 @@ export {
## This can be used if additional initialization logic needs to happen ## This can be used if additional initialization logic needs to happen
## when creating a new session value. ## when creating a new session value.
## ##
## c: The connection involved in the new session ## c: The connection involved in the new session.
## ##
## msg: The DNS message header information. ## msg: The DNS message header information.
## ##
@ -109,9 +110,9 @@ export {
## query/response which haven't completed yet. ## query/response which haven't completed yet.
pending: table[count] of Queue::Queue; pending: table[count] of Queue::Queue;
## This is the list of DNS responses that have completed based on the ## This is the list of DNS responses that have completed based
## number of responses declared and the number received. The contents ## on the number of responses declared and the number received.
## of the set are transaction IDs. ## The contents of the set are transaction IDs.
finished_answers: set[count]; finished_answers: set[count];
}; };
} }