os/ossrv/genericopenlibs/openenvcore/include/arpa/nameser.dosc
author sl
Tue, 10 Jun 2014 14:32:02 +0200
changeset 1 260cb5ec6c19
permissions -rw-r--r--
Update contrib.
     1 /** @file ../include/arpa/nameser.h
     2 @internalComponent
     3 */
     4 
     5 /** @def  NS_PACKETSZ
     6 
     7 maximum packet size
     8 
     9 @publishedAll
    10 @released
    11 */
    12 
    13 
    14 /** @def  NS_MAXDNAME
    15 
    16 maximum domain name
    17 
    18 @publishedAll
    19 @released
    20 */
    21 
    22 
    23 /** @def  NS_MAXCDNAME
    24 
    25 maximum compressed domain name
    26 
    27 @publishedAll
    28 @released
    29 */
    30 
    31 
    32 /** @def  NS_MAXLABEL
    33 
    34 maximum length of domain label
    35 
    36 @publishedAll
    37 @released
    38 */
    39 
    40 
    41 /** @def  NS_HFIXEDSZ
    42 
    43 bytes of fixed data in header
    44 
    45 @publishedAll
    46 @released
    47 */
    48 
    49 
    50 /** @def  NS_QFIXEDSZ
    51 
    52 bytes of fixed data in query
    53 
    54 @publishedAll
    55 @released
    56 */
    57 
    58 
    59 /** @def  NS_RRFIXEDSZ
    60 
    61 bytes of fixed data in r record 
    62 
    63 @publishedAll
    64 @released
    65 */
    66 
    67 
    68 /** @def  NS_INT32SZ
    69 
    70 bytes of data in a u_int32_t
    71 
    72 @publishedAll
    73 @released
    74 */
    75 
    76 /** @def  NS_INT16SZ
    77 
    78 bytes of data in a u_int16_t
    79 
    80 @publishedAll
    81 @released
    82 */
    83 
    84 /** @def  NS_INT8SZ
    85 
    86 bytes of data in a u_int8_t 
    87 
    88 @publishedAll
    89 @released
    90 */
    91 
    92 /** @def  NS_INADDRSZ
    93 
    94 IPv4 T_A
    95 
    96 @publishedAll
    97 @released
    98 */
    99 
   100 /** @def  NS_IN6ADDRSZ
   101 
   102 IPv6 T_AAAA
   103 
   104 @publishedAll
   105 @released
   106 */
   107 
   108 /** @def  NS_CMPRSFLGS
   109 
   110 Flag bits indicating name compression.
   111 
   112 @publishedAll
   113 @released
   114 */
   115 
   116 /** @def  NS_DEFAULTPORT
   117 
   118 For both TCP and UDP.
   119 
   120 @publishedAll
   121 @released
   122 */
   123   
   124 /** @typedef typedef enum __ns_sect ns_sect
   125 
   126 These can be expanded with synonyms, just keep ns_parse.c:ns_parserecord() in synch with it.
   127 
   128 @publishedAll
   129 @released
   130 */
   131 
   132   
   133 /** @typedef typedef struct __ns_msg ns_msg
   134 
   135 This is a message handle.  It is caller allocated and has no dynamic data.
   136 This structure is intended to be opaque to all but ns_parse.c, thus the leading _'s on the member names.  Use the accessor functions, not the _'s.
   137 
   138 @publishedAll
   139 @released
   140 */
   141 
   142 /** @typedef typedef	struct __ns_rr ns_rr
   143 
   144 This is a parsed record.  It is caller allocated and has no dynamic data.
   145 
   146 @publishedAll
   147 @released
   148 */
   149 
   150 
   151 /** @typedef typedef enum __ns_flag  ns_flag
   152 
   153 These don't have to be in the same order as in the packet flags word, and they can even overlap in some cases, but they will need to be kept in synch with ns_parse.c:ns_flagdata[].
   154 
   155 @publishedAll
   156 @released
   157 */
   158 
   159 
   160 /** @typedef typedef enum __ns_opcode ns_opcode
   161 
   162 Currently defined opcodes.
   163 
   164 @publishedAll
   165 @released
   166 */
   167 
   168 /** @typedef typedef  enum __ns_rcode ns_rcode
   169 
   170 Currently defined response codes.
   171 
   172 @publishedAll
   173 @released
   174 */
   175 
   176 /** @typedef typedef enum __ns_update_operation  ns_update_operation
   177 
   178 BIND_UPDATE
   179 
   180 @publishedAll
   181 @released
   182 */
   183 
   184 
   185 /** @struct ns_updrec 
   186 
   187 This RR-like structure is particular to UPDATE.
   188 
   189 @publishedAll
   190 @released
   191 */
   192 
   193 /** @var ns_updrec::r_prev
   194 prev record
   195 */
   196 
   197 /** @var ns_updrec::r_next
   198 next record
   199 */
   200 
   201 /** @var ns_updrec::r_section
   202 ZONE or PREREQUISITE or UPDATE
   203 */
   204 
   205 /** @var ns_updrec::r_dname
   206 owner of the RR
   207 */
   208 	
   209 /** @var ns_updrec::r_class
   210 class number
   211 */
   212 
   213 /** @var ns_updrec::r_type
   214 type number
   215 */
   216 
   217 /** @var ns_updrec::r_ttl
   218 time to live
   219 */
   220 
   221 /** @var ns_updrec::r_data
   222 rdata fields as text string 
   223 */
   224 
   225 /** @var ns_updrec::r_size
   226 size of r_data field
   227 */
   228 
   229 /** @var ns_updrec::r_opcode
   230 type of operation
   231 */
   232 
   233 /** @var ns_updrec::r_grpnext
   234 next record when grouped
   235 */
   236 
   237 /** @var ns_updrec::r_dp
   238 databuf to process
   239 */
   240 
   241 /** @var ns_updrec::r_deldp
   242 databuf's deleted or overwritten
   243 */
   244 
   245 /** @var ns_updrec::r_zone
   246 zone number on server
   247 */
   248 
   249 /** @typedef typedef enum __ns_type ns_type
   250 
   251 Currently defined type values for resources and queries.
   252 
   253 @publishedAll
   254 @released
   255 */
   256 
   257 /** @typedef typedef enum __ns_class ns_class
   258 
   259 Values for class field
   260 
   261 @publishedAll
   262 @released
   263 */
   264 
   265 
   266 
   267 
   268 
   269 
   270