external/bsd/bind/dist/lib/lwres/man/lwres_context.3

   1 .\"     $NetBSD: lwres_context.3,v 1.5 2014/12/10 04:38:02 christos Exp $
   2 .\"
   3 .\" Copyright (C) 2004, 2005, 2007, 2014 Internet Systems Consortium, Inc. ("ISC")
   4 .\" Copyright (C) 2000, 2001, 2003 Internet Software Consortium.
   5 .\"
   6 .\" Permission to use, copy, modify, and/or distribute this software for any
   7 .\" purpose with or without fee is hereby granted, provided that the above
   8 .\" copyright notice and this permission notice appear in all copies.
   9 .\"
  10 .\" THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
  11 .\" REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
  12 .\" AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
  13 .\" INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
  14 .\" LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
  15 .\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
  16 .\" PERFORMANCE OF THIS SOFTWARE.
  17 .\"
  18 .\" Id
  19 .\"
  20 .hy 0
  21 .ad l
  22 .\"     Title: lwres_context
  23 .\"    Author:
  24 .\" Generator: DocBook XSL Stylesheets v1.71.1 <http://docbook.sf.net/>
  25 .\"      Date: June 18, 2007
  26 .\"    Manual: BIND9
  27 .\"    Source: BIND9
  28 .\"
  29 .TH "LWRES_CONTEXT" "3" "June 18, 2007" "BIND9" "BIND9"
  30 .\" disable hyphenation
  31 .nh
  32 .\" disable justification (adjust text to left margin only)
  33 .ad l
  34 .SH "NAME"
  35 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
  36 .SH "SYNOPSIS"
  37 .nf
  38 #include <lwres/lwres.h>
  39 .fi
  40 .HP 36
  41 .BI "lwres_result_t lwres_context_create(lwres_context_t\ **" "contextp" ", void\ *" "arg" ", lwres_malloc_t\ " "malloc_function" ", lwres_free_t\ " "free_function" ");"
  42 .HP 37
  43 .BI "lwres_result_t lwres_context_destroy(lwres_context_t\ **" "contextp" ");"
  44 .HP 30
  45 .BI "void lwres_context_initserial(lwres_context_t\ *" "ctx" ", lwres_uint32_t\ " "serial" ");"
  46 .HP 40
  47 .BI "lwres_uint32_t lwres_context_nextserial(lwres_context_t\ *" "ctx" ");"
  48 .HP 27
  49 .BI "void lwres_context_freemem(lwres_context_t\ *" "ctx" ", void\ *" "mem" ", size_t\ " "len" ");"
  50 .HP 28
  51 .BI "void lwres_context_allocmem(lwres_context_t\ *" "ctx" ", size_t\ " "len" ");"
  52 .HP 30
  53 .BI "void * lwres_context_sendrecv(lwres_context_t\ *" "ctx" ", void\ *" "sendbase" ", int\ " "sendlen" ", void\ *" "recvbase" ", int\ " "recvlen" ", int\ *" "recvd_len" ");"
  54 .SH "DESCRIPTION"
  55 .PP
  56 \fBlwres_context_create()\fR
  57 creates a
  58 \fBlwres_context_t\fR
  59 structure for use in lightweight resolver operations. It holds a socket and other data needed for communicating with a resolver daemon. The new
  60 \fBlwres_context_t\fR
  61 is returned through
  62 \fIcontextp\fR, a pointer to a
  63 \fBlwres_context_t\fR
  64 pointer. This
  65 \fBlwres_context_t\fR
  66 pointer must initially be NULL, and is modified to point to the newly created
  67 \fBlwres_context_t\fR.
  68 .PP
  69 When the lightweight resolver needs to perform dynamic memory allocation, it will call
  70 \fImalloc_function\fR
  71 to allocate memory and
  72 \fIfree_function\fR
  73 to free it. If
  74 \fImalloc_function\fR
  75 and
  76 \fIfree_function\fR
  77 are NULL, memory is allocated using
  78 \fBmalloc\fR(3). and
  79 \fBfree\fR(3). It is not permitted to have a NULL
  80 \fImalloc_function\fR
  81 and a non\-NULL
  82 \fIfree_function\fR
  83 or vice versa.
  84 \fIarg\fR
  85 is passed as the first parameter to the memory allocation functions. If
  86 \fImalloc_function\fR
  87 and
  88 \fIfree_function\fR
  89 are NULL,
  90 \fIarg\fR
  91 is unused and should be passed as NULL.
  92 .PP
  93 Once memory for the structure has been allocated, it is initialized using
  94 \fBlwres_conf_init\fR(3)
  95 and returned via
  96 \fI*contextp\fR.
  97 .PP
  98 \fBlwres_context_destroy()\fR
  99 destroys a
 100 \fBlwres_context_t\fR, closing its socket.
 101 \fIcontextp\fR
 102 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.
 103 .PP
 104 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
 105 \fBlwres_context_initserial()\fR
 106 and
 107 \fBlwres_context_nextserial()\fR.
 108 \fBlwres_context_initserial()\fR
 109 sets the serial number for context
 110 \fI*ctx\fR
 111 to
 112 \fIserial\fR.
 113 \fBlwres_context_nextserial()\fR
 114 increments the serial number and returns the previous value.
 115 .PP
 116 Memory for a lightweight resolver context is allocated and freed using
 117 \fBlwres_context_allocmem()\fR
 118 and
 119 \fBlwres_context_freemem()\fR. These use whatever allocations were defined when the context was created with
 120 \fBlwres_context_create()\fR.
 121 \fBlwres_context_allocmem()\fR
 122 allocates
 123 \fIlen\fR
 124 bytes of memory and if successful returns a pointer to the allocated storage.
 125 \fBlwres_context_freemem()\fR
 126 frees
 127 \fIlen\fR
 128 bytes of space starting at location
 129 \fImem\fR.
 130 .PP
 131 \fBlwres_context_sendrecv()\fR
 132 performs I/O for the context
 133 \fIctx\fR. Data are read and written from the context's socket. It writes data from
 134 \fIsendbase\fR
 135 \(em typically a lightweight resolver query packet \(em and waits for a reply which is copied to the receive buffer at
 136 \fIrecvbase\fR. The number of bytes that were written to this receive buffer is returned in
 137 \fI*recvd_len\fR.
 138 .SH "RETURN VALUES"
 139 .PP
 140 \fBlwres_context_create()\fR
 141 returns
 142 \fBLWRES_R_NOMEMORY\fR
 143 if memory for the
 144 \fBstruct lwres_context\fR
 145 could not be allocated,
 146 \fBLWRES_R_SUCCESS\fR
 147 otherwise.
 148 .PP
 149 Successful calls to the memory allocator
 150 \fBlwres_context_allocmem()\fR
 151 return a pointer to the start of the allocated space. It returns NULL if memory could not be allocated.
 152 .PP
 153 \fBLWRES_R_SUCCESS\fR
 154 is returned when
 155 \fBlwres_context_sendrecv()\fR
 156 completes successfully.
 157 \fBLWRES_R_IOERROR\fR
 158 is returned if an I/O error occurs and
 159 \fBLWRES_R_TIMEOUT\fR
 160 is returned if
 161 \fBlwres_context_sendrecv()\fR
 162 times out waiting for a response.
 163 .SH "SEE ALSO"
 164 .PP
 165 \fBlwres_conf_init\fR(3),
 166 \fBmalloc\fR(3),
 167 \fBfree\fR(3).
 168 .SH "COPYRIGHT"
 169 Copyright \(co 2004, 2005, 2007, 2014 Internet Systems Consortium, Inc. ("ISC")
 170 .br
 171 Copyright \(co 2000, 2001, 2003 Internet Software Consortium.
 172 .br