1 .\" Copyright (C) 2004, 2005, 2007, 2014, 2015 Internet Systems Consortium, Inc. ("ISC")
2 .\" Copyright (C) 2000, 2001 Internet Software Consortium.
4 .\" Permission to use, copy, modify, and/or distribute this software for any
5 .\" purpose with or without fee is hereby granted, provided that the above
6 .\" copyright notice and this permission notice appear in all copies.
8 .\" THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
9 .\" REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
10 .\" AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
11 .\" INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
12 .\" LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
13 .\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
14 .\" PERFORMANCE OF THIS SOFTWARE.
19 .\" Title: lwres_packet
21 .\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
27 .TH "LWRES_PACKET" "3" "2007\-06\-18" "ISC" "BIND9"
28 .\" -----------------------------------------------------------------
29 .\" * Define some portability stuff
30 .\" -----------------------------------------------------------------
31 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
32 .\" http://bugs.debian.org/507673
33 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
34 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
37 .\" -----------------------------------------------------------------
38 .\" * set default formatting
39 .\" -----------------------------------------------------------------
40 .\" disable hyphenation
42 .\" disable justification (adjust text to left margin only)
44 .\" -----------------------------------------------------------------
45 .\" * MAIN CONTENT STARTS HERE *
46 .\" -----------------------------------------------------------------
48 lwres_lwpacket_renderheader, lwres_lwpacket_parseheader \- lightweight resolver packet handling functions
53 #include <lwres/lwpacket\&.h>
56 .HP \w'lwres_result_t\ lwres_lwpacket_renderheader('u
57 .BI "lwres_result_t lwres_lwpacket_renderheader(lwres_buffer_t\ *" "b" ", lwres_lwpacket_t\ *" "pkt" ");"
58 .HP \w'lwres_result_t\ lwres_lwpacket_parseheader('u
59 .BI "lwres_result_t lwres_lwpacket_parseheader(lwres_buffer_t\ *" "b" ", lwres_lwpacket_t\ *" "pkt" ");"
62 These functions rely on a
63 \fBstruct lwres_lwpacket\fR
71 typedef struct lwres_lwpacket lwres_lwpacket_t;
81 struct lwres_lwpacket {
82 lwres_uint32_t length;
83 lwres_uint16_t version;
84 lwres_uint16_t pktflags;
85 lwres_uint32_t serial;
86 lwres_uint32_t opcode;
87 lwres_uint32_t result;
88 lwres_uint32_t recvlength;
89 lwres_uint16_t authtype;
90 lwres_uint16_t authlength;
97 The elements of this structure are:
101 the overall packet length, including the entire packet header\&. This field is filled in by the lwres_gabn_*() and lwres_gnba_*() calls\&.
106 the header format\&. There is currently only one format,
107 \fBLWRES_LWPACKETVERSION_0\fR\&. This field is filled in by the lwres_gabn_*() and lwres_gnba_*() calls\&.
112 library\-defined flags for this packet: for instance whether the packet is a request or a reply\&. Flag values can be set, but not defined by the caller\&. This field is filled in by the application wit the exception of the LWRES_LWPACKETFLAG_RESPONSE bit, which is set by the library in the lwres_gabn_*() and lwres_gnba_*() calls\&.
117 is set by the requestor and is returned in all replies\&. If two or more packets from the same source have the same serial number and are from the same source, they are assumed to be duplicates and the latter ones may be dropped\&. This field must be set by the application\&.
122 indicates the operation\&. Opcodes between 0x00000000 and 0x03ffffff are reserved for use by the lightweight resolver library\&. Opcodes between 0x04000000 and 0xffffffff are application defined\&. This field is filled in by the lwres_gabn_*() and lwres_gnba_*() calls\&.
127 is only valid for replies\&. Results between 0x04000000 and 0xffffffff are application defined\&. Results between 0x00000000 and 0x03ffffff are reserved for library use\&. This field is filled in by the lwres_gabn_*() and lwres_gnba_*() calls\&.
132 is the maximum buffer size that the receiver can handle on requests and the size of the buffer needed to satisfy a request when the buffer is too large for replies\&. This field is supplied by the application\&.
137 defines the packet level authentication that is used\&. Authorisation types between 0x1000 and 0xffff are application defined and types between 0x0000 and 0x0fff are reserved for library use\&. Currently these are not used and must be zero\&.
142 gives the length of the authentication data\&. Since packet authentication is currently not used, this must be zero\&.
145 The following opcodes are currently defined:
149 Success is always returned and the packet contents are echoed\&. The lwres_noop_*() functions should be used for this type\&.
154 returns all known addresses for a given name\&. The lwres_gabn_*() functions should be used for this type\&.
159 return the hostname for the given address\&. The lwres_gnba_*() functions should be used for this type\&.
162 \fBlwres_lwpacket_renderheader()\fR
163 transfers the contents of lightweight resolver packet structure
164 \fBlwres_lwpacket_t\fR\fI*pkt\fR
165 in network byte order to the lightweight resolver buffer,
168 \fBlwres_lwpacket_parseheader()\fR
169 performs the converse operation\&. It transfers data in network byte order from buffer
172 \fI*pkt\fR\&. The contents of the buffer
174 should correspond to a
175 \fBlwres_lwpacket_t\fR\&.
179 \fBlwres_lwpacket_renderheader()\fR
181 \fBlwres_lwpacket_parseheader()\fR
183 \fBLWRES_R_SUCCESS\fR\&. If there is insufficient space to copy data between the buffer
185 and lightweight resolver packet
187 both functions return
188 \fBLWRES_R_UNEXPECTEDEND\fR\&.
191 \fBInternet Systems Consortium, Inc\&.\fR
194 Copyright \(co 2004, 2005, 2007, 2014, 2015 Internet Systems Consortium, Inc. ("ISC")
196 Copyright \(co 2000, 2001 Internet Software Consortium.