contrib/bind-9.3/lib/lwres/man/lwres_context.3

   1 .\" Copyright (C) 2004, 2005 Internet Systems Consortium, Inc. ("ISC")
   2 .\" Copyright (C) 2000, 2001, 2003 Internet Software Consortium.
   3 .\"
   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.
   7 .\"
   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.
  15 .\"
  16 .\" $Id: lwres_context.3,v 1.13.2.2.2.7 2006/06/29 13:02:31 marka Exp $
  17 .\"
  18 .hy 0
  19 .ad l
  20 .\"     Title: lwres_context
  21 .\"    Author:
  22 .\" Generator: DocBook XSL Stylesheets v1.70.1 <http://docbook.sf.net/>
  23 .\"      Date: Jun 30, 2000
  24 .\"    Manual: BIND9
  25 .\"    Source: BIND9
  26 .\"
  27 .TH "LWRES_CONTEXT" "3" "Jun 30, 2000" "BIND9" "BIND9"
  28 .\" disable hyphenation
  29 .nh
  30 .\" disable justification (adjust text to left margin only)
  31 .ad l
  32 .SH "NAME"
  33 lwres_context_create, lwres_context_destroy, lwres_context_nextserial, lwres_context_initserial, lwres_context_freemem, lwres_context_allocmem, lwres_context_sendrecv \- lightweight resolver context management
  34 .SH "SYNOPSIS"
  35 .nf
  36 #include <lwres/lwres.h>
  37 .fi
  38 .HP 36
  39 .BI "lwres_result_t lwres_context_create(lwres_context_t\ **contextp, void\ *arg, lwres_malloc_t\ malloc_function, lwres_free_t\ free_function);"
  40 .HP 37
  41 .BI "lwres_result_t lwres_context_destroy(lwres_context_t\ **contextp);"
  42 .HP 30
  43 .BI "void lwres_context_initserial(lwres_context_t\ *ctx, lwres_uint32_t\ serial);"
  44 .HP 40
  45 .BI "lwres_uint32_t lwres_context_nextserial(lwres_context_t\ *ctx);"
  46 .HP 27
  47 .BI "void lwres_context_freemem(lwres_context_t\ *ctx, void\ *mem, size_t\ len);"
  48 .HP 28
  49 .BI "void lwres_context_allocmem(lwres_context_t\ *ctx, size_t\ len);"
  50 .HP 30
  51 .BI "void * lwres_context_sendrecv(lwres_context_t\ *ctx, void\ *sendbase, int\ sendlen, void\ *recvbase, int\ recvlen, int\ *recvd_len);"
  52 .SH "DESCRIPTION"
  53 .PP
  54 \fBlwres_context_create()\fR
  55 creates a
  56 \fBlwres_context_t\fR
  57 structure for use in lightweight resolver operations. It holds a socket and other data needed for communicating with a resolver daemon. The new
  58 \fBlwres_context_t\fR
  59 is returned through
  60 \fIcontextp\fR, a pointer to a
  61 \fBlwres_context_t\fR
  62 pointer. This
  63 \fBlwres_context_t\fR
  64 pointer must initially be NULL, and is modified to point to the newly created
  65 \fBlwres_context_t\fR.
  66 .PP
  67 When the lightweight resolver needs to perform dynamic memory allocation, it will call
  68 \fImalloc_function\fR
  69 to allocate memory and
  70 \fIfree_function\fR
  71 to free it. If
  72 \fImalloc_function\fR
  73 and
  74 \fIfree_function\fR
  75 are NULL, memory is allocated using .Xr malloc 3 and
  76 \fBfree\fR(3). It is not permitted to have a NULL
  77 \fImalloc_function\fR
  78 and a non\-NULL
  79 \fIfree_function\fR
  80 or vice versa.
  81 \fIarg\fR
  82 is passed as the first parameter to the memory allocation functions. If
  83 \fImalloc_function\fR
  84 and
  85 \fIfree_function\fR
  86 are NULL,
  87 \fIarg\fR
  88 is unused and should be passed as NULL.
  89 .PP
  90 Once memory for the structure has been allocated, it is initialized using
  91 \fBlwres_conf_init\fR(3)
  92 and returned via
  93 \fI*contextp\fR.
  94 .PP
  95 \fBlwres_context_destroy()\fR
  96 destroys a
  97 \fBlwres_context_t\fR, closing its socket.
  98 \fIcontextp\fR
  99 is a pointer to a pointer to the context that is to be destroyed. The pointer will be set to NULL when the context has been destroyed.
 100 .PP
 101 The context holds a serial number that is used to identify resolver request packets and associate responses with the corresponding requests. This serial number is controlled using
 102 \fBlwres_context_initserial()\fR
 103 and
 104 \fBlwres_context_nextserial()\fR.
 105 \fBlwres_context_initserial()\fR
 106 sets the serial number for context
 107 \fI*ctx\fR
 108 to
 109 \fIserial\fR.
 110 \fBlwres_context_nextserial()\fR
 111 increments the serial number and returns the previous value.
 112 .PP
 113 Memory for a lightweight resolver context is allocated and freed using
 114 \fBlwres_context_allocmem()\fR
 115 and
 116 \fBlwres_context_freemem()\fR. These use whatever allocations were defined when the context was created with
 117 \fBlwres_context_create()\fR.
 118 \fBlwres_context_allocmem()\fR
 119 allocates
 120 \fIlen\fR
 121 bytes of memory and if successful returns a pointer to the allocated storage.
 122 \fBlwres_context_freemem()\fR
 123 frees
 124 \fIlen\fR
 125 bytes of space starting at location
 126 \fImem\fR.
 127 .PP
 128 \fBlwres_context_sendrecv()\fR
 129 performs I/O for the context
 130 \fIctx\fR. Data are read and written from the context's socket. It writes data from
 131 \fIsendbase\fR
 132 \(em typically a lightweight resolver query packet \(em and waits for a reply which is copied to the receive buffer at
 133 \fIrecvbase\fR. The number of bytes that were written to this receive buffer is returned in
 134 \fI*recvd_len\fR.
 135 .SH "RETURN VALUES"
 136 .PP
 137 \fBlwres_context_create()\fR
 138 returns
 139 \fBLWRES_R_NOMEMORY\fR
 140 if memory for the
 141 \fBstruct lwres_context\fR
 142 could not be allocated,
 143 \fBLWRES_R_SUCCESS\fR
 144 otherwise.
 145 .PP
 146 Successful calls to the memory allocator
 147 \fBlwres_context_allocmem()\fR
 148 return a pointer to the start of the allocated space. It returns NULL if memory could not be allocated.
 149 .PP
 150 \fBLWRES_R_SUCCESS\fR
 151 is returned when
 152 \fBlwres_context_sendrecv()\fR
 153 completes successfully.
 154 \fBLWRES_R_IOERROR\fR
 155 is returned if an I/O error occurs and
 156 \fBLWRES_R_TIMEOUT\fR
 157 is returned if
 158 \fBlwres_context_sendrecv()\fR
 159 times out waiting for a response.
 160 .SH "SEE ALSO"
 161 .PP
 162 \fBlwres_conf_init\fR(3),
 163 \fBmalloc\fR(3),
 164 \fBfree\fR(3 ).
 165 .SH "COPYRIGHT"
 166 Copyright \(co 2004, 2005 Internet Systems Consortium, Inc. ("ISC")