1 .\" Copyright (C) 2004, 2005, 2007 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.
16 .\" $Id: lwres_gabn.3,v 1.27.214.1 2009/07/11 01:43:32 tbox Exp $
22 .\" Generator: DocBook XSL Stylesheets v1.71.1 <http://docbook.sf.net/>
23 .\" Date: Jun 30, 2000
27 .TH "LWRES_GABN" "3" "Jun 30, 2000" "BIND9" "BIND9"
28 .\" disable hyphenation
30 .\" disable justification (adjust text to left margin only)
33 lwres_gabnrequest_render, lwres_gabnresponse_render, lwres_gabnrequest_parse, lwres_gabnresponse_parse, lwres_gabnresponse_free, lwres_gabnrequest_free \- lightweight resolver getaddrbyname message handling
36 #include <lwres/lwres.h>
39 .BI "lwres_result_t lwres_gabnrequest_render(lwres_context_t\ *" "ctx" ", lwres_gabnrequest_t\ *" "req" ", lwres_lwpacket_t\ *" "pkt" ", lwres_buffer_t\ *" "b" ");"
41 .BI "lwres_result_t lwres_gabnresponse_render(lwres_context_t\ *" "ctx" ", lwres_gabnresponse_t\ *" "req" ", lwres_lwpacket_t\ *" "pkt" ", lwres_buffer_t\ *" "b" ");"
43 .BI "lwres_result_t lwres_gabnrequest_parse(lwres_context_t\ *" "ctx" ", lwres_buffer_t\ *" "b" ", lwres_lwpacket_t\ *" "pkt" ", lwres_gabnrequest_t\ **" "structp" ");"
45 .BI "lwres_result_t lwres_gabnresponse_parse(lwres_context_t\ *" "ctx" ", lwres_buffer_t\ *" "b" ", lwres_lwpacket_t\ *" "pkt" ", lwres_gabnresponse_t\ **" "structp" ");"
47 .BI "void lwres_gabnresponse_free(lwres_context_t\ *" "ctx" ", lwres_gabnresponse_t\ **" "structp" ");"
49 .BI "void lwres_gabnrequest_free(lwres_context_t\ *" "ctx" ", lwres_gabnrequest_t\ **" "structp" ");"
52 These are low\-level routines for creating and parsing lightweight resolver name\-to\-address lookup request and response messages.
54 There are four main functions for the getaddrbyname opcode. One render function converts a getaddrbyname request structure \(em
55 \fBlwres_gabnrequest_t\fR
56 \(em to the lighweight resolver's canonical format. It is complemented by a parse function that converts a packet in this canonical format to a getaddrbyname request structure. Another render function converts the getaddrbyname response structure \(em
57 \fBlwres_gabnresponse_t\fR
58 \(em to the canonical format. This is complemented by a parse function which converts a packet in canonical format to a getaddrbyname response structure.
60 These structures are defined in
61 \fI<lwres/lwres.h>\fR. They are shown below.
65 #define LWRES_OPCODE_GETADDRSBYNAME 0x00010001U
72 typedef struct lwres_addr lwres_addr_t;
73 typedef LWRES_LIST(lwres_addr_t) lwres_addrlist_t;
82 lwres_uint32_t addrtypes;
83 lwres_uint16_t namelen;
85 } lwres_gabnrequest_t;
94 lwres_uint16_t naliases;
95 lwres_uint16_t naddrs;
98 lwres_uint16_t realnamelen;
99 lwres_uint16_t *aliaslen;
100 lwres_addrlist_t addrs;
103 } lwres_gabnresponse_t;
108 \fBlwres_gabnrequest_render()\fR
109 uses resolver context
111 to convert getaddrbyname request structure
113 to canonical format. The packet header structure
115 is initialised and transferred to buffer
116 \fIb\fR. The contents of
118 are then appended to the buffer in canonical format.
119 \fBlwres_gabnresponse_render()\fR
120 performs the same task, except it converts a getaddrbyname response structure
121 \fBlwres_gabnresponse_t\fR
122 to the lightweight resolver's canonical format.
124 \fBlwres_gabnrequest_parse()\fR
127 to convert the contents of packet
130 \fBlwres_gabnrequest_t\fR
133 provides space to be used for storing this structure. When the function succeeds, the resulting
134 \fBlwres_gabnrequest_t\fR
135 is made available through
137 \fBlwres_gabnresponse_parse()\fR
138 offers the same semantics as
139 \fBlwres_gabnrequest_parse()\fR
141 \fBlwres_gabnresponse_t\fR
144 \fBlwres_gabnresponse_free()\fR
146 \fBlwres_gabnrequest_free()\fR
147 release the memory in resolver context
149 that was allocated to the
150 \fBlwres_gabnresponse_t\fR
152 \fBlwres_gabnrequest_t\fR
153 structures referenced via
154 \fIstructp\fR. Any memory associated with ancillary buffers and strings for those structures is also discarded.
157 The getaddrbyname opcode functions
158 \fBlwres_gabnrequest_render()\fR,
159 \fBlwres_gabnresponse_render()\fR
160 \fBlwres_gabnrequest_parse()\fR
162 \fBlwres_gabnresponse_parse()\fR
164 \fBLWRES_R_SUCCESS\fR
165 on success. They return
166 \fBLWRES_R_NOMEMORY\fR
167 if memory allocation fails.
168 \fBLWRES_R_UNEXPECTEDEND\fR
169 is returned if the available space in the buffer
171 is too small to accommodate the packet header or the
172 \fBlwres_gabnrequest_t\fR
174 \fBlwres_gabnresponse_t\fR
176 \fBlwres_gabnrequest_parse()\fR
178 \fBlwres_gabnresponse_parse()\fR
180 \fBLWRES_R_UNEXPECTEDEND\fR
181 if the buffer is not empty after decoding the received packet. These functions will return
182 \fBLWRES_R_FAILURE\fR
185 in the packet header structure
186 \fBlwres_lwpacket_t\fR
187 indicate that the packet is not a response to an earlier query.
190 \fBlwres_packet\fR(3)
192 Copyright \(co 2004, 2005, 2007 Internet Systems Consortium, Inc. ("ISC")
194 Copyright \(co 2000, 2001 Internet Software Consortium.