1 .\" Copyright (C) 2004, 2005 Internet Systems Consortium, Inc. ("ISC")
2 .\" Copyright (C) 2000, 2001 Internet Software Consortium.
4 .\" Permission to use, copy, modify, and 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_gnba.3,v 1.13.2.1.8.6 2006/06/29 13:02:31 marka Exp $
22 .\" Generator: DocBook XSL Stylesheets v1.70.1 <http://docbook.sf.net/>
23 .\" Date: Jun 30, 2000
27 .TH "LWRES_GNBA" "3" "Jun 30, 2000" "BIND9" "BIND9"
28 .\" disable hyphenation
30 .\" disable justification (adjust text to left margin only)
33 lwres_gnbarequest_render, lwres_gnbaresponse_render, lwres_gnbarequest_parse, lwres_gnbaresponse_parse, lwres_gnbaresponse_free, lwres_gnbarequest_free \- lightweight resolver getnamebyaddress message handling
36 #include <lwres/lwres.h>
39 .BI "lwres_result_t lwres_gnbarequest_render(lwres_context_t\ *" "ctx" ", lwres_gnbarequest_t\ *" "req" ", lwres_lwpacket_t\ *" "pkt" ", lwres_buffer_t\ *" "b" ");"
41 .BI "lwres_result_t lwres_gnbaresponse_render(lwres_context_t\ *ctx, lwres_gnbaresponse_t\ *req, lwres_lwpacket_t\ *pkt, lwres_buffer_t\ *b);"
43 .BI "lwres_result_t lwres_gnbarequest_parse(lwres_context_t\ *ctx, lwres_buffer_t\ *b, lwres_lwpacket_t\ *pkt, lwres_gnbarequest_t\ **structp);"
45 .BI "lwres_result_t lwres_gnbaresponse_parse(lwres_context_t\ *ctx, lwres_buffer_t\ *b, lwres_lwpacket_t\ *pkt, lwres_gnbaresponse_t\ **structp);"
47 .BI "void lwres_gnbaresponse_free(lwres_context_t\ *ctx, lwres_gnbaresponse_t\ **structp);"
49 .BI "void lwres_gnbarequest_free(lwres_context_t\ *ctx, lwres_gnbarequest_t\ **structp);"
52 These are low\-level routines for creating and parsing lightweight resolver address\-to\-name lookup request and response messages.
54 There are four main functions for the getnamebyaddr opcode. One render function converts a getnamebyaddr request structure \(em
55 \fBlwres_gnbarequest_t\fR
56 \(em to the lightweight resolver's canonical format. It is complemented by a parse function that converts a packet in this canonical format to a getnamebyaddr request structure. Another render function converts the getnamebyaddr response structure \(em
57 \fBlwres_gnbaresponse_t\fR
58 to the canonical format. This is complemented by a parse function which converts a packet in canonical format to a getnamebyaddr response structure.
60 These structures are defined in
61 \fIlwres/lwres.h\fR. They are shown below.
65 #define LWRES_OPCODE_GETNAMEBYADDR 0x00010002U
69 } lwres_gnbarequest_t;
72 lwres_uint16_t naliases;
75 lwres_uint16_t realnamelen;
76 lwres_uint16_t *aliaslen;
79 } lwres_gnbaresponse_t;
84 \fBlwres_gnbarequest_render()\fR
87 to convert getnamebyaddr request structure
89 to canonical format. The packet header structure
91 is initialised and transferred to buffer
92 \fIb\fR. The contents of
94 are then appended to the buffer in canonical format.
95 \fBlwres_gnbaresponse_render()\fR
96 performs the same task, except it converts a getnamebyaddr response structure
97 \fBlwres_gnbaresponse_t\fR
98 to the lightweight resolver's canonical format.
100 \fBlwres_gnbarequest_parse()\fR
103 to convert the contents of packet
106 \fBlwres_gnbarequest_t\fR
109 provides space to be used for storing this structure. When the function succeeds, the resulting
110 \fBlwres_gnbarequest_t\fR
111 is made available through
113 \fBlwres_gnbaresponse_parse()\fR
114 offers the same semantics as
115 \fBlwres_gnbarequest_parse()\fR
117 \fBlwres_gnbaresponse_t\fR
120 \fBlwres_gnbaresponse_free()\fR
122 \fBlwres_gnbarequest_free()\fR
123 release the memory in resolver context
125 that was allocated to the
126 \fBlwres_gnbaresponse_t\fR
128 \fBlwres_gnbarequest_t\fR
129 structures referenced via
130 \fIstructp\fR. Any memory associated with ancillary buffers and strings for those structures is also discarded.
133 The getnamebyaddr opcode functions
134 \fBlwres_gnbarequest_render()\fR,
135 \fBlwres_gnbaresponse_render()\fR
136 \fBlwres_gnbarequest_parse()\fR
138 \fBlwres_gnbaresponse_parse()\fR
140 \fBLWRES_R_SUCCESS\fR
141 on success. They return
142 \fBLWRES_R_NOMEMORY\fR
143 if memory allocation fails.
144 \fBLWRES_R_UNEXPECTEDEND\fR
145 is returned if the available space in the buffer
147 is too small to accommodate the packet header or the
148 \fBlwres_gnbarequest_t\fR
150 \fBlwres_gnbaresponse_t\fR
152 \fBlwres_gnbarequest_parse()\fR
154 \fBlwres_gnbaresponse_parse()\fR
156 \fBLWRES_R_UNEXPECTEDEND\fR
157 if the buffer is not empty after decoding the received packet. These functions will return
158 \fBLWRES_R_FAILURE\fR
161 in the packet header structure
162 \fBlwres_lwpacket_t\fR
163 indicate that the packet is not a response to an earlier query.
166 \fBlwres_packet\fR(3).
168 Copyright \(co 2004, 2005 Internet Systems Consortium, Inc. ("ISC")