os/ossrv/genericopenlibs/openenvcore/include/arpa/nameser.dosc
changeset 0 bde4ae8d615e
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/os/ossrv/genericopenlibs/openenvcore/include/arpa/nameser.dosc	Fri Jun 15 03:10:57 2012 +0200
     1.3 @@ -0,0 +1,270 @@
     1.4 +/** @file ../include/arpa/nameser.h
     1.5 +@internalComponent
     1.6 +*/
     1.7 +
     1.8 +/** @def  NS_PACKETSZ
     1.9 +
    1.10 +maximum packet size
    1.11 +
    1.12 +@publishedAll
    1.13 +@released
    1.14 +*/
    1.15 +
    1.16 +
    1.17 +/** @def  NS_MAXDNAME
    1.18 +
    1.19 +maximum domain name
    1.20 +
    1.21 +@publishedAll
    1.22 +@released
    1.23 +*/
    1.24 +
    1.25 +
    1.26 +/** @def  NS_MAXCDNAME
    1.27 +
    1.28 +maximum compressed domain name
    1.29 +
    1.30 +@publishedAll
    1.31 +@released
    1.32 +*/
    1.33 +
    1.34 +
    1.35 +/** @def  NS_MAXLABEL
    1.36 +
    1.37 +maximum length of domain label
    1.38 +
    1.39 +@publishedAll
    1.40 +@released
    1.41 +*/
    1.42 +
    1.43 +
    1.44 +/** @def  NS_HFIXEDSZ
    1.45 +
    1.46 +bytes of fixed data in header
    1.47 +
    1.48 +@publishedAll
    1.49 +@released
    1.50 +*/
    1.51 +
    1.52 +
    1.53 +/** @def  NS_QFIXEDSZ
    1.54 +
    1.55 +bytes of fixed data in query
    1.56 +
    1.57 +@publishedAll
    1.58 +@released
    1.59 +*/
    1.60 +
    1.61 +
    1.62 +/** @def  NS_RRFIXEDSZ
    1.63 +
    1.64 +bytes of fixed data in r record 
    1.65 +
    1.66 +@publishedAll
    1.67 +@released
    1.68 +*/
    1.69 +
    1.70 +
    1.71 +/** @def  NS_INT32SZ
    1.72 +
    1.73 +bytes of data in a u_int32_t
    1.74 +
    1.75 +@publishedAll
    1.76 +@released
    1.77 +*/
    1.78 +
    1.79 +/** @def  NS_INT16SZ
    1.80 +
    1.81 +bytes of data in a u_int16_t
    1.82 +
    1.83 +@publishedAll
    1.84 +@released
    1.85 +*/
    1.86 +
    1.87 +/** @def  NS_INT8SZ
    1.88 +
    1.89 +bytes of data in a u_int8_t 
    1.90 +
    1.91 +@publishedAll
    1.92 +@released
    1.93 +*/
    1.94 +
    1.95 +/** @def  NS_INADDRSZ
    1.96 +
    1.97 +IPv4 T_A
    1.98 +
    1.99 +@publishedAll
   1.100 +@released
   1.101 +*/
   1.102 +
   1.103 +/** @def  NS_IN6ADDRSZ
   1.104 +
   1.105 +IPv6 T_AAAA
   1.106 +
   1.107 +@publishedAll
   1.108 +@released
   1.109 +*/
   1.110 +
   1.111 +/** @def  NS_CMPRSFLGS
   1.112 +
   1.113 +Flag bits indicating name compression.
   1.114 +
   1.115 +@publishedAll
   1.116 +@released
   1.117 +*/
   1.118 +
   1.119 +/** @def  NS_DEFAULTPORT
   1.120 +
   1.121 +For both TCP and UDP.
   1.122 +
   1.123 +@publishedAll
   1.124 +@released
   1.125 +*/
   1.126 +  
   1.127 +/** @typedef typedef enum __ns_sect ns_sect
   1.128 +
   1.129 +These can be expanded with synonyms, just keep ns_parse.c:ns_parserecord() in synch with it.
   1.130 +
   1.131 +@publishedAll
   1.132 +@released
   1.133 +*/
   1.134 +
   1.135 +  
   1.136 +/** @typedef typedef struct __ns_msg ns_msg
   1.137 +
   1.138 +This is a message handle.  It is caller allocated and has no dynamic data.
   1.139 +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.
   1.140 +
   1.141 +@publishedAll
   1.142 +@released
   1.143 +*/
   1.144 +
   1.145 +/** @typedef typedef	struct __ns_rr ns_rr
   1.146 +
   1.147 +This is a parsed record.  It is caller allocated and has no dynamic data.
   1.148 +
   1.149 +@publishedAll
   1.150 +@released
   1.151 +*/
   1.152 +
   1.153 +
   1.154 +/** @typedef typedef enum __ns_flag  ns_flag
   1.155 +
   1.156 +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[].
   1.157 +
   1.158 +@publishedAll
   1.159 +@released
   1.160 +*/
   1.161 +
   1.162 +
   1.163 +/** @typedef typedef enum __ns_opcode ns_opcode
   1.164 +
   1.165 +Currently defined opcodes.
   1.166 +
   1.167 +@publishedAll
   1.168 +@released
   1.169 +*/
   1.170 +
   1.171 +/** @typedef typedef  enum __ns_rcode ns_rcode
   1.172 +
   1.173 +Currently defined response codes.
   1.174 +
   1.175 +@publishedAll
   1.176 +@released
   1.177 +*/
   1.178 +
   1.179 +/** @typedef typedef enum __ns_update_operation  ns_update_operation
   1.180 +
   1.181 +BIND_UPDATE
   1.182 +
   1.183 +@publishedAll
   1.184 +@released
   1.185 +*/
   1.186 +
   1.187 +
   1.188 +/** @struct ns_updrec 
   1.189 +
   1.190 +This RR-like structure is particular to UPDATE.
   1.191 +
   1.192 +@publishedAll
   1.193 +@released
   1.194 +*/
   1.195 +
   1.196 +/** @var ns_updrec::r_prev
   1.197 +prev record
   1.198 +*/
   1.199 +
   1.200 +/** @var ns_updrec::r_next
   1.201 +next record
   1.202 +*/
   1.203 +
   1.204 +/** @var ns_updrec::r_section
   1.205 +ZONE or PREREQUISITE or UPDATE
   1.206 +*/
   1.207 +
   1.208 +/** @var ns_updrec::r_dname
   1.209 +owner of the RR
   1.210 +*/
   1.211 +	
   1.212 +/** @var ns_updrec::r_class
   1.213 +class number
   1.214 +*/
   1.215 +
   1.216 +/** @var ns_updrec::r_type
   1.217 +type number
   1.218 +*/
   1.219 +
   1.220 +/** @var ns_updrec::r_ttl
   1.221 +time to live
   1.222 +*/
   1.223 +
   1.224 +/** @var ns_updrec::r_data
   1.225 +rdata fields as text string 
   1.226 +*/
   1.227 +
   1.228 +/** @var ns_updrec::r_size
   1.229 +size of r_data field
   1.230 +*/
   1.231 +
   1.232 +/** @var ns_updrec::r_opcode
   1.233 +type of operation
   1.234 +*/
   1.235 +
   1.236 +/** @var ns_updrec::r_grpnext
   1.237 +next record when grouped
   1.238 +*/
   1.239 +
   1.240 +/** @var ns_updrec::r_dp
   1.241 +databuf to process
   1.242 +*/
   1.243 +
   1.244 +/** @var ns_updrec::r_deldp
   1.245 +databuf's deleted or overwritten
   1.246 +*/
   1.247 +
   1.248 +/** @var ns_updrec::r_zone
   1.249 +zone number on server
   1.250 +*/
   1.251 +
   1.252 +/** @typedef typedef enum __ns_type ns_type
   1.253 +
   1.254 +Currently defined type values for resources and queries.
   1.255 +
   1.256 +@publishedAll
   1.257 +@released
   1.258 +*/
   1.259 +
   1.260 +/** @typedef typedef enum __ns_class ns_class
   1.261 +
   1.262 +Values for class field
   1.263 +
   1.264 +@publishedAll
   1.265 +@released
   1.266 +*/
   1.267 +
   1.268 +
   1.269 +
   1.270 +
   1.271 +
   1.272 +
   1.273 +