diff options
Diffstat (limited to 'contrib/bind9/lib/lwres/man')
51 files changed, 4970 insertions, 7633 deletions
diff --git a/contrib/bind9/lib/lwres/man/lwres.3 b/contrib/bind9/lib/lwres/man/lwres.3 index ad125d2..3411eac 100644 --- a/contrib/bind9/lib/lwres/man/lwres.3 +++ b/contrib/bind9/lib/lwres/man/lwres.3 @@ -1,144 +1,142 @@ -.\" Copyright (C) 2004 Internet Systems Consortium, Inc. ("ISC") -.\" Copyright (C) 2000, 2001 Internet Software Consortium. -.\" +.\" Copyright (C) 2004, 2005 Internet Systems Consortium, Inc. ("ISC") +.\" Copyright (C) 2000, 2001 Internet Software Consortium. +.\" .\" Permission to use, copy, modify, and distribute this software for any .\" purpose with or without fee is hereby granted, provided that the above .\" copyright notice and this permission notice appear in all copies. -.\" +.\" .\" THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH .\" REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY -.\" AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT, +.\" AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT, .\" INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM .\" LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE .\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR .\" PERFORMANCE OF THIS SOFTWARE. .\" -.\" $Id: lwres.3,v 1.15.206.1 2004/03/06 07:41:42 marka Exp $ +.\" $Id: lwres.3,v 1.15.206.5 2005/10/13 02:33:58 marka Exp $ .\" -.TH "LWRES" "3" "Jun 30, 2000" "BIND9" "" -.SH NAME +.hy 0 +.ad l +.\" ** You probably do not want to edit this file directly ** +.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1). +.\" Instead of manually editing it, you probably should edit the DocBook XML +.\" source for it and then use the DocBook XSL Stylesheets to regenerate it. +.TH "LWRES" "3" "Jun 30, 2000" "BIND9" "BIND9" +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.SH "NAME" lwres \- introduction to the lightweight resolver library -.SH SYNOPSIS -\fB#include <lwres/lwres.h>\fR +.SH "SYNOPSIS" +.nf +#include <lwres/lwres.h> +.fi .SH "DESCRIPTION" .PP -The BIND 9 lightweight resolver library is a simple, name service -independent stub resolver library. It provides hostname-to-address -and address-to-hostname lookup services to applications by -transmitting lookup requests to a resolver daemon +The BIND 9 lightweight resolver library is a simple, name service independent stub resolver library. It provides hostname\-to\-address and address\-to\-hostname lookup services to applications by transmitting lookup requests to a resolver daemon \fBlwresd\fR -running on the local host. The resover daemon performs the -lookup using the DNS or possibly other name service protocols, -and returns the results to the application through the library. -The library and resolver daemon communicate using a simple -UDP-based protocol. +running on the local host. The resover daemon performs the lookup using the DNS or possibly other name service protocols, and returns the results to the application through the library. The library and resolver daemon communicate using a simple UDP\-based protocol. .SH "OVERVIEW" .PP -The lwresd library implements multiple name service APIs. -The standard +The lwresd library implements multiple name service APIs. The standard \fBgethostbyname()\fR, \fBgethostbyaddr()\fR, \fBgethostbyname_r()\fR, \fBgethostbyaddr_r()\fR, \fBgetaddrinfo()\fR, -\fBgetipnodebyname()\fR, -and +\fBgetipnodebyname()\fR, and \fBgetipnodebyaddr()\fR -functions are all supported. To allow the lwres library to coexist -with system libraries that define functions of the same name, -the library defines these functions with names prefixed by -lwres_. -To define the standard names, applications must include the -header file +functions are all supported. To allow the lwres library to coexist with system libraries that define functions of the same name, the library defines these functions with names prefixed by +lwres_. To define the standard names, applications must include the header file \fI<lwres/netdb.h>\fR -which contains macro definitions mapping the standard function names -into +which contains macro definitions mapping the standard function names into lwres_ -prefixed ones. Operating system vendors who integrate the lwres -library into their base distributions should rename the functions -in the library proper so that the renaming macros are not needed. +prefixed ones. Operating system vendors who integrate the lwres library into their base distributions should rename the functions in the library proper so that the renaming macros are not needed. .PP The library also provides a native API consisting of the functions \fBlwres_getaddrsbyname()\fR and -\fBlwres_getnamebyaddr()\fR. -These may be called by applications that require more detailed -control over the lookup process than the standard functions -provide. -.PP -In addition to these name service independent address lookup -functions, the library implements a new, experimental API -for looking up arbitrary DNS resource records, using the +\fBlwres_getnamebyaddr()\fR. These may be called by applications that require more detailed control over the lookup process than the standard functions provide. +.PP +In addition to these name service independent address lookup functions, the library implements a new, experimental API for looking up arbitrary DNS resource records, using the \fBlwres_getaddrsbyname()\fR function. .PP -Finally, there is a low-level API for converting lookup -requests and responses to and from raw lwres protocol packets. -This API can be used by clients requiring nonblocking operation, -and is also used when implementing the server side of the lwres -protocol, for example in the +Finally, there is a low\-level API for converting lookup requests and responses to and from raw lwres protocol packets. This API can be used by clients requiring nonblocking operation, and is also used when implementing the server side of the lwres protocol, for example in the \fBlwresd\fR -resolver daemon. The use of this low-level API in clients -and servers is outlined in the following sections. -.SH "CLIENT-SIDE LOW-LEVEL API CALL FLOW" +resolver daemon. The use of this low\-level API in clients and servers is outlined in the following sections. +.SH "CLIENT\-SIDE LOW\-LEVEL API CALL FLOW" .PP -When a client program wishes to make an lwres request using the -native low-level API, it typically performs the following -sequence of actions. +When a client program wishes to make an lwres request using the native low\-level API, it typically performs the following sequence of actions. .PP -(1) Allocate or use an existing \fBlwres_packet_t\fR, -called pkt below. +(1) Allocate or use an existing +\fBlwres_packet_t\fR, called +\fIpkt\fR +below. .PP -(2) Set \fBpkt.recvlength\fR to the maximum length we will accept. -This is done so the receiver of our packets knows how large our receive -buffer is. The "default" is a constant in -\fIlwres.h\fR: LWRES_RECVLENGTH = 4096. +(2) Set +pkt.recvlength +to the maximum length we will accept. This is done so the receiver of our packets knows how large our receive buffer is. The "default" is a constant in +\fIlwres.h\fR: +\fBLWRES_RECVLENGTH = 4096\fR. .PP -(3) Set \fBpkt.serial\fR -to a unique serial number. This value is echoed -back to the application by the remote server. +(3) Set +pkt.serial +to a unique serial number. This value is echoed back to the application by the remote server. .PP -(4) Set \fBpkt.pktflags\fR. Usually this is set to 0. +(4) Set +pkt.pktflags. Usually this is set to 0. .PP -(5) Set \fBpkt.result\fR to 0. +(5) Set +pkt.result +to 0. .PP -(6) Call \fBlwres_*request_render()\fR, -or marshall in the data using the primitives -such as \fBlwres_packet_render()\fR +(6) Call +\fBlwres_*request_render()\fR, or marshall in the data using the primitives such as +\fBlwres_packet_render()\fR and storing the packet data. .PP (7) Transmit the resulting buffer. .PP -(8) Call \fBlwres_*response_parse()\fR +(8) Call +\fBlwres_*response_parse()\fR to parse any packets received. .PP -(9) Verify that the opcode and serial match a request, and process the -packet specific information contained in the body. -.SH "SERVER-SIDE LOW-LEVEL API CALL FLOW" +(9) Verify that the opcode and serial match a request, and process the packet specific information contained in the body. +.SH "SERVER\-SIDE LOW\-LEVEL API CALL FLOW" .PP -When implementing the server side of the lightweight resolver -protocol using the lwres library, a sequence of actions like the -following is typically involved in processing each request packet. +When implementing the server side of the lightweight resolver protocol using the lwres library, a sequence of actions like the following is typically involved in processing each request packet. .PP -Note that the same \fBlwres_packet_t\fR is used -in both the \fB_parse()\fR and \fB_render()\fR calls, -with only a few modifications made -to the packet header's contents between uses. This method is recommended -as it keeps the serial, opcode, and other fields correct. +Note that the same +\fBlwres_packet_t\fR +is used in both the +\fB_parse()\fR +and +\fB_render()\fR +calls, with only a few modifications made to the packet header's contents between uses. This method is recommended as it keeps the serial, opcode, and other fields correct. .PP -(1) When a packet is received, call \fBlwres_*request_parse()\fR to -unmarshall it. This returns a \fBlwres_packet_t\fR (also called pkt, below) -as well as a data specific type, such as \fBlwres_gabnrequest_t\fR. +(1) When a packet is received, call +\fBlwres_*request_parse()\fR +to unmarshall it. This returns a +\fBlwres_packet_t\fR +(also called +\fIpkt\fR, below) as well as a data specific type, such as +\fBlwres_gabnrequest_t\fR. .PP (2) Process the request in the data specific type. .PP -(3) Set the \fBpkt.result\fR, -\fBpkt.recvlength\fR as above. All other fields can -be left untouched since they were filled in by the \fB*_parse()\fR call -above. If using \fBlwres_*response_render()\fR, -\fBpkt.pktflags\fR will be set up -properly. Otherwise, the LWRES_LWPACKETFLAG_RESPONSE bit should be -set. +(3) Set the +pkt.result, +pkt.recvlength +as above. All other fields can be left untouched since they were filled in by the +\fB*_parse()\fR +call above. If using +\fBlwres_*response_render()\fR, +pkt.pktflags +will be set up properly. Otherwise, the +\fBLWRES_LWPACKETFLAG_RESPONSE\fR +bit should be set. .PP (4) Call the data specific rendering function, such as \fBlwres_gabnresponse_render()\fR. diff --git a/contrib/bind9/lib/lwres/man/lwres.docbook b/contrib/bind9/lib/lwres/man/lwres.docbook index 511d82e..83258a9 100644 --- a/contrib/bind9/lib/lwres/man/lwres.docbook +++ b/contrib/bind9/lib/lwres/man/lwres.docbook @@ -1,7 +1,9 @@ -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.0//EN" + "http://www.oasis-open.org/docbook/xml/4.0/docbookx.dtd" + [<!ENTITY mdash "—">]> <!-- - - Copyright (C) 2004 Internet Systems Consortium, Inc. ("ISC") - - Copyright (C) 2001 Internet Software Consortium. + - Copyright (C) 2004, 2005 Internet Systems Consortium, Inc. ("ISC") + - Copyright (C) 2000, 2001 Internet Software Consortium. - - Permission to use, copy, modify, and distribute this software for any - purpose with or without fee is hereby granted, provided that the above @@ -16,7 +18,7 @@ - PERFORMANCE OF THIS SOFTWARE. --> -<!-- $Id: lwres.docbook,v 1.3.206.1 2004/03/06 08:15:37 marka Exp $ --> +<!-- $Id: lwres.docbook,v 1.3.206.3 2005/05/12 21:36:11 sra Exp $ --> <refentry> <refentryinfo> @@ -28,6 +30,20 @@ <manvolnum>3</manvolnum> <refmiscinfo>BIND9</refmiscinfo> </refmeta> + + <docinfo> + <copyright> + <year>2004</year> + <year>2005</year> + <holder>Internet Systems Consortium, Inc. ("ISC")</holder> + </copyright> + <copyright> + <year>2000</year> + <year>2001</year> + <holder>Internet Software Consortium.</holder> + </copyright> + </docinfo> + <refnamediv> <refname>lwres</refname> <refpurpose>introduction to the lightweight resolver library</refpurpose> diff --git a/contrib/bind9/lib/lwres/man/lwres.html b/contrib/bind9/lib/lwres/man/lwres.html index 793ab72..1d5e57b 100644 --- a/contrib/bind9/lib/lwres/man/lwres.html +++ b/contrib/bind9/lib/lwres/man/lwres.html @@ -1,433 +1,216 @@ <!-- - - Copyright (C) 2004 Internet Systems Consortium, Inc. ("ISC") - - Copyright (C) 2001 Internet Software Consortium. - - + - Copyright (C) 2004, 2005 Internet Systems Consortium, Inc. ("ISC") + - Copyright (C) 2000, 2001 Internet Software Consortium. + - - Permission to use, copy, modify, and distribute this software for any - purpose with or without fee is hereby granted, provided that the above - copyright notice and this permission notice appear in all copies. - - + - - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY - - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT, + - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT, - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> - -<!-- $Id: lwres.html,v 1.4.2.1.4.2 2004/08/22 23:39:02 marka Exp $ --> - -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<HTML -><HEAD -><TITLE ->lwres</TITLE -><META -NAME="GENERATOR" -CONTENT="Modular DocBook HTML Stylesheet Version 1.7"></HEAD -><BODY -CLASS="REFENTRY" -BGCOLOR="#FFFFFF" -TEXT="#000000" -LINK="#0000FF" -VLINK="#840084" -ALINK="#0000FF" -><H1 -><A -NAME="AEN1" -></A ->lwres</H1 -><DIV -CLASS="REFNAMEDIV" -><A -NAME="AEN8" -></A -><H2 ->Name</H2 ->lwres -- introduction to the lightweight resolver library</DIV -><DIV -CLASS="REFSYNOPSISDIV" -><A -NAME="AEN11" -></A -><H2 ->Synopsis</H2 -><DIV -CLASS="FUNCSYNOPSIS" -><P -></P -><A -NAME="AEN12" -></A -><PRE -CLASS="FUNCSYNOPSISINFO" ->#include <lwres/lwres.h></PRE -><P -></P -></DIV -></DIV -><DIV -CLASS="REFSECT1" -><A -NAME="AEN14" -></A -><H2 ->DESCRIPTION</H2 -><P ->The BIND 9 lightweight resolver library is a simple, name service +<!-- $Id: lwres.html,v 1.4.2.1.4.9 2005/10/13 02:33:54 marka Exp $ --> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> +<title>lwres</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.69.1"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"> +<a name="id2463721"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2>Name</h2> +<p>lwres — introduction to the lightweight resolver library</p> +</div> +<div class="refsynopsisdiv"> +<h2>Synopsis</h2> +<div class="funcsynopsis"><pre class="funcsynopsisinfo">#include <lwres/lwres.h></pre></div> +</div> +<div class="refsect1" lang="en"> +<a name="id2525832"></a><h2>DESCRIPTION</h2> +<p> +The BIND 9 lightweight resolver library is a simple, name service independent stub resolver library. It provides hostname-to-address and address-to-hostname lookup services to applications by transmitting lookup requests to a resolver daemon -<B -CLASS="COMMAND" ->lwresd</B -> +<span><strong class="command">lwresd</strong></span> running on the local host. The resover daemon performs the lookup using the DNS or possibly other name service protocols, and returns the results to the application through the library. The library and resolver daemon communicate using a simple -UDP-based protocol.</P -></DIV -><DIV -CLASS="REFSECT1" -><A -NAME="AEN18" -></A -><H2 ->OVERVIEW</H2 -><P ->The lwresd library implements multiple name service APIs. +UDP-based protocol. +</p> +</div> +<div class="refsect1" lang="en"> +<a name="id2525845"></a><h2>OVERVIEW</h2> +<p> +The lwresd library implements multiple name service APIs. The standard -<CODE -CLASS="FUNCTION" ->gethostbyname()</CODE ->, -<CODE -CLASS="FUNCTION" ->gethostbyaddr()</CODE ->, -<CODE -CLASS="FUNCTION" ->gethostbyname_r()</CODE ->, -<CODE -CLASS="FUNCTION" ->gethostbyaddr_r()</CODE ->, -<CODE -CLASS="FUNCTION" ->getaddrinfo()</CODE ->, -<CODE -CLASS="FUNCTION" ->getipnodebyname()</CODE ->, +<code class="function">gethostbyname()</code>, +<code class="function">gethostbyaddr()</code>, +<code class="function">gethostbyname_r()</code>, +<code class="function">gethostbyaddr_r()</code>, +<code class="function">getaddrinfo()</code>, +<code class="function">getipnodebyname()</code>, and -<CODE -CLASS="FUNCTION" ->getipnodebyaddr()</CODE -> +<code class="function">getipnodebyaddr()</code> functions are all supported. To allow the lwres library to coexist with system libraries that define functions of the same name, the library defines these functions with names prefixed by -<VAR -CLASS="LITERAL" ->lwres_</VAR ->. +<code class="literal">lwres_</code>. To define the standard names, applications must include the header file -<TT -CLASS="FILENAME" -><lwres/netdb.h></TT -> +<code class="filename"><lwres/netdb.h></code> which contains macro definitions mapping the standard function names into -<VAR -CLASS="LITERAL" ->lwres_</VAR -> +<code class="literal">lwres_</code> prefixed ones. Operating system vendors who integrate the lwres library into their base distributions should rename the functions -in the library proper so that the renaming macros are not needed.</P -><P ->The library also provides a native API consisting of the functions -<CODE -CLASS="FUNCTION" ->lwres_getaddrsbyname()</CODE -> +in the library proper so that the renaming macros are not needed. +</p> +<p> +The library also provides a native API consisting of the functions +<code class="function">lwres_getaddrsbyname()</code> and -<CODE -CLASS="FUNCTION" ->lwres_getnamebyaddr()</CODE ->. +<code class="function">lwres_getnamebyaddr()</code>. These may be called by applications that require more detailed control over the lookup process than the standard functions -provide.</P -><P ->In addition to these name service independent address lookup +provide. +</p> +<p> +In addition to these name service independent address lookup functions, the library implements a new, experimental API for looking up arbitrary DNS resource records, using the -<CODE -CLASS="FUNCTION" ->lwres_getaddrsbyname()</CODE -> -function.</P -><P ->Finally, there is a low-level API for converting lookup +<code class="function">lwres_getaddrsbyname()</code> +function. +</p> +<p> +Finally, there is a low-level API for converting lookup requests and responses to and from raw lwres protocol packets. This API can be used by clients requiring nonblocking operation, and is also used when implementing the server side of the lwres protocol, for example in the -<B -CLASS="COMMAND" ->lwresd</B -> +<span><strong class="command">lwresd</strong></span> resolver daemon. The use of this low-level API in clients -and servers is outlined in the following sections.</P -></DIV -><DIV -CLASS="REFSECT1" -><A -NAME="AEN38" -></A -><H2 ->CLIENT-SIDE LOW-LEVEL API CALL FLOW</H2 -><P ->When a client program wishes to make an lwres request using the +and servers is outlined in the following sections. +</p> +</div> +<div class="refsect1" lang="en"> +<a name="id2525909"></a><h2>CLIENT-SIDE LOW-LEVEL API CALL FLOW</h2> +<p> +When a client program wishes to make an lwres request using the native low-level API, it typically performs the following -sequence of actions.</P -><P ->(1) Allocate or use an existing <SPAN -CLASS="TYPE" ->lwres_packet_t</SPAN ->, -called <VAR -CLASS="VARNAME" ->pkt</VAR -> below.</P -><P ->(2) Set <CODE -CLASS="STRUCTFIELD" ->pkt.recvlength</CODE -> to the maximum length we will accept. +sequence of actions. +</p> +<p> +(1) Allocate or use an existing <span class="type">lwres_packet_t</span>, +called <code class="varname">pkt</code> below. +</p> +<p> +(2) Set <em class="structfield"><code>pkt.recvlength</code></em> to the maximum length we will accept. This is done so the receiver of our packets knows how large our receive buffer is. The "default" is a constant in -<TT -CLASS="FILENAME" ->lwres.h</TT ->: <CODE -CLASS="CONSTANT" ->LWRES_RECVLENGTH = 4096</CODE ->.</P -><P ->(3) Set <CODE -CLASS="STRUCTFIELD" ->pkt.serial</CODE -> +<code class="filename">lwres.h</code>: <code class="constant">LWRES_RECVLENGTH = 4096</code>. +</p> +<p> +(3) Set <em class="structfield"><code>pkt.serial</code></em> to a unique serial number. This value is echoed -back to the application by the remote server.</P -><P ->(4) Set <CODE -CLASS="STRUCTFIELD" ->pkt.pktflags</CODE ->. Usually this is set to 0.</P -><P ->(5) Set <CODE -CLASS="STRUCTFIELD" ->pkt.result</CODE -> to 0.</P -><P ->(6) Call <CODE -CLASS="FUNCTION" ->lwres_*request_render()</CODE ->, +back to the application by the remote server. +</p> +<p> +(4) Set <em class="structfield"><code>pkt.pktflags</code></em>. Usually this is set to 0. +</p> +<p> +(5) Set <em class="structfield"><code>pkt.result</code></em> to 0. +</p> +<p> +(6) Call <code class="function">lwres_*request_render()</code>, or marshall in the data using the primitives -such as <CODE -CLASS="FUNCTION" ->lwres_packet_render()</CODE -> -and storing the packet data.</P -><P ->(7) Transmit the resulting buffer.</P -><P ->(8) Call <CODE -CLASS="FUNCTION" ->lwres_*response_parse()</CODE -> -to parse any packets received.</P -><P ->(9) Verify that the opcode and serial match a request, and process the -packet specific information contained in the body.</P -></DIV -><DIV -CLASS="REFSECT1" -><A -NAME="AEN61" -></A -><H2 ->SERVER-SIDE LOW-LEVEL API CALL FLOW</H2 -><P ->When implementing the server side of the lightweight resolver +such as <code class="function">lwres_packet_render()</code> +and storing the packet data. +</p> +<p> +(7) Transmit the resulting buffer. +</p> +<p> +(8) Call <code class="function">lwres_*response_parse()</code> +to parse any packets received. +</p> +<p> +(9) Verify that the opcode and serial match a request, and process the +packet specific information contained in the body. +</p> +</div> +<div class="refsect1" lang="en"> +<a name="id2526056"></a><h2>SERVER-SIDE LOW-LEVEL API CALL FLOW</h2> +<p> +When implementing the server side of the lightweight resolver protocol using the lwres library, a sequence of actions like the -following is typically involved in processing each request packet.</P -><P ->Note that the same <SPAN -CLASS="TYPE" ->lwres_packet_t</SPAN -> is used -in both the <CODE -CLASS="FUNCTION" ->_parse()</CODE -> and <CODE -CLASS="FUNCTION" ->_render()</CODE -> calls, +following is typically involved in processing each request packet. +</p> +<p> +Note that the same <span class="type">lwres_packet_t</span> is used +in both the <code class="function">_parse()</code> and <code class="function">_render()</code> calls, with only a few modifications made to the packet header's contents between uses. This method is recommended -as it keeps the serial, opcode, and other fields correct.</P -><P ->(1) When a packet is received, call <CODE -CLASS="FUNCTION" ->lwres_*request_parse()</CODE -> to -unmarshall it. This returns a <SPAN -CLASS="TYPE" ->lwres_packet_t</SPAN -> (also called <VAR -CLASS="VARNAME" ->pkt</VAR ->, below) -as well as a data specific type, such as <SPAN -CLASS="TYPE" ->lwres_gabnrequest_t</SPAN ->.</P -><P ->(2) Process the request in the data specific type.</P -><P ->(3) Set the <CODE -CLASS="STRUCTFIELD" ->pkt.result</CODE ->, -<CODE -CLASS="STRUCTFIELD" ->pkt.recvlength</CODE -> as above. All other fields can -be left untouched since they were filled in by the <CODE -CLASS="FUNCTION" ->*_parse()</CODE -> call -above. If using <CODE -CLASS="FUNCTION" ->lwres_*response_render()</CODE ->, -<CODE -CLASS="STRUCTFIELD" ->pkt.pktflags</CODE -> will be set up -properly. Otherwise, the <CODE -CLASS="CONSTANT" ->LWRES_LWPACKETFLAG_RESPONSE</CODE -> bit should be -set.</P -><P ->(4) Call the data specific rendering function, such as -<CODE -CLASS="FUNCTION" ->lwres_gabnresponse_render()</CODE ->.</P -><P ->(5) Send the resulting packet to the client.</P -><P -></P -></DIV -><DIV -CLASS="REFSECT1" -><A -NAME="AEN85" -></A -><H2 ->SEE ALSO</H2 -><P -><SPAN -CLASS="CITEREFENTRY" -><SPAN -CLASS="REFENTRYTITLE" ->lwres_gethostent</SPAN ->(3)</SPAN ->, +as it keeps the serial, opcode, and other fields correct. +</p> +<p> +(1) When a packet is received, call <code class="function">lwres_*request_parse()</code> to +unmarshall it. This returns a <span class="type">lwres_packet_t</span> (also called <code class="varname">pkt</code>, below) +as well as a data specific type, such as <span class="type">lwres_gabnrequest_t</span>. +</p> +<p> +(2) Process the request in the data specific type. +</p> +<p> +(3) Set the <em class="structfield"><code>pkt.result</code></em>, +<em class="structfield"><code>pkt.recvlength</code></em> as above. All other fields can +be left untouched since they were filled in by the <code class="function">*_parse()</code> call +above. If using <code class="function">lwres_*response_render()</code>, +<em class="structfield"><code>pkt.pktflags</code></em> will be set up +properly. Otherwise, the <code class="constant">LWRES_LWPACKETFLAG_RESPONSE</code> bit should be +set. +</p> +<p> +(4) Call the data specific rendering function, such as +<code class="function">lwres_gabnresponse_render()</code>. +</p> +<p> +(5) Send the resulting packet to the client. +</p> +<p> +</p> +</div> +<div class="refsect1" lang="en"> +<a name="id2526141"></a><h2>SEE ALSO</h2> +<p> +<span class="citerefentry"><span class="refentrytitle">lwres_gethostent</span>(3)</span>, + +<span class="citerefentry"><span class="refentrytitle">lwres_getipnode</span>(3)</span>, -<SPAN -CLASS="CITEREFENTRY" -><SPAN -CLASS="REFENTRYTITLE" ->lwres_getipnode</SPAN ->(3)</SPAN ->, +<span class="citerefentry"><span class="refentrytitle">lwres_getnameinfo</span>(3)</span>, -<SPAN -CLASS="CITEREFENTRY" -><SPAN -CLASS="REFENTRYTITLE" ->lwres_getnameinfo</SPAN ->(3)</SPAN ->, +<span class="citerefentry"><span class="refentrytitle">lwres_noop</span>(3)</span>, -<SPAN -CLASS="CITEREFENTRY" -><SPAN -CLASS="REFENTRYTITLE" ->lwres_noop</SPAN ->(3)</SPAN ->, +<span class="citerefentry"><span class="refentrytitle">lwres_gabn</span>(3)</span>, -<SPAN -CLASS="CITEREFENTRY" -><SPAN -CLASS="REFENTRYTITLE" ->lwres_gabn</SPAN ->(3)</SPAN ->, +<span class="citerefentry"><span class="refentrytitle">lwres_gnba</span>(3)</span>, -<SPAN -CLASS="CITEREFENTRY" -><SPAN -CLASS="REFENTRYTITLE" ->lwres_gnba</SPAN ->(3)</SPAN ->, +<span class="citerefentry"><span class="refentrytitle">lwres_context</span>(3)</span>, -<SPAN -CLASS="CITEREFENTRY" -><SPAN -CLASS="REFENTRYTITLE" ->lwres_context</SPAN ->(3)</SPAN ->, +<span class="citerefentry"><span class="refentrytitle">lwres_config</span>(3)</span>, -<SPAN -CLASS="CITEREFENTRY" -><SPAN -CLASS="REFENTRYTITLE" ->lwres_config</SPAN ->(3)</SPAN ->, +<span class="citerefentry"><span class="refentrytitle">resolver</span>(5)</span>, -<SPAN -CLASS="CITEREFENTRY" -><SPAN -CLASS="REFENTRYTITLE" ->resolver</SPAN ->(5)</SPAN ->, +<span class="citerefentry"><span class="refentrytitle">lwresd</span>(8)</span>. -<SPAN -CLASS="CITEREFENTRY" -><SPAN -CLASS="REFENTRYTITLE" ->lwresd</SPAN ->(8)</SPAN ->. </P -></DIV -></BODY -></HTML -> +</p> +</div> +</div></body> +</html> diff --git a/contrib/bind9/lib/lwres/man/lwres_buffer.3 b/contrib/bind9/lib/lwres/man/lwres_buffer.3 index 232742a..93e888b 100644 --- a/contrib/bind9/lib/lwres/man/lwres_buffer.3 +++ b/contrib/bind9/lib/lwres/man/lwres_buffer.3 @@ -1,174 +1,117 @@ -.\" Copyright (C) 2004 Internet Systems Consortium, Inc. ("ISC") -.\" Copyright (C) 2000, 2001 Internet Software Consortium. -.\" +.\" Copyright (C) 2004, 2005 Internet Systems Consortium, Inc. ("ISC") +.\" Copyright (C) 2000, 2001 Internet Software Consortium. +.\" .\" Permission to use, copy, modify, and distribute this software for any .\" purpose with or without fee is hereby granted, provided that the above .\" copyright notice and this permission notice appear in all copies. -.\" +.\" .\" THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH .\" REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY -.\" AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT, +.\" AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT, .\" INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM .\" LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE .\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR .\" PERFORMANCE OF THIS SOFTWARE. .\" -.\" $Id: lwres_buffer.3,v 1.12.2.1.8.1 2004/03/06 07:41:42 marka Exp $ +.\" $Id: lwres_buffer.3,v 1.12.2.1.8.5 2005/10/13 02:33:58 marka Exp $ .\" -.TH "LWRES_BUFFER" "3" "Jun 30, 2000" "BIND9" "" -.SH NAME +.hy 0 +.ad l +.\" ** You probably do not want to edit this file directly ** +.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1). +.\" Instead of manually editing it, you probably should edit the DocBook XML +.\" source for it and then use the DocBook XSL Stylesheets to regenerate it. +.TH "LWRES_BUFFER" "3" "Jun 30, 2000" "BIND9" "BIND9" +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.SH "NAME" lwres_buffer_init, lwres_buffer_invalidate, lwres_buffer_add, lwres_buffer_subtract, lwres_buffer_clear, lwres_buffer_first, lwres_buffer_forward, lwres_buffer_back, lwres_buffer_getuint8, lwres_buffer_putuint8, lwres_buffer_getuint16, lwres_buffer_putuint16, lwres_buffer_getuint32, lwres_buffer_putuint32, lwres_buffer_putmem, lwres_buffer_getmem \- lightweight resolver buffer management -.SH SYNOPSIS -\fB#include <lwres/lwbuffer.h> -.sp -.na -void -lwres_buffer_init(lwres_buffer_t *b, void *base, unsigned int length); -.ad -.sp -.na -void -lwres_buffer_invalidate(lwres_buffer_t *b); -.ad -.sp -.na -void -lwres_buffer_add(lwres_buffer_t *b, unsigned int n); -.ad -.sp -.na -void -lwres_buffer_subtract(lwres_buffer_t *b, unsigned int n); -.ad -.sp -.na -void -lwres_buffer_clear(lwres_buffer_t *b); -.ad -.sp -.na -void -lwres_buffer_first(lwres_buffer_t *b); -.ad -.sp -.na -void -lwres_buffer_forward(lwres_buffer_t *b, unsigned int n); -.ad -.sp -.na -void -lwres_buffer_back(lwres_buffer_t *b, unsigned int n); -.ad -.sp -.na -lwres_uint8_t -lwres_buffer_getuint8(lwres_buffer_t *b); -.ad -.sp -.na -void -lwres_buffer_putuint8(lwres_buffer_t *b, lwres_uint8_t val); -.ad -.sp -.na -lwres_uint16_t -lwres_buffer_getuint16(lwres_buffer_t *b); -.ad -.sp -.na -void -lwres_buffer_putuint16(lwres_buffer_t *b, lwres_uint16_t val); -.ad -.sp -.na -lwres_uint32_t -lwres_buffer_getuint32(lwres_buffer_t *b); -.ad -.sp -.na -void -lwres_buffer_putuint32(lwres_buffer_t *b, lwres_uint32_t val); -.ad -.sp -.na -void -lwres_buffer_putmem(lwres_buffer_t *b, const unsigned char *base, unsigned int length); -.ad -.sp -.na -void -lwres_buffer_getmem(lwres_buffer_t *b, unsigned char *base, unsigned int length); -.ad -\fR +.SH "SYNOPSIS" +.nf +#include <lwres/lwbuffer.h> +.fi +.HP 23 +\fBvoid\ \fBlwres_buffer_init\fR\fR\fB(\fR\fBlwres_buffer_t\ *b\fR\fB, \fR\fBvoid\ *base\fR\fB, \fR\fBunsigned\ int\ length\fR\fB);\fR +.HP 29 +\fBvoid\ \fBlwres_buffer_invalidate\fR\fR\fB(\fR\fBlwres_buffer_t\ *b\fR\fB);\fR +.HP 22 +\fBvoid\ \fBlwres_buffer_add\fR\fR\fB(\fR\fBlwres_buffer_t\ *b\fR\fB, \fR\fBunsigned\ int\ n\fR\fB);\fR +.HP 27 +\fBvoid\ \fBlwres_buffer_subtract\fR\fR\fB(\fR\fBlwres_buffer_t\ *b\fR\fB, \fR\fBunsigned\ int\ n\fR\fB);\fR +.HP 24 +\fBvoid\ \fBlwres_buffer_clear\fR\fR\fB(\fR\fBlwres_buffer_t\ *b\fR\fB);\fR +.HP 24 +\fBvoid\ \fBlwres_buffer_first\fR\fR\fB(\fR\fBlwres_buffer_t\ *b\fR\fB);\fR +.HP 26 +\fBvoid\ \fBlwres_buffer_forward\fR\fR\fB(\fR\fBlwres_buffer_t\ *b\fR\fB, \fR\fBunsigned\ int\ n\fR\fB);\fR +.HP 23 +\fBvoid\ \fBlwres_buffer_back\fR\fR\fB(\fR\fBlwres_buffer_t\ *b\fR\fB, \fR\fBunsigned\ int\ n\fR\fB);\fR +.HP 36 +\fBlwres_uint8_t\ \fBlwres_buffer_getuint8\fR\fR\fB(\fR\fBlwres_buffer_t\ *b\fR\fB);\fR +.HP 27 +\fBvoid\ \fBlwres_buffer_putuint8\fR\fR\fB(\fR\fBlwres_buffer_t\ *b\fR\fB, \fR\fBlwres_uint8_t\ val\fR\fB);\fR +.HP 38 +\fBlwres_uint16_t\ \fBlwres_buffer_getuint16\fR\fR\fB(\fR\fBlwres_buffer_t\ *b\fR\fB);\fR +.HP 28 +\fBvoid\ \fBlwres_buffer_putuint16\fR\fR\fB(\fR\fBlwres_buffer_t\ *b\fR\fB, \fR\fBlwres_uint16_t\ val\fR\fB);\fR +.HP 38 +\fBlwres_uint32_t\ \fBlwres_buffer_getuint32\fR\fR\fB(\fR\fBlwres_buffer_t\ *b\fR\fB);\fR +.HP 28 +\fBvoid\ \fBlwres_buffer_putuint32\fR\fR\fB(\fR\fBlwres_buffer_t\ *b\fR\fB, \fR\fBlwres_uint32_t\ val\fR\fB);\fR +.HP 25 +\fBvoid\ \fBlwres_buffer_putmem\fR\fR\fB(\fR\fBlwres_buffer_t\ *b\fR\fB, \fR\fBconst\ unsigned\ char\ *base\fR\fB, \fR\fBunsigned\ int\ length\fR\fB);\fR +.HP 25 +\fBvoid\ \fBlwres_buffer_getmem\fR\fR\fB(\fR\fBlwres_buffer_t\ *b\fR\fB, \fR\fBunsigned\ char\ *base\fR\fB, \fR\fBunsigned\ int\ length\fR\fB);\fR .SH "DESCRIPTION" .PP -These functions provide bounds checked access to a region of memory -where data is being read or written. -They are based on, and similar to, the +These functions provide bounds checked access to a region of memory where data is being read or written. They are based on, and similar to, the isc_buffer_ functions in the ISC library. .PP -A buffer is a region of memory, together with a set of related -subregions. -The \fBused region\fR and the -\fBavailable\fR region are disjoint, and -their union is the buffer's region. -The used region extends from the beginning of the buffer region to the -last used byte. -The available region extends from one byte greater than the last used -byte to the end of the buffer's region. -The size of the used region can be changed using various -buffer commands. -Initially, the used region is empty. +A buffer is a region of memory, together with a set of related subregions. The +\fIused region\fR +and the +\fIavailable\fR +region are disjoint, and their union is the buffer's region. The used region extends from the beginning of the buffer region to the last used byte. The available region extends from one byte greater than the last used byte to the end of the buffer's region. The size of the used region can be changed using various buffer commands. Initially, the used region is empty. .PP The used region is further subdivided into two disjoint regions: the -\fBconsumed region\fR and the \fBremaining region\fR. -The union of these two regions is the used region. -The consumed region extends from the beginning of the used region to -the byte before the \fBcurrent\fR offset (if any). -The \fBremaining\fR region the current pointer to the end of the used -region. -The size of the consumed region can be changed using various -buffer commands. -Initially, the consumed region is empty. +\fIconsumed region\fR +and the +\fIremaining region\fR. The union of these two regions is the used region. The consumed region extends from the beginning of the used region to the byte before the +\fIcurrent\fR +offset (if any). The +\fIremaining\fR +region the current pointer to the end of the used region. The size of the consumed region can be changed using various buffer commands. Initially, the consumed region is empty. .PP -The \fBactive region\fR is an (optional) subregion of the remaining -region. -It extends from the current offset to an offset in the -remaining region. -Initially, the active region is empty. -If the current offset advances beyond the chosen offset, -the active region will also be empty. +The +\fIactive region\fR +is an (optional) subregion of the remaining region. It extends from the current offset to an offset in the remaining region. Initially, the active region is empty. If the current offset advances beyond the chosen offset, the active region will also be empty. .PP -.sp .nf - - /------------entire length---------------\\\\ - /----- used region -----\\\\/-- available --\\\\ - +----------------------------------------+ + /\-\-\-\-\-\-\-\-\-\-\-\-entire length\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\\\\ + /\-\-\-\-\- used region \-\-\-\-\-\\\\/\-\- available \-\-\\\\ + +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+ | consumed | remaining | | - +----------------------------------------+ + +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+ a b c d e - a == base of buffer. b == current pointer. Can be anywhere between a and d. c == active pointer. Meaningful between b and d. d == used pointer. e == length of buffer. - - a-e == entire length of buffer. - a-d == used region. - a-b == consumed region. - b-d == remaining region. - b-c == optional active region. -.sp + a\-e == entire length of buffer. + a\-d == used region. + a\-b == consumed region. + b\-d == remaining region. + b\-c == optional active region. .fi +.sp .PP \fBlwres_buffer_init()\fR initializes the -\fBlwres_buffer_t\fR -\fI*b\fR +\fBlwres_buffer_t\fR\fI*b\fR and assocates it with the memory region of size \fIlength\fR bytes starting at location @@ -177,15 +120,13 @@ bytes starting at location \fBlwres_buffer_invalidate()\fR marks the buffer \fI*b\fR -as invalid. Invalidating a buffer after use is not required, -but makes it possible to catch its possible accidental use. +as invalid. Invalidating a buffer after use is not required, but makes it possible to catch its possible accidental use. .PP The functions \fBlwres_buffer_add()\fR and \fBlwres_buffer_subtract()\fR -respectively increase and decrease the used space in -buffer +respectively increase and decrease the used space in buffer \fI*b\fR by \fIn\fR @@ -193,25 +134,23 @@ bytes. \fBlwres_buffer_add()\fR checks for buffer overflow and \fBlwres_buffer_subtract()\fR -checks for underflow. -These functions do not allocate or deallocate memory. -They just change the value of -\fBused\fR. +checks for underflow. These functions do not allocate or deallocate memory. They just change the value of +used. .PP -A buffer is re-initialised by -\fBlwres_buffer_clear()\fR. -The function sets -\fBused\fR , -\fBcurrent\fR +A buffer is re\-initialised by +\fBlwres_buffer_clear()\fR. The function sets +used +, +current and -\fBactive\fR +active to zero. .PP \fBlwres_buffer_first\fR makes the consumed region of buffer \fI*p\fR empty by setting -\fBcurrent\fR +current to zero (the start of the buffer). .PP \fBlwres_buffer_forward()\fR @@ -219,21 +158,19 @@ increases the consumed region of buffer \fI*b\fR by \fIn\fR -bytes, checking for overflow. -Similarly, +bytes, checking for overflow. Similarly, \fBlwres_buffer_back()\fR decreases buffer -\fIb\fR's -consumed region by +\fIb\fR's consumed region by \fIn\fR bytes and checks for underflow. .PP \fBlwres_buffer_getuint8()\fR -reads an unsigned 8-bit integer from +reads an unsigned 8\-bit integer from \fI*b\fR and returns it. \fBlwres_buffer_putuint8()\fR -writes the unsigned 8-bit integer +writes the unsigned 8\-bit integer \fIval\fR to buffer \fI*b\fR. @@ -243,21 +180,17 @@ and \fBlwres_buffer_getuint32()\fR are identical to \fBlwres_buffer_putuint8()\fR -except that they respectively read an unsigned 16-bit or 32-bit integer -in network byte order from -\fIb\fR. -Similarly, +except that they respectively read an unsigned 16\-bit or 32\-bit integer in network byte order from +\fIb\fR. Similarly, \fBlwres_buffer_putuint16()\fR and \fBlwres_buffer_putuint32()\fR -writes the unsigned 16-bit or 32-bit integer +writes the unsigned 16\-bit or 32\-bit integer \fIval\fR to buffer -\fIb\fR, -in network byte order. +\fIb\fR, in network byte order. .PP -Arbitrary amounts of data are read or written from a lightweight -resolver buffer with +Arbitrary amounts of data are read or written from a lightweight resolver buffer with \fBlwres_buffer_getmem()\fR and \fBlwres_buffer_putmem()\fR @@ -268,8 +201,7 @@ copies bytes of memory at \fIbase\fR to -\fIb\fR. -Conversely, +\fIb\fR. Conversely, \fBlwres_buffer_getmem()\fR copies \fIlength\fR diff --git a/contrib/bind9/lib/lwres/man/lwres_buffer.docbook b/contrib/bind9/lib/lwres/man/lwres_buffer.docbook index 4db9fd3..c70aee5 100644 --- a/contrib/bind9/lib/lwres/man/lwres_buffer.docbook +++ b/contrib/bind9/lib/lwres/man/lwres_buffer.docbook @@ -1,7 +1,9 @@ -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.0//EN" + "http://www.oasis-open.org/docbook/xml/4.0/docbookx.dtd" + [<!ENTITY mdash "—">]> <!-- - - Copyright (C) 2004 Internet Systems Consortium, Inc. ("ISC") - - Copyright (C) 2001 Internet Software Consortium. + - Copyright (C) 2004, 2005 Internet Systems Consortium, Inc. ("ISC") + - Copyright (C) 2000, 2001 Internet Software Consortium. - - Permission to use, copy, modify, and distribute this software for any - purpose with or without fee is hereby granted, provided that the above @@ -16,7 +18,7 @@ - PERFORMANCE OF THIS SOFTWARE. --> -<!-- $Id: lwres_buffer.docbook,v 1.3.206.1 2004/03/06 08:15:37 marka Exp $ --> +<!-- $Id: lwres_buffer.docbook,v 1.3.206.3 2005/05/12 21:36:11 sra Exp $ --> <refentry> <refentryinfo> @@ -29,6 +31,19 @@ <refmiscinfo>BIND9</refmiscinfo> </refmeta> + <docinfo> + <copyright> + <year>2004</year> + <year>2005</year> + <holder>Internet Systems Consortium, Inc. ("ISC")</holder> + </copyright> + <copyright> + <year>2000</year> + <year>2001</year> + <holder>Internet Software Consortium.</holder> + </copyright> + </docinfo> + <refnamediv> <refname>lwres_buffer_init</refname> <refname>lwres_buffer_invalidate</refname> diff --git a/contrib/bind9/lib/lwres/man/lwres_buffer.html b/contrib/bind9/lib/lwres/man/lwres_buffer.html index 79354fc..5a203f1 100644 --- a/contrib/bind9/lib/lwres/man/lwres_buffer.html +++ b/contrib/bind9/lib/lwres/man/lwres_buffer.html @@ -1,232 +1,267 @@ <!-- - - Copyright (C) 2004 Internet Systems Consortium, Inc. ("ISC") - - Copyright (C) 2001 Internet Software Consortium. - - + - Copyright (C) 2004, 2005 Internet Systems Consortium, Inc. ("ISC") + - Copyright (C) 2000, 2001 Internet Software Consortium. + - - Permission to use, copy, modify, and distribute this software for any - purpose with or without fee is hereby granted, provided that the above - copyright notice and this permission notice appear in all copies. - - + - - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY - - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT, + - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT, - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> - -<!-- $Id: lwres_buffer.html,v 1.4.2.1.4.2 2004/08/22 23:39:03 marka Exp $ --> - -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<HTML -><HEAD -><TITLE ->lwres_buffer</TITLE -><META -NAME="GENERATOR" -CONTENT="Modular DocBook HTML Stylesheet Version 1.7"></HEAD -><BODY -CLASS="REFENTRY" -BGCOLOR="#FFFFFF" -TEXT="#000000" -LINK="#0000FF" -VLINK="#840084" -ALINK="#0000FF" -><H1 -><A -NAME="AEN1" -></A ->lwres_buffer</H1 -><DIV -CLASS="REFNAMEDIV" -><A -NAME="AEN8" -></A -><H2 ->Name</H2 ->lwres_buffer_init, lwres_buffer_invalidate, lwres_buffer_add, lwres_buffer_subtract, lwres_buffer_clear, lwres_buffer_first, lwres_buffer_forward, lwres_buffer_back, lwres_buffer_getuint8, lwres_buffer_putuint8, lwres_buffer_getuint16, lwres_buffer_putuint16, lwres_buffer_getuint32, lwres_buffer_putuint32, lwres_buffer_putmem, lwres_buffer_getmem -- lightweight resolver buffer management</DIV -><DIV -CLASS="REFSYNOPSISDIV" -><A -NAME="AEN26" -></A -><H2 ->Synopsis</H2 -><DIV -CLASS="FUNCSYNOPSIS" -><P -></P -><A -NAME="AEN27" -></A -><PRE -CLASS="FUNCSYNOPSISINFO" ->#include <lwres/lwbuffer.h></PRE -><P -><CODE -><CODE -CLASS="FUNCDEF" ->void -lwres_buffer_init</CODE ->(lwres_buffer_t *b, void *base, unsigned int length);</CODE -></P -><P -><CODE -><CODE -CLASS="FUNCDEF" ->void -lwres_buffer_invalidate</CODE ->(lwres_buffer_t *b);</CODE -></P -><P -><CODE -><CODE -CLASS="FUNCDEF" ->void -lwres_buffer_add</CODE ->(lwres_buffer_t *b, unsigned int n);</CODE -></P -><P -><CODE -><CODE -CLASS="FUNCDEF" ->void -lwres_buffer_subtract</CODE ->(lwres_buffer_t *b, unsigned int n);</CODE -></P -><P -><CODE -><CODE -CLASS="FUNCDEF" ->void -lwres_buffer_clear</CODE ->(lwres_buffer_t *b);</CODE -></P -><P -><CODE -><CODE -CLASS="FUNCDEF" ->void -lwres_buffer_first</CODE ->(lwres_buffer_t *b);</CODE -></P -><P -><CODE -><CODE -CLASS="FUNCDEF" ->void -lwres_buffer_forward</CODE ->(lwres_buffer_t *b, unsigned int n);</CODE -></P -><P -><CODE -><CODE -CLASS="FUNCDEF" ->void -lwres_buffer_back</CODE ->(lwres_buffer_t *b, unsigned int n);</CODE -></P -><P -><CODE -><CODE -CLASS="FUNCDEF" ->lwres_uint8_t -lwres_buffer_getuint8</CODE ->(lwres_buffer_t *b);</CODE -></P -><P -><CODE -><CODE -CLASS="FUNCDEF" ->void -lwres_buffer_putuint8</CODE ->(lwres_buffer_t *b, lwres_uint8_t val);</CODE -></P -><P -><CODE -><CODE -CLASS="FUNCDEF" ->lwres_uint16_t -lwres_buffer_getuint16</CODE ->(lwres_buffer_t *b);</CODE -></P -><P -><CODE -><CODE -CLASS="FUNCDEF" ->void -lwres_buffer_putuint16</CODE ->(lwres_buffer_t *b, lwres_uint16_t val);</CODE -></P -><P -><CODE -><CODE -CLASS="FUNCDEF" ->lwres_uint32_t -lwres_buffer_getuint32</CODE ->(lwres_buffer_t *b);</CODE -></P -><P -><CODE -><CODE -CLASS="FUNCDEF" ->void -lwres_buffer_putuint32</CODE ->(lwres_buffer_t *b, lwres_uint32_t val);</CODE -></P -><P -><CODE -><CODE -CLASS="FUNCDEF" ->void -lwres_buffer_putmem</CODE ->(lwres_buffer_t *b, const unsigned char *base, unsigned int length);</CODE -></P -><P -><CODE -><CODE -CLASS="FUNCDEF" ->void -lwres_buffer_getmem</CODE ->(lwres_buffer_t *b, unsigned char *base, unsigned int length);</CODE -></P -><P -></P -></DIV -></DIV -><DIV -CLASS="REFSECT1" -><A -NAME="AEN106" -></A -><H2 ->DESCRIPTION</H2 -><P ->These functions provide bounds checked access to a region of memory +<!-- $Id: lwres_buffer.html,v 1.4.2.1.4.8 2005/10/13 02:33:55 marka Exp $ --> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> +<title>lwres_buffer</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.69.1"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"> +<a name="id2463721"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2>Name</h2> +<p>lwres_buffer_init, lwres_buffer_invalidate, lwres_buffer_add, lwres_buffer_subtract, lwres_buffer_clear, lwres_buffer_first, lwres_buffer_forward, lwres_buffer_back, lwres_buffer_getuint8, lwres_buffer_putuint8, lwres_buffer_getuint16, lwres_buffer_putuint16, lwres_buffer_getuint32, lwres_buffer_putuint32, lwres_buffer_putmem, lwres_buffer_getmem — lightweight resolver buffer management</p> +</div> +<div class="refsynopsisdiv"> +<h2>Synopsis</h2> +<div class="funcsynopsis"> +<pre class="funcsynopsisinfo"> +#include <lwres/lwbuffer.h> +</pre> +<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em"> +<tr> +<td><code class="funcdef"> +void +<b class="fsfunc">lwres_buffer_init</b>(</code></td> +<td> </td> +<td>, </td> +</tr> +<tr> +<td> </td> +<td> </td> +<td>, </td> +</tr> +<tr> +<td> </td> +<td> </td> +<td> +<code>)</code>;</td> +</tr> +</table> +<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em"><tr> +<td><code class="funcdef"> +void +<b class="fsfunc">lwres_buffer_invalidate</b>(</code></td> +<td> </td> +<td> +<code>)</code>;</td> +</tr></table> +<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em"> +<tr> +<td><code class="funcdef"> +void +<b class="fsfunc">lwres_buffer_add</b>(</code></td> +<td> </td> +<td>, </td> +</tr> +<tr> +<td> </td> +<td> </td> +<td> +<code>)</code>;</td> +</tr> +</table> +<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em"> +<tr> +<td><code class="funcdef"> +void +<b class="fsfunc">lwres_buffer_subtract</b>(</code></td> +<td> </td> +<td>, </td> +</tr> +<tr> +<td> </td> +<td> </td> +<td> +<code>)</code>;</td> +</tr> +</table> +<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em"><tr> +<td><code class="funcdef"> +void +<b class="fsfunc">lwres_buffer_clear</b>(</code></td> +<td> </td> +<td> +<code>)</code>;</td> +</tr></table> +<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em"><tr> +<td><code class="funcdef"> +void +<b class="fsfunc">lwres_buffer_first</b>(</code></td> +<td> </td> +<td> +<code>)</code>;</td> +</tr></table> +<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em"> +<tr> +<td><code class="funcdef"> +void +<b class="fsfunc">lwres_buffer_forward</b>(</code></td> +<td> </td> +<td>, </td> +</tr> +<tr> +<td> </td> +<td> </td> +<td> +<code>)</code>;</td> +</tr> +</table> +<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em"> +<tr> +<td><code class="funcdef"> +void +<b class="fsfunc">lwres_buffer_back</b>(</code></td> +<td> </td> +<td>, </td> +</tr> +<tr> +<td> </td> +<td> </td> +<td> +<code>)</code>;</td> +</tr> +</table> +<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em"><tr> +<td><code class="funcdef"> +lwres_uint8_t +<b class="fsfunc">lwres_buffer_getuint8</b>(</code></td> +<td> </td> +<td> +<code>)</code>;</td> +</tr></table> +<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em"> +<tr> +<td><code class="funcdef"> +void +<b class="fsfunc">lwres_buffer_putuint8</b>(</code></td> +<td> </td> +<td>, </td> +</tr> +<tr> +<td> </td> +<td> </td> +<td> +<code>)</code>;</td> +</tr> +</table> +<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em"><tr> +<td><code class="funcdef"> +lwres_uint16_t +<b class="fsfunc">lwres_buffer_getuint16</b>(</code></td> +<td> </td> +<td> +<code>)</code>;</td> +</tr></table> +<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em"> +<tr> +<td><code class="funcdef"> +void +<b class="fsfunc">lwres_buffer_putuint16</b>(</code></td> +<td> </td> +<td>, </td> +</tr> +<tr> +<td> </td> +<td> </td> +<td> +<code>)</code>;</td> +</tr> +</table> +<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em"><tr> +<td><code class="funcdef"> +lwres_uint32_t +<b class="fsfunc">lwres_buffer_getuint32</b>(</code></td> +<td> </td> +<td> +<code>)</code>;</td> +</tr></table> +<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em"> +<tr> +<td><code class="funcdef"> +void +<b class="fsfunc">lwres_buffer_putuint32</b>(</code></td> +<td> </td> +<td>, </td> +</tr> +<tr> +<td> </td> +<td> </td> +<td> +<code>)</code>;</td> +</tr> +</table> +<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em"> +<tr> +<td><code class="funcdef"> +void +<b class="fsfunc">lwres_buffer_putmem</b>(</code></td> +<td> </td> +<td>, </td> +</tr> +<tr> +<td> </td> +<td> </td> +<td>, </td> +</tr> +<tr> +<td> </td> +<td> </td> +<td> +<code>)</code>;</td> +</tr> +</table> +<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0"> +<tr> +<td><code class="funcdef"> +void +<b class="fsfunc">lwres_buffer_getmem</b>(</code></td> +<td> </td> +<td>, </td> +</tr> +<tr> +<td> </td> +<td> </td> +<td>, </td> +</tr> +<tr> +<td> </td> +<td> </td> +<td> +<code>)</code>;</td> +</tr> +</table> +</div> +</div> +<div class="refsect1" lang="en"> +<a name="id2526109"></a><h2>DESCRIPTION</h2> +<p> +These functions provide bounds checked access to a region of memory where data is being read or written. They are based on, and similar to, the -<VAR -CLASS="LITERAL" ->isc_buffer_</VAR -> -functions in the ISC library.</P -><P ->A buffer is a region of memory, together with a set of related +<code class="literal">isc_buffer_</code> +functions in the ISC library. +</p> +<p> +A buffer is a region of memory, together with a set of related subregions. -The <SPAN -CLASS="emphasis" -><I -CLASS="EMPHASIS" ->used region</I -></SPAN -> and the -<SPAN -CLASS="emphasis" -><I -CLASS="EMPHASIS" ->available</I -></SPAN -> region are disjoint, and +The <span class="emphasis"><em>used region</em></span> and the +<span class="emphasis"><em>available</em></span> region are disjoint, and their union is the buffer's region. The used region extends from the beginning of the buffer region to the last used byte. @@ -234,60 +269,33 @@ The available region extends from one byte greater than the last used byte to the end of the buffer's region. The size of the used region can be changed using various buffer commands. -Initially, the used region is empty.</P -><P ->The used region is further subdivided into two disjoint regions: the -<SPAN -CLASS="emphasis" -><I -CLASS="EMPHASIS" ->consumed region</I -></SPAN -> and the <SPAN -CLASS="emphasis" -><I -CLASS="EMPHASIS" ->remaining region</I -></SPAN ->. +Initially, the used region is empty. +</p> +<p> +The used region is further subdivided into two disjoint regions: the +<span class="emphasis"><em>consumed region</em></span> and the <span class="emphasis"><em>remaining region</em></span>. The union of these two regions is the used region. The consumed region extends from the beginning of the used region to -the byte before the <SPAN -CLASS="emphasis" -><I -CLASS="EMPHASIS" ->current</I -></SPAN -> offset (if any). -The <SPAN -CLASS="emphasis" -><I -CLASS="EMPHASIS" ->remaining</I -></SPAN -> region the current pointer to the end of the used +the byte before the <span class="emphasis"><em>current</em></span> offset (if any). +The <span class="emphasis"><em>remaining</em></span> region the current pointer to the end of the used region. The size of the consumed region can be changed using various buffer commands. -Initially, the consumed region is empty.</P -><P ->The <SPAN -CLASS="emphasis" -><I -CLASS="EMPHASIS" ->active region</I -></SPAN -> is an (optional) subregion of the remaining +Initially, the consumed region is empty. +</p> +<p> +The <span class="emphasis"><em>active region</em></span> is an (optional) subregion of the remaining region. It extends from the current offset to an offset in the remaining region. Initially, the active region is empty. If the current offset advances beyond the chosen offset, -the active region will also be empty.</P -><P -><PRE -CLASS="PROGRAMLISTING" -> +the active region will also be empty. +</p> +<p> +</p> +<pre class="programlisting"> + /------------entire length---------------\\ /----- used region -----\\/-- available --\\ +----------------------------------------+ @@ -305,272 +313,132 @@ CLASS="PROGRAMLISTING" a-d == used region. a-b == consumed region. b-d == remaining region. - b-c == optional active region.</PRE -></P -><P -><CODE -CLASS="FUNCTION" ->lwres_buffer_init()</CODE -> + b-c == optional active region. +</pre> +<p> +</p> +<p> +<code class="function">lwres_buffer_init()</code> initializes the -<SPAN -CLASS="TYPE" ->lwres_buffer_t</SPAN -> -<VAR -CLASS="PARAMETER" ->*b</VAR -> +<span class="type">lwres_buffer_t</span> +<em class="parameter"><code>*b</code></em> and assocates it with the memory region of size -<VAR -CLASS="PARAMETER" ->length</VAR -> +<em class="parameter"><code>length</code></em> bytes starting at location -<VAR -CLASS="PARAMETER" ->base.</VAR -></P -><P -><CODE -CLASS="FUNCTION" ->lwres_buffer_invalidate()</CODE -> +<em class="parameter"><code>base.</code></em> +</p> +<p> +<code class="function">lwres_buffer_invalidate()</code> marks the buffer -<VAR -CLASS="PARAMETER" ->*b</VAR -> +<em class="parameter"><code>*b</code></em> as invalid. Invalidating a buffer after use is not required, -but makes it possible to catch its possible accidental use.</P -><P ->The functions -<CODE -CLASS="FUNCTION" ->lwres_buffer_add()</CODE -> +but makes it possible to catch its possible accidental use. +</p> +<p> +The functions +<code class="function">lwres_buffer_add()</code> and -<CODE -CLASS="FUNCTION" ->lwres_buffer_subtract()</CODE -> +<code class="function">lwres_buffer_subtract()</code> respectively increase and decrease the used space in buffer -<VAR -CLASS="PARAMETER" ->*b</VAR -> +<em class="parameter"><code>*b</code></em> by -<VAR -CLASS="PARAMETER" ->n</VAR -> +<em class="parameter"><code>n</code></em> bytes. -<CODE -CLASS="FUNCTION" ->lwres_buffer_add()</CODE -> +<code class="function">lwres_buffer_add()</code> checks for buffer overflow and -<CODE -CLASS="FUNCTION" ->lwres_buffer_subtract()</CODE -> +<code class="function">lwres_buffer_subtract()</code> checks for underflow. These functions do not allocate or deallocate memory. They just change the value of -<CODE -CLASS="STRUCTFIELD" ->used</CODE ->.</P -><P ->A buffer is re-initialised by -<CODE -CLASS="FUNCTION" ->lwres_buffer_clear()</CODE ->. +<em class="structfield"><code>used</code></em>. +</p> +<p> +A buffer is re-initialised by +<code class="function">lwres_buffer_clear()</code>. The function sets -<CODE -CLASS="STRUCTFIELD" ->used</CODE -> , -<CODE -CLASS="STRUCTFIELD" ->current</CODE -> +<em class="structfield"><code>used</code></em> , +<em class="structfield"><code>current</code></em> and -<CODE -CLASS="STRUCTFIELD" ->active</CODE -> -to zero.</P -><P -><CODE -CLASS="FUNCTION" ->lwres_buffer_first</CODE -> +<em class="structfield"><code>active</code></em> +to zero. +</p> +<p> +<code class="function">lwres_buffer_first</code> makes the consumed region of buffer -<VAR -CLASS="PARAMETER" ->*p</VAR -> +<em class="parameter"><code>*p</code></em> empty by setting -<CODE -CLASS="STRUCTFIELD" ->current</CODE -> -to zero (the start of the buffer).</P -><P -><CODE -CLASS="FUNCTION" ->lwres_buffer_forward()</CODE -> +<em class="structfield"><code>current</code></em> +to zero (the start of the buffer). +</p> +<p> +<code class="function">lwres_buffer_forward()</code> increases the consumed region of buffer -<VAR -CLASS="PARAMETER" ->*b</VAR -> +<em class="parameter"><code>*b</code></em> by -<VAR -CLASS="PARAMETER" ->n</VAR -> +<em class="parameter"><code>n</code></em> bytes, checking for overflow. Similarly, -<CODE -CLASS="FUNCTION" ->lwres_buffer_back()</CODE -> +<code class="function">lwres_buffer_back()</code> decreases buffer -<VAR -CLASS="PARAMETER" ->b</VAR ->'s +<em class="parameter"><code>b</code></em>'s consumed region by -<VAR -CLASS="PARAMETER" ->n</VAR -> -bytes and checks for underflow.</P -><P -><CODE -CLASS="FUNCTION" ->lwres_buffer_getuint8()</CODE -> +<em class="parameter"><code>n</code></em> +bytes and checks for underflow. +</p> +<p> +<code class="function">lwres_buffer_getuint8()</code> reads an unsigned 8-bit integer from -<VAR -CLASS="PARAMETER" ->*b</VAR -> +<em class="parameter"><code>*b</code></em> and returns it. -<CODE -CLASS="FUNCTION" ->lwres_buffer_putuint8()</CODE -> +<code class="function">lwres_buffer_putuint8()</code> writes the unsigned 8-bit integer -<VAR -CLASS="PARAMETER" ->val</VAR -> +<em class="parameter"><code>val</code></em> to buffer -<VAR -CLASS="PARAMETER" ->*b</VAR ->.</P -><P -><CODE -CLASS="FUNCTION" ->lwres_buffer_getuint16()</CODE -> +<em class="parameter"><code>*b</code></em>. +</p> +<p> +<code class="function">lwres_buffer_getuint16()</code> and -<CODE -CLASS="FUNCTION" ->lwres_buffer_getuint32()</CODE -> +<code class="function">lwres_buffer_getuint32()</code> are identical to -<CODE -CLASS="FUNCTION" ->lwres_buffer_putuint8()</CODE -> +<code class="function">lwres_buffer_putuint8()</code> except that they respectively read an unsigned 16-bit or 32-bit integer in network byte order from -<VAR -CLASS="PARAMETER" ->b</VAR ->. +<em class="parameter"><code>b</code></em>. Similarly, -<CODE -CLASS="FUNCTION" ->lwres_buffer_putuint16()</CODE -> +<code class="function">lwres_buffer_putuint16()</code> and -<CODE -CLASS="FUNCTION" ->lwres_buffer_putuint32()</CODE -> +<code class="function">lwres_buffer_putuint32()</code> writes the unsigned 16-bit or 32-bit integer -<VAR -CLASS="PARAMETER" ->val</VAR -> +<em class="parameter"><code>val</code></em> to buffer -<VAR -CLASS="PARAMETER" ->b</VAR ->, -in network byte order.</P -><P ->Arbitrary amounts of data are read or written from a lightweight +<em class="parameter"><code>b</code></em>, +in network byte order. +</p> +<p> +Arbitrary amounts of data are read or written from a lightweight resolver buffer with -<CODE -CLASS="FUNCTION" ->lwres_buffer_getmem()</CODE -> +<code class="function">lwres_buffer_getmem()</code> and -<CODE -CLASS="FUNCTION" ->lwres_buffer_putmem()</CODE -> +<code class="function">lwres_buffer_putmem()</code> respectively. -<CODE -CLASS="FUNCTION" ->lwres_buffer_putmem()</CODE -> +<code class="function">lwres_buffer_putmem()</code> copies -<VAR -CLASS="PARAMETER" ->length</VAR -> +<em class="parameter"><code>length</code></em> bytes of memory at -<VAR -CLASS="PARAMETER" ->base</VAR -> +<em class="parameter"><code>base</code></em> to -<VAR -CLASS="PARAMETER" ->b</VAR ->. +<em class="parameter"><code>b</code></em>. Conversely, -<CODE -CLASS="FUNCTION" ->lwres_buffer_getmem()</CODE -> +<code class="function">lwres_buffer_getmem()</code> copies -<VAR -CLASS="PARAMETER" ->length</VAR -> +<em class="parameter"><code>length</code></em> bytes of memory from -<VAR -CLASS="PARAMETER" ->b</VAR -> +<em class="parameter"><code>b</code></em> to -<VAR -CLASS="PARAMETER" ->base</VAR ->.</P -></DIV -></BODY -></HTML -> +<em class="parameter"><code>base</code></em>. +</p> +</div> +</div></body> +</html> diff --git a/contrib/bind9/lib/lwres/man/lwres_config.3 b/contrib/bind9/lib/lwres/man/lwres_config.3 index 0c345ef..9430283 100644 --- a/contrib/bind9/lib/lwres/man/lwres_config.3 +++ b/contrib/bind9/lib/lwres/man/lwres_config.3 @@ -1,51 +1,47 @@ -.\" Copyright (C) 2004 Internet Systems Consortium, Inc. ("ISC") -.\" Copyright (C) 2000, 2001 Internet Software Consortium. -.\" +.\" Copyright (C) 2004, 2005 Internet Systems Consortium, Inc. ("ISC") +.\" Copyright (C) 2000, 2001 Internet Software Consortium. +.\" .\" Permission to use, copy, modify, and distribute this software for any .\" purpose with or without fee is hereby granted, provided that the above .\" copyright notice and this permission notice appear in all copies. -.\" +.\" .\" THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH .\" REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY -.\" AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT, +.\" AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT, .\" INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM .\" LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE .\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR .\" PERFORMANCE OF THIS SOFTWARE. .\" -.\" $Id: lwres_config.3,v 1.12.2.1.8.1 2004/03/06 07:41:42 marka Exp $ +.\" $Id: lwres_config.3,v 1.12.2.1.8.5 2005/10/13 02:33:58 marka Exp $ .\" -.TH "LWRES_CONFIG" "3" "Jun 30, 2000" "BIND9" "" -.SH NAME +.hy 0 +.ad l +.\" ** You probably do not want to edit this file directly ** +.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1). +.\" Instead of manually editing it, you probably should edit the DocBook XML +.\" source for it and then use the DocBook XSL Stylesheets to regenerate it. +.TH "LWRES_CONFIG" "3" "Jun 30, 2000" "BIND9" "BIND9" +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.SH "NAME" lwres_conf_init, lwres_conf_clear, lwres_conf_parse, lwres_conf_print, lwres_conf_get \- lightweight resolver configuration -.SH SYNOPSIS -\fB#include <lwres/lwres.h> -.sp -.na -void -lwres_conf_init(lwres_context_t *ctx); -.ad -.sp -.na -void -lwres_conf_clear(lwres_context_t *ctx); -.ad -.sp -.na -lwres_result_t -lwres_conf_parse(lwres_context_t *ctx, const char *filename); -.ad -.sp -.na -lwres_result_t -lwres_conf_print(lwres_context_t *ctx, FILE *fp); -.ad -.sp -.na -lwres_conf_t * -lwres_conf_get(lwres_context_t *ctx); -.ad -\fR +.SH "SYNOPSIS" +.nf +#include <lwres/lwres.h> +.fi +.HP 21 +\fBvoid\ \fBlwres_conf_init\fR\fR\fB(\fR\fBlwres_context_t\ *ctx\fR\fB);\fR +.HP 22 +\fBvoid\ \fBlwres_conf_clear\fR\fR\fB(\fR\fBlwres_context_t\ *ctx\fR\fB);\fR +.HP 32 +\fBlwres_result_t\ \fBlwres_conf_parse\fR\fR\fB(\fR\fBlwres_context_t\ *ctx\fR\fB, \fR\fBconst\ char\ *filename\fR\fB);\fR +.HP 32 +\fBlwres_result_t\ \fBlwres_conf_print\fR\fR\fB(\fR\fBlwres_context_t\ *ctx\fR\fB, \fR\fBFILE\ *fp\fR\fB);\fR +.HP 30 +\fBlwres_conf_t\ *\ \fBlwres_conf_get\fR\fR\fB(\fR\fBlwres_context_t\ *ctx\fR\fB);\fR .SH "DESCRIPTION" .PP \fBlwres_conf_init()\fR @@ -55,8 +51,7 @@ structure for lightweight resolver context \fIctx\fR. .PP \fBlwres_conf_clear()\fR -frees up all the internal memory used by -that +frees up all the internal memory used by that \fBlwres_conf_t\fR structure in resolver context \fIctx\fR. @@ -75,29 +70,24 @@ prints the structure for resolver context \fIctx\fR to the -\fBFILE\fR -\fIfp\fR. +\fBFILE\fR\fIfp\fR. .SH "RETURN VALUES" .PP \fBlwres_conf_parse()\fR returns -LWRES_R_SUCCESS +\fBLWRES_R_SUCCESS\fR if it successfully read and parsed -\fIfilename\fR. -It returns -LWRES_R_FAILURE +\fIfilename\fR. It returns +\fBLWRES_R_FAILURE\fR if \fIfilename\fR -could not be opened or contained incorrect -resolver statements. +could not be opened or contained incorrect resolver statements. .PP \fBlwres_conf_print()\fR returns -LWRES_R_SUCCESS -unless an error occurred when converting the network addresses to a -numeric host address string. -If this happens, the function returns -LWRES_R_FAILURE. +\fBLWRES_R_SUCCESS\fR +unless an error occurred when converting the network addresses to a numeric host address string. If this happens, the function returns +\fBLWRES_R_FAILURE\fR. .SH "SEE ALSO" .PP \fBstdio\fR(3), diff --git a/contrib/bind9/lib/lwres/man/lwres_config.docbook b/contrib/bind9/lib/lwres/man/lwres_config.docbook index eeb244e..03426be 100644 --- a/contrib/bind9/lib/lwres/man/lwres_config.docbook +++ b/contrib/bind9/lib/lwres/man/lwres_config.docbook @@ -1,7 +1,9 @@ -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.0//EN" + "http://www.oasis-open.org/docbook/xml/4.0/docbookx.dtd" + [<!ENTITY mdash "—">]> <!-- - - Copyright (C) 2004 Internet Systems Consortium, Inc. ("ISC") - - Copyright (C) 2001 Internet Software Consortium. + - Copyright (C) 2004, 2005 Internet Systems Consortium, Inc. ("ISC") + - Copyright (C) 2000, 2001 Internet Software Consortium. - - Permission to use, copy, modify, and distribute this software for any - purpose with or without fee is hereby granted, provided that the above @@ -16,7 +18,7 @@ - PERFORMANCE OF THIS SOFTWARE. --> -<!-- $Id: lwres_config.docbook,v 1.2.206.1 2004/03/06 08:15:37 marka Exp $ --> +<!-- $Id: lwres_config.docbook,v 1.2.206.3 2005/05/12 21:36:12 sra Exp $ --> <refentry> <refentryinfo> @@ -30,6 +32,19 @@ <refmiscinfo>BIND9</refmiscinfo> </refmeta> + <docinfo> + <copyright> + <year>2004</year> + <year>2005</year> + <holder>Internet Systems Consortium, Inc. ("ISC")</holder> + </copyright> + <copyright> + <year>2000</year> + <year>2001</year> + <holder>Internet Software Consortium.</holder> + </copyright> + </docinfo> + <refnamediv> <refname>lwres_conf_init</refname> <refname>lwres_conf_clear</refname> @@ -149,6 +164,7 @@ If this happens, the function returns <citerefentry> <refentrytitle>resolver</refentrytitle><manvolnum>5</manvolnum> </citerefentry>. +</para> </refsect1> <refsect1> <title>FILES</title> diff --git a/contrib/bind9/lib/lwres/man/lwres_config.html b/contrib/bind9/lib/lwres/man/lwres_config.html index cd7c63b..7ea416b 100644 --- a/contrib/bind9/lib/lwres/man/lwres_config.html +++ b/contrib/bind9/lib/lwres/man/lwres_config.html @@ -1,282 +1,166 @@ <!-- - - Copyright (C) 2004 Internet Systems Consortium, Inc. ("ISC") - - Copyright (C) 2001 Internet Software Consortium. - - + - Copyright (C) 2004, 2005 Internet Systems Consortium, Inc. ("ISC") + - Copyright (C) 2000, 2001 Internet Software Consortium. + - - Permission to use, copy, modify, and distribute this software for any - purpose with or without fee is hereby granted, provided that the above - copyright notice and this permission notice appear in all copies. - - + - - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY - - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT, + - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT, - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> - -<!-- $Id: lwres_config.html,v 1.4.2.1.4.2 2004/08/22 23:39:03 marka Exp $ --> - -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<HTML -><HEAD -><TITLE ->lwres_config</TITLE -><META -NAME="GENERATOR" -CONTENT="Modular DocBook HTML Stylesheet Version 1.7"></HEAD -><BODY -CLASS="REFENTRY" -BGCOLOR="#FFFFFF" -TEXT="#000000" -LINK="#0000FF" -VLINK="#840084" -ALINK="#0000FF" -><H1 -><A -NAME="AEN1" -></A ->lwres_config</H1 -><DIV -CLASS="REFNAMEDIV" -><A -NAME="AEN8" -></A -><H2 ->Name</H2 ->lwres_conf_init, lwres_conf_clear, lwres_conf_parse, lwres_conf_print, lwres_conf_get -- lightweight resolver configuration</DIV -><DIV -CLASS="REFSYNOPSISDIV" -><A -NAME="AEN15" -></A -><H2 ->Synopsis</H2 -><DIV -CLASS="FUNCSYNOPSIS" -><P -></P -><A -NAME="AEN16" -></A -><PRE -CLASS="FUNCSYNOPSISINFO" ->#include <lwres/lwres.h></PRE -><P -><CODE -><CODE -CLASS="FUNCDEF" ->void -lwres_conf_init</CODE ->(lwres_context_t *ctx);</CODE -></P -><P -><CODE -><CODE -CLASS="FUNCDEF" ->void -lwres_conf_clear</CODE ->(lwres_context_t *ctx);</CODE -></P -><P -><CODE -><CODE -CLASS="FUNCDEF" ->lwres_result_t -lwres_conf_parse</CODE ->(lwres_context_t *ctx, const char *filename);</CODE -></P -><P -><CODE -><CODE -CLASS="FUNCDEF" ->lwres_result_t -lwres_conf_print</CODE ->(lwres_context_t *ctx, FILE *fp);</CODE -></P -><P -><CODE -><CODE -CLASS="FUNCDEF" ->lwres_conf_t * -lwres_conf_get</CODE ->(lwres_context_t *ctx);</CODE -></P -><P -></P -></DIV -></DIV -><DIV -CLASS="REFSECT1" -><A -NAME="AEN40" -></A -><H2 ->DESCRIPTION</H2 -><P -><CODE -CLASS="FUNCTION" ->lwres_conf_init()</CODE -> +<!-- $Id: lwres_config.html,v 1.4.2.1.4.9 2005/10/13 02:33:55 marka Exp $ --> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> +<title>lwres_config</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.69.1"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"> +<a name="id2463721"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2>Name</h2> +<p>lwres_conf_init, lwres_conf_clear, lwres_conf_parse, lwres_conf_print, lwres_conf_get — lightweight resolver configuration</p> +</div> +<div class="refsynopsisdiv"> +<h2>Synopsis</h2> +<div class="funcsynopsis"> +<pre class="funcsynopsisinfo">#include <lwres/lwres.h></pre> +<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em"><tr> +<td><code class="funcdef"> +void +<b class="fsfunc">lwres_conf_init</b>(</code></td> +<td> </td> +<td> +<code>)</code>;</td> +</tr></table> +<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em"><tr> +<td><code class="funcdef"> +void +<b class="fsfunc">lwres_conf_clear</b>(</code></td> +<td> </td> +<td> +<code>)</code>;</td> +</tr></table> +<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em"> +<tr> +<td><code class="funcdef"> +lwres_result_t +<b class="fsfunc">lwres_conf_parse</b>(</code></td> +<td> </td> +<td>, </td> +</tr> +<tr> +<td> </td> +<td> </td> +<td> +<code>)</code>;</td> +</tr> +</table> +<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em"> +<tr> +<td><code class="funcdef"> +lwres_result_t +<b class="fsfunc">lwres_conf_print</b>(</code></td> +<td> </td> +<td>, </td> +</tr> +<tr> +<td> </td> +<td> </td> +<td> +<code>)</code>;</td> +</tr> +</table> +<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0"><tr> +<td><code class="funcdef"> +lwres_conf_t * +<b class="fsfunc">lwres_conf_get</b>(</code></td> +<td> </td> +<td> +<code>)</code>;</td> +</tr></table> +</div> +</div> +<div class="refsect1" lang="en"> +<a name="id2525910"></a><h2>DESCRIPTION</h2> +<p> +<code class="function">lwres_conf_init()</code> creates an empty -<SPAN -CLASS="TYPE" ->lwres_conf_t</SPAN -> +<span class="type">lwres_conf_t</span> structure for lightweight resolver context -<VAR -CLASS="PARAMETER" ->ctx</VAR ->.</P -><P -><CODE -CLASS="FUNCTION" ->lwres_conf_clear()</CODE -> +<em class="parameter"><code>ctx</code></em>. +</p> +<p> +<code class="function">lwres_conf_clear()</code> frees up all the internal memory used by that -<SPAN -CLASS="TYPE" ->lwres_conf_t</SPAN -> +<span class="type">lwres_conf_t</span> structure in resolver context -<VAR -CLASS="PARAMETER" ->ctx</VAR ->.</P -><P -><CODE -CLASS="FUNCTION" ->lwres_conf_parse()</CODE -> +<em class="parameter"><code>ctx</code></em>. +</p> +<p> +<code class="function">lwres_conf_parse()</code> opens the file -<VAR -CLASS="PARAMETER" ->filename</VAR -> +<em class="parameter"><code>filename</code></em> and parses it to initialise the resolver context -<VAR -CLASS="PARAMETER" ->ctx</VAR ->'s -<SPAN -CLASS="TYPE" ->lwres_conf_t</SPAN -> -structure.</P -><P -><CODE -CLASS="FUNCTION" ->lwres_conf_print()</CODE -> +<em class="parameter"><code>ctx</code></em>'s +<span class="type">lwres_conf_t</span> +structure. +</p> +<p> +<code class="function">lwres_conf_print()</code> prints the -<SPAN -CLASS="TYPE" ->lwres_conf_t</SPAN -> +<span class="type">lwres_conf_t</span> structure for resolver context -<VAR -CLASS="PARAMETER" ->ctx</VAR -> +<em class="parameter"><code>ctx</code></em> to the -<SPAN -CLASS="TYPE" ->FILE</SPAN -> -<VAR -CLASS="PARAMETER" ->fp</VAR ->.</P -></DIV -><DIV -CLASS="REFSECT1" -><A -NAME="AEN61" -></A -><H2 ->RETURN VALUES</H2 -><P -><CODE -CLASS="FUNCTION" ->lwres_conf_parse()</CODE -> +<span class="type">FILE</span> +<em class="parameter"><code>fp</code></em>. +</p> +</div> +<div class="refsect1" lang="en"> +<a name="id2525981"></a><h2>RETURN VALUES</h2> +<p> +<code class="function">lwres_conf_parse()</code> returns -<SPAN -CLASS="ERRORCODE" ->LWRES_R_SUCCESS</SPAN -> +<span class="errorcode">LWRES_R_SUCCESS</span> if it successfully read and parsed -<VAR -CLASS="PARAMETER" ->filename</VAR ->. +<em class="parameter"><code>filename</code></em>. It returns -<SPAN -CLASS="ERRORCODE" ->LWRES_R_FAILURE</SPAN -> +<span class="errorcode">LWRES_R_FAILURE</span> if -<VAR -CLASS="PARAMETER" ->filename</VAR -> +<em class="parameter"><code>filename</code></em> could not be opened or contained incorrect -resolver statements.</P -><P -><CODE -CLASS="FUNCTION" ->lwres_conf_print()</CODE -> +resolver statements. +</p> +<p> +<code class="function">lwres_conf_print()</code> returns -<SPAN -CLASS="ERRORCODE" ->LWRES_R_SUCCESS</SPAN -> +<span class="errorcode">LWRES_R_SUCCESS</span> unless an error occurred when converting the network addresses to a numeric host address string. If this happens, the function returns -<SPAN -CLASS="ERRORCODE" ->LWRES_R_FAILURE</SPAN ->.</P -></DIV -><DIV -CLASS="REFSECT1" -><A -NAME="AEN73" -></A -><H2 ->SEE ALSO</H2 -><P -><SPAN -CLASS="CITEREFENTRY" -><SPAN -CLASS="REFENTRYTITLE" ->stdio</SPAN ->(3)</SPAN ->, -<SPAN -CLASS="CITEREFENTRY" -><SPAN -CLASS="REFENTRYTITLE" ->resolver</SPAN ->(5)</SPAN ->.</P -></DIV -><DIV -CLASS="REFSECT1" -><A -NAME="AEN82" -></A -><H2 ->FILES</H2 -><P -><TT -CLASS="FILENAME" ->/etc/resolv.conf</TT -></P -></DIV -></BODY -></HTML -> +<span class="errorcode">LWRES_R_FAILURE</span>. +</p> +</div> +<div class="refsect1" lang="en"> +<a name="id2526021"></a><h2>SEE ALSO</h2> +<p> +<span class="citerefentry"><span class="refentrytitle">stdio</span>(3)</span>, +<span class="citerefentry"><span class="refentrytitle">resolver</span>(5)</span>. +</p> +</div> +<div class="refsect1" lang="en"> +<a name="id2526048"></a><h2>FILES</h2> +<p> +<code class="filename">/etc/resolv.conf</code> +</p> +</div> +</div></body> +</html> diff --git a/contrib/bind9/lib/lwres/man/lwres_context.3 b/contrib/bind9/lib/lwres/man/lwres_context.3 index d19b18a..be8cd38 100644 --- a/contrib/bind9/lib/lwres/man/lwres_context.3 +++ b/contrib/bind9/lib/lwres/man/lwres_context.3 @@ -1,103 +1,82 @@ -.\" Copyright (C) 2004 Internet Systems Consortium, Inc. ("ISC") -.\" Copyright (C) 2000, 2001 Internet Software Consortium. -.\" +.\" Copyright (C) 2004, 2005 Internet Systems Consortium, Inc. ("ISC") +.\" Copyright (C) 2000, 2001, 2003 Internet Software Consortium. +.\" .\" Permission to use, copy, modify, and distribute this software for any .\" purpose with or without fee is hereby granted, provided that the above .\" copyright notice and this permission notice appear in all copies. -.\" +.\" .\" THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH .\" REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY -.\" AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT, +.\" AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT, .\" INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM .\" LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE .\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR .\" PERFORMANCE OF THIS SOFTWARE. .\" -.\" $Id: lwres_context.3,v 1.13.2.2.2.2 2004/03/08 09:05:12 marka Exp $ +.\" $Id: lwres_context.3,v 1.13.2.2.2.6 2005/10/13 02:33:52 marka Exp $ .\" -.TH "LWRES_CONTEXT" "3" "Jun 30, 2000" "BIND9" "" -.SH NAME +.hy 0 +.ad l +.\" ** You probably do not want to edit this file directly ** +.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1). +.\" Instead of manually editing it, you probably should edit the DocBook XML +.\" source for it and then use the DocBook XSL Stylesheets to regenerate it. +.TH "LWRES_CONTEXT" "3" "Jun 30, 2000" "BIND9" "BIND9" +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.SH "NAME" 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 -.SH SYNOPSIS -\fB#include <lwres/lwres.h> -.sp -.na -lwres_result_t -lwres_context_create(lwres_context_t **contextp, void *arg, lwres_malloc_t malloc_function, lwres_free_t free_function); -.ad -.sp -.na -lwres_result_t -lwres_context_destroy(lwres_context_t **contextp); -.ad -.sp -.na -void -lwres_context_initserial(lwres_context_t *ctx, lwres_uint32_t serial); -.ad -.sp -.na -lwres_uint32_t -lwres_context_nextserial(lwres_context_t *ctx); -.ad -.sp -.na -void -lwres_context_freemem(lwres_context_t *ctx, void *mem, size_t len); -.ad -.sp -.na -void -lwres_context_allocmem(lwres_context_t *ctx, size_t len); -.ad -.sp -.na -void * -lwres_context_sendrecv(lwres_context_t *ctx, void *sendbase, int sendlen, void *recvbase, int recvlen, int *recvd_len); -.ad -\fR +.SH "SYNOPSIS" +.nf +#include <lwres/lwres.h> +.fi +.HP 36 +\fBlwres_result_t\ \fBlwres_context_create\fR\fR\fB(\fR\fBlwres_context_t\ **contextp\fR\fB, \fR\fBvoid\ *arg\fR\fB, \fR\fBlwres_malloc_t\ malloc_function\fR\fB, \fR\fBlwres_free_t\ free_function\fR\fB);\fR +.HP 37 +\fBlwres_result_t\ \fBlwres_context_destroy\fR\fR\fB(\fR\fBlwres_context_t\ **contextp\fR\fB);\fR +.HP 30 +\fBvoid\ \fBlwres_context_initserial\fR\fR\fB(\fR\fBlwres_context_t\ *ctx\fR\fB, \fR\fBlwres_uint32_t\ serial\fR\fB);\fR +.HP 40 +\fBlwres_uint32_t\ \fBlwres_context_nextserial\fR\fR\fB(\fR\fBlwres_context_t\ *ctx\fR\fB);\fR +.HP 27 +\fBvoid\ \fBlwres_context_freemem\fR\fR\fB(\fR\fBlwres_context_t\ *ctx\fR\fB, \fR\fBvoid\ *mem\fR\fB, \fR\fBsize_t\ len\fR\fB);\fR +.HP 28 +\fBvoid\ \fBlwres_context_allocmem\fR\fR\fB(\fR\fBlwres_context_t\ *ctx\fR\fB, \fR\fBsize_t\ len\fR\fB);\fR +.HP 30 +\fBvoid\ *\ \fBlwres_context_sendrecv\fR\fR\fB(\fR\fBlwres_context_t\ *ctx\fR\fB, \fR\fBvoid\ *sendbase\fR\fB, \fR\fBint\ sendlen\fR\fB, \fR\fBvoid\ *recvbase\fR\fB, \fR\fBint\ recvlen\fR\fB, \fR\fBint\ *recvd_len\fR\fB);\fR .SH "DESCRIPTION" .PP \fBlwres_context_create()\fR creates a \fBlwres_context_t\fR -structure for use in lightweight resolver operations. -It holds a socket and other data needed for communicating -with a resolver daemon. -The new +structure for use in lightweight resolver operations. It holds a socket and other data needed for communicating with a resolver daemon. The new \fBlwres_context_t\fR is returned through -\fIcontextp\fR, -a pointer to a +\fIcontextp\fR, a pointer to a \fBlwres_context_t\fR -pointer. This +pointer. This \fBlwres_context_t\fR -pointer must initially be NULL, and is modified -to point to the newly created +pointer must initially be NULL, and is modified to point to the newly created \fBlwres_context_t\fR. .PP -When the lightweight resolver needs to perform dynamic memory -allocation, it will call +When the lightweight resolver needs to perform dynamic memory allocation, it will call \fImalloc_function\fR to allocate memory and \fIfree_function\fR -to free it. If +to free it. If \fImalloc_function\fR and \fIfree_function\fR -are NULL, memory is allocated using -\&.Xr malloc 3 -and -\fBfree\fR(3). -It is not permitted to have a NULL +are NULL, memory is allocated using .Xr malloc 3 and +\fBfree\fR(3). It is not permitted to have a NULL \fImalloc_function\fR -and a non-NULL +and a non\-NULL \fIfree_function\fR or vice versa. \fIarg\fR -is passed as the first parameter to the memory -allocation functions. -If +is passed as the first parameter to the memory allocation functions. If \fImalloc_function\fR and \fIfree_function\fR @@ -105,23 +84,18 @@ are NULL, \fIarg\fR is unused and should be passed as NULL. .PP -Once memory for the structure has been allocated, -it is initialized using +Once memory for the structure has been allocated, it is initialized using \fBlwres_conf_init\fR(3) and returned via \fI*contextp\fR. .PP \fBlwres_context_destroy()\fR -destroys a -\fBlwres_context_t\fR, -closing its socket. +destroys a +\fBlwres_context_t\fR, closing its socket. \fIcontextp\fR -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. +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. .PP -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 +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 \fBlwres_context_initserial()\fR and \fBlwres_context_nextserial()\fR. @@ -136,15 +110,12 @@ increments the serial number and returns the previous value. Memory for a lightweight resolver context is allocated and freed using \fBlwres_context_allocmem()\fR and -\fBlwres_context_freemem()\fR. -These use whatever allocations were defined when the context was -created with +\fBlwres_context_freemem()\fR. These use whatever allocations were defined when the context was created with \fBlwres_context_create()\fR. \fBlwres_context_allocmem()\fR allocates \fIlen\fR -bytes of memory and if successful returns a pointer to the allocated -storage. +bytes of memory and if successful returns a pointer to the allocated storage. \fBlwres_context_freemem()\fR frees \fIlen\fR @@ -153,39 +124,33 @@ bytes of space starting at location .PP \fBlwres_context_sendrecv()\fR performs I/O for the context -\fIctx\fR. -Data are read and written from the context's socket. -It writes data from +\fIctx\fR. Data are read and written from the context's socket. It writes data from \fIsendbase\fR -\(em typically a lightweight resolver query packet \(em -and waits for a reply which is copied to the receive buffer at -\fIrecvbase\fR. -The number of bytes that were written to this receive buffer is -returned in +\(em typically a lightweight resolver query packet \(em and waits for a reply which is copied to the receive buffer at +\fIrecvbase\fR. The number of bytes that were written to this receive buffer is returned in \fI*recvd_len\fR. .SH "RETURN VALUES" .PP \fBlwres_context_create()\fR returns -LWRES_R_NOMEMORY +\fBLWRES_R_NOMEMORY\fR if memory for the \fBstruct lwres_context\fR -could not be allocated, -LWRES_R_SUCCESS +could not be allocated, +\fBLWRES_R_SUCCESS\fR otherwise. .PP Successful calls to the memory allocator \fBlwres_context_allocmem()\fR -return a pointer to the start of the allocated space. -It returns NULL if memory could not be allocated. +return a pointer to the start of the allocated space. It returns NULL if memory could not be allocated. .PP -LWRES_R_SUCCESS +\fBLWRES_R_SUCCESS\fR is returned when \fBlwres_context_sendrecv()\fR completes successfully. -LWRES_R_IOERROR +\fBLWRES_R_IOERROR\fR is returned if an I/O error occurs and -LWRES_R_TIMEOUT +\fBLWRES_R_TIMEOUT\fR is returned if \fBlwres_context_sendrecv()\fR times out waiting for a response. @@ -193,4 +158,4 @@ times out waiting for a response. .PP \fBlwres_conf_init\fR(3), \fBmalloc\fR(3), -\fBfree\fR(3). +\fBfree\fR(3 ). diff --git a/contrib/bind9/lib/lwres/man/lwres_context.docbook b/contrib/bind9/lib/lwres/man/lwres_context.docbook index 137e4bc..48d4336 100644 --- a/contrib/bind9/lib/lwres/man/lwres_context.docbook +++ b/contrib/bind9/lib/lwres/man/lwres_context.docbook @@ -1,7 +1,9 @@ -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.0//EN" + "http://www.oasis-open.org/docbook/xml/4.0/docbookx.dtd" + [<!ENTITY mdash "—">]> <!-- - - Copyright (C) 2004 Internet Systems Consortium, Inc. ("ISC") - - Copyright (C) 2001, 2003 Internet Software Consortium. + - Copyright (C) 2004, 2005 Internet Systems Consortium, Inc. ("ISC") + - Copyright (C) 2000, 2001, 2003 Internet Software Consortium. - - Permission to use, copy, modify, and distribute this software for any - purpose with or without fee is hereby granted, provided that the above @@ -16,7 +18,7 @@ - PERFORMANCE OF THIS SOFTWARE. --> -<!-- $Id: lwres_context.docbook,v 1.3.2.2.2.1 2004/03/06 08:15:38 marka Exp $ --> +<!-- $Id: lwres_context.docbook,v 1.3.2.2.2.3 2005/05/12 21:36:12 sra Exp $ --> <refentry> <refentryinfo> @@ -29,6 +31,21 @@ <manvolnum>3</manvolnum> <refmiscinfo>BIND9</refmiscinfo> </refmeta> + + <docinfo> + <copyright> + <year>2004</year> + <year>2005</year> + <holder>Internet Systems Consortium, Inc. ("ISC")</holder> + </copyright> + <copyright> + <year>2000</year> + <year>2001</year> + <year>2003</year> + <holder>Internet Software Consortium.</holder> + </copyright> + </docinfo> + <refnamediv> <refname>lwres_context_create</refname> <refname>lwres_context_destroy</refname> diff --git a/contrib/bind9/lib/lwres/man/lwres_context.html b/contrib/bind9/lib/lwres/man/lwres_context.html index cca12d7..8988c5d 100644 --- a/contrib/bind9/lib/lwres/man/lwres_context.html +++ b/contrib/bind9/lib/lwres/man/lwres_context.html @@ -1,478 +1,335 @@ <!-- - - Copyright (C) 2004 Internet Systems Consortium, Inc. ("ISC") - - Copyright (C) 2001 Internet Software Consortium. - - + - Copyright (C) 2004, 2005 Internet Systems Consortium, Inc. ("ISC") + - Copyright (C) 2000, 2001, 2003 Internet Software Consortium. + - - Permission to use, copy, modify, and distribute this software for any - purpose with or without fee is hereby granted, provided that the above - copyright notice and this permission notice appear in all copies. - - + - - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY - - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT, + - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT, - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> - -<!-- $Id: lwres_context.html,v 1.5.2.2.2.3 2004/08/22 23:39:03 marka Exp $ --> - -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<HTML -><HEAD -><TITLE ->lwres_context</TITLE -><META -NAME="GENERATOR" -CONTENT="Modular DocBook HTML Stylesheet Version 1.7"></HEAD -><BODY -CLASS="REFENTRY" -BGCOLOR="#FFFFFF" -TEXT="#000000" -LINK="#0000FF" -VLINK="#840084" -ALINK="#0000FF" -><H1 -><A -NAME="AEN1" -></A ->lwres_context</H1 -><DIV -CLASS="REFNAMEDIV" -><A -NAME="AEN8" -></A -><H2 ->Name</H2 ->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</DIV -><DIV -CLASS="REFSYNOPSISDIV" -><A -NAME="AEN17" -></A -><H2 ->Synopsis</H2 -><DIV -CLASS="FUNCSYNOPSIS" -><P -></P -><A -NAME="AEN18" -></A -><PRE -CLASS="FUNCSYNOPSISINFO" ->#include <lwres/lwres.h></PRE -><P -><CODE -><CODE -CLASS="FUNCDEF" ->lwres_result_t -lwres_context_create</CODE ->(lwres_context_t **contextp, void *arg, lwres_malloc_t malloc_function, lwres_free_t free_function);</CODE -></P -><P -><CODE -><CODE -CLASS="FUNCDEF" ->lwres_result_t -lwres_context_destroy</CODE ->(lwres_context_t **contextp);</CODE -></P -><P -><CODE -><CODE -CLASS="FUNCDEF" ->void -lwres_context_initserial</CODE ->(lwres_context_t *ctx, lwres_uint32_t serial);</CODE -></P -><P -><CODE -><CODE -CLASS="FUNCDEF" ->lwres_uint32_t -lwres_context_nextserial</CODE ->(lwres_context_t *ctx);</CODE -></P -><P -><CODE -><CODE -CLASS="FUNCDEF" ->void -lwres_context_freemem</CODE ->(lwres_context_t *ctx, void *mem, size_t len);</CODE -></P -><P -><CODE -><CODE -CLASS="FUNCDEF" ->void -lwres_context_allocmem</CODE ->(lwres_context_t *ctx, size_t len);</CODE -></P -><P -><CODE -><CODE -CLASS="FUNCDEF" ->void * -lwres_context_sendrecv</CODE ->(lwres_context_t *ctx, void *sendbase, int sendlen, void *recvbase, int recvlen, int *recvd_len);</CODE -></P -><P -></P -></DIV -></DIV -><DIV -CLASS="REFSECT1" -><A -NAME="AEN60" -></A -><H2 ->DESCRIPTION</H2 -><P -><CODE -CLASS="FUNCTION" ->lwres_context_create()</CODE -> +<!-- $Id: lwres_context.html,v 1.5.2.2.2.10 2005/10/13 02:33:55 marka Exp $ --> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> +<title>lwres_context</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.69.1"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"> +<a name="id2463721"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2>Name</h2> +<p>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</p> +</div> +<div class="refsynopsisdiv"> +<h2>Synopsis</h2> +<div class="funcsynopsis"> +<pre class="funcsynopsisinfo">#include <lwres/lwres.h></pre> +<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em"> +<tr> +<td><code class="funcdef"> +lwres_result_t +<b class="fsfunc">lwres_context_create</b>(</code></td> +<td> </td> +<td>, </td> +</tr> +<tr> +<td> </td> +<td> </td> +<td>, </td> +</tr> +<tr> +<td> </td> +<td> </td> +<td>, </td> +</tr> +<tr> +<td> </td> +<td> </td> +<td> +<code>)</code>;</td> +</tr> +</table> +<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em"><tr> +<td><code class="funcdef"> +lwres_result_t +<b class="fsfunc">lwres_context_destroy</b>(</code></td> +<td> </td> +<td> +<code>)</code>;</td> +</tr></table> +<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em"> +<tr> +<td><code class="funcdef"> +void +<b class="fsfunc">lwres_context_initserial</b>(</code></td> +<td> </td> +<td>, </td> +</tr> +<tr> +<td> </td> +<td> </td> +<td> +<code>)</code>;</td> +</tr> +</table> +<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em"><tr> +<td><code class="funcdef"> +lwres_uint32_t +<b class="fsfunc">lwres_context_nextserial</b>(</code></td> +<td> </td> +<td> +<code>)</code>;</td> +</tr></table> +<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em"> +<tr> +<td><code class="funcdef"> +void +<b class="fsfunc">lwres_context_freemem</b>(</code></td> +<td> </td> +<td>, </td> +</tr> +<tr> +<td> </td> +<td> </td> +<td>, </td> +</tr> +<tr> +<td> </td> +<td> </td> +<td> +<code>)</code>;</td> +</tr> +</table> +<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em"> +<tr> +<td><code class="funcdef"> +void +<b class="fsfunc">lwres_context_allocmem</b>(</code></td> +<td> </td> +<td>, </td> +</tr> +<tr> +<td> </td> +<td> </td> +<td> +<code>)</code>;</td> +</tr> +</table> +<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0"> +<tr> +<td><code class="funcdef"> +void * +<b class="fsfunc">lwres_context_sendrecv</b>(</code></td> +<td> </td> +<td>, </td> +</tr> +<tr> +<td> </td> +<td> </td> +<td>, </td> +</tr> +<tr> +<td> </td> +<td> </td> +<td>, </td> +</tr> +<tr> +<td> </td> +<td> </td> +<td>, </td> +</tr> +<tr> +<td> </td> +<td> </td> +<td>, </td> +</tr> +<tr> +<td> </td> +<td> </td> +<td> +<code>)</code>;</td> +</tr> +</table> +</div> +</div> +<div class="refsect1" lang="en"> +<a name="id2525975"></a><h2>DESCRIPTION</h2> +<p> +<code class="function">lwres_context_create()</code> creates a -<SPAN -CLASS="TYPE" ->lwres_context_t</SPAN -> +<span class="type">lwres_context_t</span> structure for use in lightweight resolver operations. It holds a socket and other data needed for communicating with a resolver daemon. The new -<SPAN -CLASS="TYPE" ->lwres_context_t</SPAN -> +<span class="type">lwres_context_t</span> is returned through -<VAR -CLASS="PARAMETER" ->contextp</VAR ->, +<em class="parameter"><code>contextp</code></em>, a pointer to a -<SPAN -CLASS="TYPE" ->lwres_context_t</SPAN -> +<span class="type">lwres_context_t</span> pointer. This -<SPAN -CLASS="TYPE" ->lwres_context_t</SPAN -> +<span class="type">lwres_context_t</span> pointer must initially be NULL, and is modified to point to the newly created -<SPAN -CLASS="TYPE" ->lwres_context_t</SPAN ->. </P -><P ->When the lightweight resolver needs to perform dynamic memory +<span class="type">lwres_context_t</span>. + +</p> +<p> +When the lightweight resolver needs to perform dynamic memory allocation, it will call -<VAR -CLASS="PARAMETER" ->malloc_function</VAR -> +<em class="parameter"><code>malloc_function</code></em> to allocate memory and -<VAR -CLASS="PARAMETER" ->free_function</VAR -> +<em class="parameter"><code>free_function</code></em> to free it. If -<VAR -CLASS="PARAMETER" ->malloc_function</VAR -> +<em class="parameter"><code>malloc_function</code></em> and -<VAR -CLASS="PARAMETER" ->free_function</VAR -> +<em class="parameter"><code>free_function</code></em> are NULL, memory is allocated using .Xr malloc 3 and -<SPAN -CLASS="CITEREFENTRY" -><SPAN -CLASS="REFENTRYTITLE" ->free</SPAN ->(3)</SPAN ->. +<span class="citerefentry"><span class="refentrytitle">free</span>(3)</span>. It is not permitted to have a NULL -<VAR -CLASS="PARAMETER" ->malloc_function</VAR -> +<em class="parameter"><code>malloc_function</code></em> and a non-NULL -<VAR -CLASS="PARAMETER" ->free_function</VAR -> +<em class="parameter"><code>free_function</code></em> or vice versa. -<VAR -CLASS="PARAMETER" ->arg</VAR -> +<em class="parameter"><code>arg</code></em> is passed as the first parameter to the memory allocation functions. If -<VAR -CLASS="PARAMETER" ->malloc_function</VAR -> +<em class="parameter"><code>malloc_function</code></em> and -<VAR -CLASS="PARAMETER" ->free_function</VAR -> +<em class="parameter"><code>free_function</code></em> are NULL, -<VAR -CLASS="PARAMETER" ->arg</VAR -> +<em class="parameter"><code>arg</code></em> -is unused and should be passed as NULL.</P -><P ->Once memory for the structure has been allocated, +is unused and should be passed as NULL. +</p> +<p> +Once memory for the structure has been allocated, it is initialized using -<SPAN -CLASS="CITEREFENTRY" -><SPAN -CLASS="REFENTRYTITLE" ->lwres_conf_init</SPAN ->(3)</SPAN -> +<span class="citerefentry"><span class="refentrytitle">lwres_conf_init</span>(3)</span> and returned via -<VAR -CLASS="PARAMETER" ->*contextp</VAR ->. </P -><P -><CODE -CLASS="FUNCTION" ->lwres_context_destroy()</CODE -> +<em class="parameter"><code>*contextp</code></em>. + +</p> +<p> +<code class="function">lwres_context_destroy()</code> destroys a -<SPAN -CLASS="TYPE" ->lwres_context_t</SPAN ->, +<span class="type">lwres_context_t</span>, closing its socket. -<VAR -CLASS="PARAMETER" ->contextp</VAR -> +<em class="parameter"><code>contextp</code></em> 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.</P -><P ->The context holds a serial number that is used to identify resolver +The pointer will be set to NULL when the context has been destroyed. +</p> +<p> +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 -<CODE -CLASS="FUNCTION" ->lwres_context_initserial()</CODE -> +<code class="function">lwres_context_initserial()</code> and -<CODE -CLASS="FUNCTION" ->lwres_context_nextserial()</CODE ->. -<CODE -CLASS="FUNCTION" ->lwres_context_initserial()</CODE -> +<code class="function">lwres_context_nextserial()</code>. +<code class="function">lwres_context_initserial()</code> sets the serial number for context -<VAR -CLASS="PARAMETER" ->*ctx</VAR -> +<em class="parameter"><code>*ctx</code></em> to -<VAR -CLASS="PARAMETER" ->serial</VAR ->. +<em class="parameter"><code>serial</code></em>. -<CODE -CLASS="FUNCTION" ->lwres_context_nextserial()</CODE -> -increments the serial number and returns the previous value.</P -><P ->Memory for a lightweight resolver context is allocated and freed using -<CODE -CLASS="FUNCTION" ->lwres_context_allocmem()</CODE -> +<code class="function">lwres_context_nextserial()</code> +increments the serial number and returns the previous value. +</p> +<p> +Memory for a lightweight resolver context is allocated and freed using +<code class="function">lwres_context_allocmem()</code> and -<CODE -CLASS="FUNCTION" ->lwres_context_freemem()</CODE ->. +<code class="function">lwres_context_freemem()</code>. These use whatever allocations were defined when the context was created with -<CODE -CLASS="FUNCTION" ->lwres_context_create()</CODE ->. -<CODE -CLASS="FUNCTION" ->lwres_context_allocmem()</CODE -> +<code class="function">lwres_context_create()</code>. +<code class="function">lwres_context_allocmem()</code> allocates -<VAR -CLASS="PARAMETER" ->len</VAR -> +<em class="parameter"><code>len</code></em> bytes of memory and if successful returns a pointer to the allocated storage. -<CODE -CLASS="FUNCTION" ->lwres_context_freemem()</CODE -> +<code class="function">lwres_context_freemem()</code> frees -<VAR -CLASS="PARAMETER" ->len</VAR -> +<em class="parameter"><code>len</code></em> bytes of space starting at location -<VAR -CLASS="PARAMETER" ->mem</VAR ->. </P -><P -><CODE -CLASS="FUNCTION" ->lwres_context_sendrecv()</CODE -> +<em class="parameter"><code>mem</code></em>. + +</p> +<p> +<code class="function">lwres_context_sendrecv()</code> performs I/O for the context -<VAR -CLASS="PARAMETER" ->ctx</VAR ->. +<em class="parameter"><code>ctx</code></em>. Data are read and written from the context's socket. It writes data from -<VAR -CLASS="PARAMETER" ->sendbase</VAR -> -— typically a lightweight resolver query packet — +<em class="parameter"><code>sendbase</code></em> +— typically a lightweight resolver query packet — and waits for a reply which is copied to the receive buffer at -<VAR -CLASS="PARAMETER" ->recvbase</VAR ->. +<em class="parameter"><code>recvbase</code></em>. The number of bytes that were written to this receive buffer is returned in -<VAR -CLASS="PARAMETER" ->*recvd_len</VAR ->. </P -></DIV -><DIV -CLASS="REFSECT1" -><A -NAME="AEN115" -></A -><H2 ->RETURN VALUES</H2 -><P -><CODE -CLASS="FUNCTION" ->lwres_context_create()</CODE -> +<em class="parameter"><code>*recvd_len</code></em>. + +</p> +</div> +<div class="refsect1" lang="en"> +<a name="id2526156"></a><h2>RETURN VALUES</h2> +<p> +<code class="function">lwres_context_create()</code> returns -<SPAN -CLASS="ERRORCODE" ->LWRES_R_NOMEMORY</SPAN -> +<span class="errorcode">LWRES_R_NOMEMORY</span> if memory for the -<SPAN -CLASS="TYPE" ->struct lwres_context</SPAN -> +<span class="type">struct lwres_context</span> could not be allocated, -<SPAN -CLASS="ERRORCODE" ->LWRES_R_SUCCESS</SPAN -> -otherwise.</P -><P ->Successful calls to the memory allocator -<CODE -CLASS="FUNCTION" ->lwres_context_allocmem()</CODE -> +<span class="errorcode">LWRES_R_SUCCESS</span> +otherwise. +</p> +<p> +Successful calls to the memory allocator +<code class="function">lwres_context_allocmem()</code> return a pointer to the start of the allocated space. -It returns NULL if memory could not be allocated.</P -><P -><SPAN -CLASS="ERRORCODE" ->LWRES_R_SUCCESS</SPAN -> +It returns NULL if memory could not be allocated. +</p> +<p> +<span class="errorcode">LWRES_R_SUCCESS</span> is returned when -<CODE -CLASS="FUNCTION" ->lwres_context_sendrecv()</CODE -> +<code class="function">lwres_context_sendrecv()</code> completes successfully. -<SPAN -CLASS="ERRORCODE" ->LWRES_R_IOERROR</SPAN -> +<span class="errorcode">LWRES_R_IOERROR</span> is returned if an I/O error occurs and -<SPAN -CLASS="ERRORCODE" ->LWRES_R_TIMEOUT</SPAN -> +<span class="errorcode">LWRES_R_TIMEOUT</span> is returned if -<CODE -CLASS="FUNCTION" ->lwres_context_sendrecv()</CODE -> -times out waiting for a response.</P -></DIV -><DIV -CLASS="REFSECT1" -><A -NAME="AEN130" -></A -><H2 ->SEE ALSO</H2 -><P -><SPAN -CLASS="CITEREFENTRY" -><SPAN -CLASS="REFENTRYTITLE" ->lwres_conf_init</SPAN ->(3)</SPAN ->, +<code class="function">lwres_context_sendrecv()</code> +times out waiting for a response. +</p> +</div> +<div class="refsect1" lang="en"> +<a name="id2526208"></a><h2>SEE ALSO</h2> +<p> +<span class="citerefentry"><span class="refentrytitle">lwres_conf_init</span>(3)</span>, -<SPAN -CLASS="CITEREFENTRY" -><SPAN -CLASS="REFENTRYTITLE" ->malloc</SPAN ->(3)</SPAN ->, +<span class="citerefentry"><span class="refentrytitle">malloc</span>(3)</span>, -<SPAN -CLASS="CITEREFENTRY" -><SPAN -CLASS="REFENTRYTITLE" ->free</SPAN ->(3)</SPAN ->.</P -></DIV -></BODY -></HTML -> +<span class="citerefentry"><span class="refentrytitle">free</span>(3 +)</span>. +</p> +</div> +</div></body> +</html> diff --git a/contrib/bind9/lib/lwres/man/lwres_gabn.3 b/contrib/bind9/lib/lwres/man/lwres_gabn.3 index a309f3e..60a56fe 100644 --- a/contrib/bind9/lib/lwres/man/lwres_gabn.3 +++ b/contrib/bind9/lib/lwres/man/lwres_gabn.3 @@ -1,91 +1,72 @@ -.\" Copyright (C) 2004 Internet Systems Consortium, Inc. ("ISC") -.\" Copyright (C) 2000, 2001 Internet Software Consortium. -.\" +.\" Copyright (C) 2004, 2005 Internet Systems Consortium, Inc. ("ISC") +.\" Copyright (C) 2000, 2001 Internet Software Consortium. +.\" .\" Permission to use, copy, modify, and distribute this software for any .\" purpose with or without fee is hereby granted, provided that the above .\" copyright notice and this permission notice appear in all copies. -.\" +.\" .\" THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH .\" REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY -.\" AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT, +.\" AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT, .\" INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM .\" LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE .\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR .\" PERFORMANCE OF THIS SOFTWARE. .\" -.\" $Id: lwres_gabn.3,v 1.13.2.1.8.1 2004/03/06 07:41:42 marka Exp $ +.\" $Id: lwres_gabn.3,v 1.13.2.1.8.5 2005/10/13 02:33:52 marka Exp $ .\" -.TH "LWRES_GABN" "3" "Jun 30, 2000" "BIND9" "" -.SH NAME +.hy 0 +.ad l +.\" ** You probably do not want to edit this file directly ** +.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1). +.\" Instead of manually editing it, you probably should edit the DocBook XML +.\" source for it and then use the DocBook XSL Stylesheets to regenerate it. +.TH "LWRES_GABN" "3" "Jun 30, 2000" "BIND9" "BIND9" +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.SH "NAME" lwres_gabnrequest_render, lwres_gabnresponse_render, lwres_gabnrequest_parse, lwres_gabnresponse_parse, lwres_gabnresponse_free, lwres_gabnrequest_free \- lightweight resolver getaddrbyname message handling -.SH SYNOPSIS -\fB#include <lwres/lwres.h> -.sp -.na -lwres_result_t -lwres_gabnrequest_render(lwres_context_t *ctx, lwres_gabnrequest_t *req, lwres_lwpacket_t *pkt, lwres_buffer_t *b); -.ad -.sp -.na -lwres_result_t -lwres_gabnresponse_render(lwres_context_t *ctx, lwres_gabnresponse_t *req, lwres_lwpacket_t *pkt, lwres_buffer_t *b); -.ad -.sp -.na -lwres_result_t -lwres_gabnrequest_parse(lwres_context_t *ctx, lwres_buffer_t *b, lwres_lwpacket_t *pkt, lwres_gabnrequest_t **structp); -.ad -.sp -.na -lwres_result_t -lwres_gabnresponse_parse(lwres_context_t *ctx, lwres_buffer_t *b, lwres_lwpacket_t *pkt, lwres_gabnresponse_t **structp); -.ad -.sp -.na -void -lwres_gabnresponse_free(lwres_context_t *ctx, lwres_gabnresponse_t **structp); -.ad -.sp -.na -void -lwres_gabnrequest_free(lwres_context_t *ctx, lwres_gabnrequest_t **structp); -.ad -\fR +.SH "SYNOPSIS" +.nf +#include <lwres/lwres.h> +.fi +.HP 40 +\fBlwres_result_t\ \fBlwres_gabnrequest_render\fR\fR\fB(\fR\fBlwres_context_t\ *ctx\fR\fB, \fR\fBlwres_gabnrequest_t\ *req\fR\fB, \fR\fBlwres_lwpacket_t\ *pkt\fR\fB, \fR\fBlwres_buffer_t\ *b\fR\fB);\fR +.HP 41 +\fBlwres_result_t\ \fBlwres_gabnresponse_render\fR\fR\fB(\fR\fBlwres_context_t\ *ctx\fR\fB, \fR\fBlwres_gabnresponse_t\ *req\fR\fB, \fR\fBlwres_lwpacket_t\ *pkt\fR\fB, \fR\fBlwres_buffer_t\ *b\fR\fB);\fR +.HP 39 +\fBlwres_result_t\ \fBlwres_gabnrequest_parse\fR\fR\fB(\fR\fBlwres_context_t\ *ctx\fR\fB, \fR\fBlwres_buffer_t\ *b\fR\fB, \fR\fBlwres_lwpacket_t\ *pkt\fR\fB, \fR\fBlwres_gabnrequest_t\ **structp\fR\fB);\fR +.HP 40 +\fBlwres_result_t\ \fBlwres_gabnresponse_parse\fR\fR\fB(\fR\fBlwres_context_t\ *ctx\fR\fB, \fR\fBlwres_buffer_t\ *b\fR\fB, \fR\fBlwres_lwpacket_t\ *pkt\fR\fB, \fR\fBlwres_gabnresponse_t\ **structp\fR\fB);\fR +.HP 29 +\fBvoid\ \fBlwres_gabnresponse_free\fR\fR\fB(\fR\fBlwres_context_t\ *ctx\fR\fB, \fR\fBlwres_gabnresponse_t\ **structp\fR\fB);\fR +.HP 28 +\fBvoid\ \fBlwres_gabnrequest_free\fR\fR\fB(\fR\fBlwres_context_t\ *ctx\fR\fB, \fR\fBlwres_gabnrequest_t\ **structp\fR\fB);\fR .SH "DESCRIPTION" .PP -These are low-level routines for creating and parsing -lightweight resolver name-to-address lookup request and -response messages. +These are low\-level routines for creating and parsing lightweight resolver name\-to\-address lookup request and response messages. .PP -There are four main functions for the getaddrbyname opcode. -One render function converts a getaddrbyname request structure \(em -\fBlwres_gabnrequest_t\fR \(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 -\fBlwres_gabnresponse_t\fR \(em -to the canonical format. -This is complemented by a parse function which converts a packet in -canonical format to a getaddrbyname response structure. +There are four main functions for the getaddrbyname opcode. One render function converts a getaddrbyname request structure \(em +\fBlwres_gabnrequest_t\fR +\(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 +\fBlwres_gabnresponse_t\fR +\(em to the canonical format. This is complemented by a parse function which converts a packet in canonical format to a getaddrbyname response structure. .PP These structures are defined in -\fI<lwres/lwres.h>\fR. -They are shown below. +\fI<lwres/lwres.h>\fR. They are shown below. .sp .nf #define LWRES_OPCODE_GETADDRSBYNAME 0x00010001U - typedef struct lwres_addr lwres_addr_t; typedef LWRES_LIST(lwres_addr_t) lwres_addrlist_t; - typedef struct { lwres_uint32_t flags; lwres_uint32_t addrtypes; lwres_uint16_t namelen; char *name; } lwres_gabnrequest_t; - typedef struct { lwres_uint32_t flags; lwres_uint16_t naliases; @@ -98,21 +79,18 @@ typedef struct { void *base; size_t baselen; } lwres_gabnresponse_t; -.sp .fi +.sp .PP \fBlwres_gabnrequest_render()\fR uses resolver context \fIctx\fR to convert getaddrbyname request structure \fIreq\fR -to canonical format. -The packet header structure +to canonical format. The packet header structure \fIpkt\fR -is initialised and transferred to -buffer -\fIb\fR. -The contents of +is initialised and transferred to buffer +\fIb\fR. The contents of \fI*req\fR are then appended to the buffer in canonical format. \fBlwres_gabnresponse_render()\fR @@ -127,11 +105,9 @@ to convert the contents of packet \fIpkt\fR to a \fBlwres_gabnrequest_t\fR -structure. -Buffer +structure. Buffer \fIb\fR -provides space to be used for storing this structure. -When the function succeeds, the resulting +provides space to be used for storing this structure. When the function succeeds, the resulting \fBlwres_gabnrequest_t\fR is made available through \fI*structp\fR. @@ -152,24 +128,20 @@ that was allocated to the or \fBlwres_gabnrequest_t\fR structures referenced via -\fIstructp\fR. -Any memory associated with ancillary buffers and strings for those -structures is also discarded. +\fIstructp\fR. Any memory associated with ancillary buffers and strings for those structures is also discarded. .SH "RETURN VALUES" .PP The getaddrbyname opcode functions -\fBlwres_gabnrequest_render()\fR, -\fBlwres_gabnresponse_render()\fR -\fBlwres_gabnrequest_parse()\fR +\fBlwres_gabnrequest_render()\fR, +\fBlwres_gabnresponse_render()\fR\fBlwres_gabnrequest_parse()\fR and \fBlwres_gabnresponse_parse()\fR all return -LWRES_R_SUCCESS -on success. -They return -LWRES_R_NOMEMORY +\fBLWRES_R_SUCCESS\fR +on success. They return +\fBLWRES_R_NOMEMORY\fR if memory allocation fails. -LWRES_R_UNEXPECTEDEND +\fBLWRES_R_UNEXPECTEDEND\fR is returned if the available space in the buffer \fIb\fR is too small to accommodate the packet header or the @@ -181,15 +153,14 @@ structures. and \fBlwres_gabnresponse_parse()\fR will return -LWRES_R_UNEXPECTEDEND -if the buffer is not empty after decoding the received packet. -These functions will return -LWRES_R_FAILURE +\fBLWRES_R_UNEXPECTEDEND\fR +if the buffer is not empty after decoding the received packet. These functions will return +\fBLWRES_R_FAILURE\fR if -\fBpktflags\fR +pktflags in the packet header structure \fBlwres_lwpacket_t\fR indicate that the packet is not a response to an earlier query. .SH "SEE ALSO" .PP -\fBlwres_packet\fR(3) +\fBlwres_packet\fR(3 ) diff --git a/contrib/bind9/lib/lwres/man/lwres_gabn.docbook b/contrib/bind9/lib/lwres/man/lwres_gabn.docbook index cb9481f..6e90ea3 100644 --- a/contrib/bind9/lib/lwres/man/lwres_gabn.docbook +++ b/contrib/bind9/lib/lwres/man/lwres_gabn.docbook @@ -1,7 +1,9 @@ -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.0//EN" + "http://www.oasis-open.org/docbook/xml/4.0/docbookx.dtd" + [<!ENTITY mdash "—">]> <!-- - - Copyright (C) 2004 Internet Systems Consortium, Inc. ("ISC") - - Copyright (C) 2001 Internet Software Consortium. + - Copyright (C) 2004, 2005 Internet Systems Consortium, Inc. ("ISC") + - Copyright (C) 2000, 2001 Internet Software Consortium. - - Permission to use, copy, modify, and distribute this software for any - purpose with or without fee is hereby granted, provided that the above @@ -16,7 +18,7 @@ - PERFORMANCE OF THIS SOFTWARE. --> -<!-- $Id: lwres_gabn.docbook,v 1.3.206.1 2004/03/06 08:15:38 marka Exp $ --> +<!-- $Id: lwres_gabn.docbook,v 1.3.206.3 2005/05/12 21:36:12 sra Exp $ --> <refentry> <refentryinfo> @@ -29,6 +31,20 @@ <manvolnum>3</manvolnum> <refmiscinfo>BIND9</refmiscinfo> </refmeta> + + <docinfo> + <copyright> + <year>2004</year> + <year>2005</year> + <holder>Internet Systems Consortium, Inc. ("ISC")</holder> + </copyright> + <copyright> + <year>2000</year> + <year>2001</year> + <holder>Internet Software Consortium.</holder> + </copyright> + </docinfo> + <refnamediv> <refname>lwres_gabnrequest_render</refname> <refname>lwres_gabnresponse_render</refname> diff --git a/contrib/bind9/lib/lwres/man/lwres_gabn.html b/contrib/bind9/lib/lwres/man/lwres_gabn.html index 6cb6614..7713945 100644 --- a/contrib/bind9/lib/lwres/man/lwres_gabn.html +++ b/contrib/bind9/lib/lwres/man/lwres_gabn.html @@ -1,158 +1,195 @@ <!-- - - Copyright (C) 2004 Internet Systems Consortium, Inc. ("ISC") - - Copyright (C) 2001 Internet Software Consortium. - - + - Copyright (C) 2004, 2005 Internet Systems Consortium, Inc. ("ISC") + - Copyright (C) 2000, 2001 Internet Software Consortium. + - - Permission to use, copy, modify, and distribute this software for any - purpose with or without fee is hereby granted, provided that the above - copyright notice and this permission notice appear in all copies. - - + - - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY - - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT, + - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT, - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> - -<!-- $Id: lwres_gabn.html,v 1.6.2.1.4.2 2004/08/22 23:39:03 marka Exp $ --> - -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<HTML -><HEAD -><TITLE ->lwres_gabn</TITLE -><META -NAME="GENERATOR" -CONTENT="Modular DocBook HTML Stylesheet Version 1.7"></HEAD -><BODY -CLASS="REFENTRY" -BGCOLOR="#FFFFFF" -TEXT="#000000" -LINK="#0000FF" -VLINK="#840084" -ALINK="#0000FF" -><H1 -><A -NAME="AEN1" -></A ->lwres_gabn</H1 -><DIV -CLASS="REFNAMEDIV" -><A -NAME="AEN8" -></A -><H2 ->Name</H2 ->lwres_gabnrequest_render, lwres_gabnresponse_render, lwres_gabnrequest_parse, lwres_gabnresponse_parse, lwres_gabnresponse_free, lwres_gabnrequest_free -- lightweight resolver getaddrbyname message handling</DIV -><DIV -CLASS="REFSYNOPSISDIV" -><A -NAME="AEN16" -></A -><H2 ->Synopsis</H2 -><DIV -CLASS="FUNCSYNOPSIS" -><P -></P -><A -NAME="AEN17" -></A -><PRE -CLASS="FUNCSYNOPSISINFO" ->#include <lwres/lwres.h></PRE -><P -><CODE -><CODE -CLASS="FUNCDEF" ->lwres_result_t -lwres_gabnrequest_render</CODE ->(lwres_context_t *ctx, lwres_gabnrequest_t *req, lwres_lwpacket_t *pkt, lwres_buffer_t *b);</CODE -></P -><P -><CODE -><CODE -CLASS="FUNCDEF" ->lwres_result_t -lwres_gabnresponse_render</CODE ->(lwres_context_t *ctx, lwres_gabnresponse_t *req, lwres_lwpacket_t *pkt, lwres_buffer_t *b);</CODE -></P -><P -><CODE -><CODE -CLASS="FUNCDEF" ->lwres_result_t -lwres_gabnrequest_parse</CODE ->(lwres_context_t *ctx, lwres_buffer_t *b, lwres_lwpacket_t *pkt, lwres_gabnrequest_t **structp);</CODE -></P -><P -><CODE -><CODE -CLASS="FUNCDEF" ->lwres_result_t -lwres_gabnresponse_parse</CODE ->(lwres_context_t *ctx, lwres_buffer_t *b, lwres_lwpacket_t *pkt, lwres_gabnresponse_t **structp);</CODE -></P -><P -><CODE -><CODE -CLASS="FUNCDEF" ->void -lwres_gabnresponse_free</CODE ->(lwres_context_t *ctx, lwres_gabnresponse_t **structp);</CODE -></P -><P -><CODE -><CODE -CLASS="FUNCDEF" ->void -lwres_gabnrequest_free</CODE ->(lwres_context_t *ctx, lwres_gabnrequest_t **structp);</CODE -></P -><P -></P -></DIV -></DIV -><DIV -CLASS="REFSECT1" -><A -NAME="AEN57" -></A -><H2 ->DESCRIPTION</H2 -><P ->These are low-level routines for creating and parsing +<!-- $Id: lwres_gabn.html,v 1.6.2.1.4.9 2005/10/13 02:33:55 marka Exp $ --> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> +<title>lwres_gabn</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.69.1"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"> +<a name="id2463721"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2>Name</h2> +<p>lwres_gabnrequest_render, lwres_gabnresponse_render, lwres_gabnrequest_parse, lwres_gabnresponse_parse, lwres_gabnresponse_free, lwres_gabnrequest_free — lightweight resolver getaddrbyname message handling</p> +</div> +<div class="refsynopsisdiv"> +<h2>Synopsis</h2> +<div class="funcsynopsis"> +<pre class="funcsynopsisinfo">#include <lwres/lwres.h></pre> +<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em"> +<tr> +<td><code class="funcdef"> +lwres_result_t +<b class="fsfunc">lwres_gabnrequest_render</b>(</code></td> +<td> </td> +<td>, </td> +</tr> +<tr> +<td> </td> +<td> </td> +<td>, </td> +</tr> +<tr> +<td> </td> +<td> </td> +<td>, </td> +</tr> +<tr> +<td> </td> +<td> </td> +<td> +<code>)</code>;</td> +</tr> +</table> +<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em"> +<tr> +<td><code class="funcdef"> +lwres_result_t +<b class="fsfunc">lwres_gabnresponse_render</b>(</code></td> +<td> </td> +<td>, </td> +</tr> +<tr> +<td> </td> +<td> </td> +<td>, </td> +</tr> +<tr> +<td> </td> +<td> </td> +<td>, </td> +</tr> +<tr> +<td> </td> +<td> </td> +<td> +<code>)</code>;</td> +</tr> +</table> +<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em"> +<tr> +<td><code class="funcdef"> +lwres_result_t +<b class="fsfunc">lwres_gabnrequest_parse</b>(</code></td> +<td> </td> +<td>, </td> +</tr> +<tr> +<td> </td> +<td> </td> +<td>, </td> +</tr> +<tr> +<td> </td> +<td> </td> +<td>, </td> +</tr> +<tr> +<td> </td> +<td> </td> +<td> +<code>)</code>;</td> +</tr> +</table> +<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em"> +<tr> +<td><code class="funcdef"> +lwres_result_t +<b class="fsfunc">lwres_gabnresponse_parse</b>(</code></td> +<td> </td> +<td>, </td> +</tr> +<tr> +<td> </td> +<td> </td> +<td>, </td> +</tr> +<tr> +<td> </td> +<td> </td> +<td>, </td> +</tr> +<tr> +<td> </td> +<td> </td> +<td> +<code>)</code>;</td> +</tr> +</table> +<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em"> +<tr> +<td><code class="funcdef"> +void +<b class="fsfunc">lwres_gabnresponse_free</b>(</code></td> +<td> </td> +<td>, </td> +</tr> +<tr> +<td> </td> +<td> </td> +<td> +<code>)</code>;</td> +</tr> +</table> +<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0"> +<tr> +<td><code class="funcdef"> +void +<b class="fsfunc">lwres_gabnrequest_free</b>(</code></td> +<td> </td> +<td>, </td> +</tr> +<tr> +<td> </td> +<td> </td> +<td> +<code>)</code>;</td> +</tr> +</table> +</div> +</div> +<div class="refsect1" lang="en"> +<a name="id2525963"></a><h2>DESCRIPTION</h2> +<p> +These are low-level routines for creating and parsing lightweight resolver name-to-address lookup request and -response messages.</P -><P ->There are four main functions for the getaddrbyname opcode. -One render function converts a getaddrbyname request structure — -<SPAN -CLASS="TYPE" ->lwres_gabnrequest_t</SPAN -> — +response messages. +</p> +<p> +There are four main functions for the getaddrbyname opcode. +One render function converts a getaddrbyname request structure — +<span class="type">lwres_gabnrequest_t</span> — 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 — -<SPAN -CLASS="TYPE" ->lwres_gabnresponse_t</SPAN -> — +Another render function converts the getaddrbyname response structure — +<span class="type">lwres_gabnresponse_t</span> — to the canonical format. This is complemented by a parse function which converts a packet in -canonical format to a getaddrbyname response structure.</P -><P ->These structures are defined in -<TT -CLASS="FILENAME" -><lwres/lwres.h></TT ->. +canonical format to a getaddrbyname response structure. +</p> +<p> +These structures are defined in +<code class="filename"><lwres/lwres.h></code>. They are shown below. -<PRE -CLASS="PROGRAMLISTING" ->#define LWRES_OPCODE_GETADDRSBYNAME 0x00010001U +</p> +<pre class="programlisting"> +#define LWRES_OPCODE_GETADDRSBYNAME 0x00010001U typedef struct lwres_addr lwres_addr_t; typedef LWRES_LIST(lwres_addr_t) lwres_addrlist_t; @@ -175,245 +212,116 @@ typedef struct { lwres_addrlist_t addrs; void *base; size_t baselen; -} lwres_gabnresponse_t;</PRE -></P -><P -><CODE -CLASS="FUNCTION" ->lwres_gabnrequest_render()</CODE -> +} lwres_gabnresponse_t; +</pre> +<p> +</p> +<p> +<code class="function">lwres_gabnrequest_render()</code> uses resolver context -<VAR -CLASS="PARAMETER" ->ctx</VAR -> +<em class="parameter"><code>ctx</code></em> to convert getaddrbyname request structure -<VAR -CLASS="PARAMETER" ->req</VAR -> +<em class="parameter"><code>req</code></em> to canonical format. The packet header structure -<VAR -CLASS="PARAMETER" ->pkt</VAR -> +<em class="parameter"><code>pkt</code></em> is initialised and transferred to buffer -<VAR -CLASS="PARAMETER" ->b</VAR ->. +<em class="parameter"><code>b</code></em>. The contents of -<VAR -CLASS="PARAMETER" ->*req</VAR -> +<em class="parameter"><code>*req</code></em> are then appended to the buffer in canonical format. -<CODE -CLASS="FUNCTION" ->lwres_gabnresponse_render()</CODE -> +<code class="function">lwres_gabnresponse_render()</code> performs the same task, except it converts a getaddrbyname response structure -<SPAN -CLASS="TYPE" ->lwres_gabnresponse_t</SPAN -> -to the lightweight resolver's canonical format.</P -><P -><CODE -CLASS="FUNCTION" ->lwres_gabnrequest_parse()</CODE -> +<span class="type">lwres_gabnresponse_t</span> +to the lightweight resolver's canonical format. +</p> +<p> +<code class="function">lwres_gabnrequest_parse()</code> uses context -<VAR -CLASS="PARAMETER" ->ctx</VAR -> +<em class="parameter"><code>ctx</code></em> to convert the contents of packet -<VAR -CLASS="PARAMETER" ->pkt</VAR -> +<em class="parameter"><code>pkt</code></em> to a -<SPAN -CLASS="TYPE" ->lwres_gabnrequest_t</SPAN -> +<span class="type">lwres_gabnrequest_t</span> structure. Buffer -<VAR -CLASS="PARAMETER" ->b</VAR -> +<em class="parameter"><code>b</code></em> provides space to be used for storing this structure. When the function succeeds, the resulting -<SPAN -CLASS="TYPE" ->lwres_gabnrequest_t</SPAN -> +<span class="type">lwres_gabnrequest_t</span> is made available through -<VAR -CLASS="PARAMETER" ->*structp</VAR ->. +<em class="parameter"><code>*structp</code></em>. -<CODE -CLASS="FUNCTION" ->lwres_gabnresponse_parse()</CODE -> +<code class="function">lwres_gabnresponse_parse()</code> offers the same semantics as -<CODE -CLASS="FUNCTION" ->lwres_gabnrequest_parse()</CODE -> +<code class="function">lwres_gabnrequest_parse()</code> except it yields a -<SPAN -CLASS="TYPE" ->lwres_gabnresponse_t</SPAN -> -structure.</P -><P -><CODE -CLASS="FUNCTION" ->lwres_gabnresponse_free()</CODE -> +<span class="type">lwres_gabnresponse_t</span> +structure. +</p> +<p> +<code class="function">lwres_gabnresponse_free()</code> and -<CODE -CLASS="FUNCTION" ->lwres_gabnrequest_free()</CODE -> +<code class="function">lwres_gabnrequest_free()</code> release the memory in resolver context -<VAR -CLASS="PARAMETER" ->ctx</VAR -> +<em class="parameter"><code>ctx</code></em> that was allocated to the -<SPAN -CLASS="TYPE" ->lwres_gabnresponse_t</SPAN -> +<span class="type">lwres_gabnresponse_t</span> or -<SPAN -CLASS="TYPE" ->lwres_gabnrequest_t</SPAN -> +<span class="type">lwres_gabnrequest_t</span> structures referenced via -<VAR -CLASS="PARAMETER" ->structp</VAR ->. +<em class="parameter"><code>structp</code></em>. Any memory associated with ancillary buffers and strings for those -structures is also discarded.</P -></DIV -><DIV -CLASS="REFSECT1" -><A -NAME="AEN93" -></A -><H2 ->RETURN VALUES</H2 -><P ->The getaddrbyname opcode functions -<CODE -CLASS="FUNCTION" ->lwres_gabnrequest_render()</CODE ->, -<CODE -CLASS="FUNCTION" ->lwres_gabnresponse_render()</CODE -> -<CODE -CLASS="FUNCTION" ->lwres_gabnrequest_parse()</CODE -> +structures is also discarded. +</p> +</div> +<div class="refsect1" lang="en"> +<a name="id2526155"></a><h2>RETURN VALUES</h2> +<p> +The getaddrbyname opcode functions +<code class="function">lwres_gabnrequest_render()</code>, +<code class="function">lwres_gabnresponse_render()</code> +<code class="function">lwres_gabnrequest_parse()</code> and -<CODE -CLASS="FUNCTION" ->lwres_gabnresponse_parse()</CODE -> +<code class="function">lwres_gabnresponse_parse()</code> all return -<SPAN -CLASS="ERRORCODE" ->LWRES_R_SUCCESS</SPAN -> +<span class="errorcode">LWRES_R_SUCCESS</span> on success. They return -<SPAN -CLASS="ERRORCODE" ->LWRES_R_NOMEMORY</SPAN -> +<span class="errorcode">LWRES_R_NOMEMORY</span> if memory allocation fails. -<SPAN -CLASS="ERRORCODE" ->LWRES_R_UNEXPECTEDEND</SPAN -> +<span class="errorcode">LWRES_R_UNEXPECTEDEND</span> is returned if the available space in the buffer -<VAR -CLASS="PARAMETER" ->b</VAR -> +<em class="parameter"><code>b</code></em> is too small to accommodate the packet header or the -<SPAN -CLASS="TYPE" ->lwres_gabnrequest_t</SPAN -> +<span class="type">lwres_gabnrequest_t</span> and -<SPAN -CLASS="TYPE" ->lwres_gabnresponse_t</SPAN -> +<span class="type">lwres_gabnresponse_t</span> structures. -<CODE -CLASS="FUNCTION" ->lwres_gabnrequest_parse()</CODE -> +<code class="function">lwres_gabnrequest_parse()</code> and -<CODE -CLASS="FUNCTION" ->lwres_gabnresponse_parse()</CODE -> +<code class="function">lwres_gabnresponse_parse()</code> will return -<SPAN -CLASS="ERRORCODE" ->LWRES_R_UNEXPECTEDEND</SPAN -> +<span class="errorcode">LWRES_R_UNEXPECTEDEND</span> if the buffer is not empty after decoding the received packet. These functions will return -<SPAN -CLASS="ERRORCODE" ->LWRES_R_FAILURE</SPAN -> +<span class="errorcode">LWRES_R_FAILURE</span> if -<CODE -CLASS="STRUCTFIELD" ->pktflags</CODE -> +<em class="structfield"><code>pktflags</code></em> in the packet header structure -<SPAN -CLASS="TYPE" ->lwres_lwpacket_t</SPAN -> -indicate that the packet is not a response to an earlier query.</P -></DIV -><DIV -CLASS="REFSECT1" -><A -NAME="AEN112" -></A -><H2 ->SEE ALSO</H2 -><P -><SPAN -CLASS="CITEREFENTRY" -><SPAN -CLASS="REFENTRYTITLE" ->lwres_packet</SPAN ->(3)</SPAN -></P -></DIV -></BODY -></HTML -> +<span class="type">lwres_lwpacket_t</span> +indicate that the packet is not a response to an earlier query. +</p> +</div> +<div class="refsect1" lang="en"> +<a name="id2526220"></a><h2>SEE ALSO</h2> +<p> +<span class="citerefentry"><span class="refentrytitle">lwres_packet</span>(3 +)</span> +</p> +</div> +</div></body> +</html> diff --git a/contrib/bind9/lib/lwres/man/lwres_gai_strerror.3 b/contrib/bind9/lib/lwres/man/lwres_gai_strerror.3 index ea75066..388c59e 100644 --- a/contrib/bind9/lib/lwres/man/lwres_gai_strerror.3 +++ b/contrib/bind9/lib/lwres/man/lwres_gai_strerror.3 @@ -1,37 +1,44 @@ -.\" Copyright (C) 2004 Internet Systems Consortium, Inc. ("ISC") -.\" Copyright (C) 2000, 2001 Internet Software Consortium. -.\" +.\" Copyright (C) 2004, 2005 Internet Systems Consortium, Inc. ("ISC") +.\" Copyright (C) 2000, 2001 Internet Software Consortium. +.\" .\" Permission to use, copy, modify, and distribute this software for any .\" purpose with or without fee is hereby granted, provided that the above .\" copyright notice and this permission notice appear in all copies. -.\" +.\" .\" THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH .\" REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY -.\" AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT, +.\" AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT, .\" INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM .\" LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE .\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR .\" PERFORMANCE OF THIS SOFTWARE. .\" -.\" $Id: lwres_gai_strerror.3,v 1.13.2.1.8.1 2004/03/06 07:41:43 marka Exp $ +.\" $Id: lwres_gai_strerror.3,v 1.13.2.1.8.5 2005/10/13 02:33:52 marka Exp $ .\" -.TH "LWRES_GAI_STRERROR" "3" "Jun 30, 2000" "BIND9" "" -.SH NAME +.hy 0 +.ad l +.\" ** You probably do not want to edit this file directly ** +.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1). +.\" Instead of manually editing it, you probably should edit the DocBook XML +.\" source for it and then use the DocBook XSL Stylesheets to regenerate it. +.TH "LWRES_GAI_STRERROR" "3" "Jun 30, 2000" "BIND9" "BIND9" +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.SH "NAME" gai_strerror \- print suitable error string -.SH SYNOPSIS -\fB#include <lwres/netdb.h> -.sp -.na -char * -gai_strerror(int ecode); -.ad -\fR +.SH "SYNOPSIS" +.nf +#include <lwres/netdb.h> +.fi +.HP 20 +\fBchar\ *\ \fBgai_strerror\fR\fR\fB(\fR\fBint\ ecode\fR\fB);\fR .SH "DESCRIPTION" .PP \fBlwres_gai_strerror()\fR returns an error message corresponding to an error code returned by -\fBgetaddrinfo()\fR. -The following error codes and their meaning are defined in +\fBgetaddrinfo()\fR. The following error codes and their meaning are defined in \fIinclude/lwres/netdb.h\fR. .TP \fBEAI_ADDRFAMILY\fR @@ -42,13 +49,14 @@ temporary failure in name resolution .TP \fBEAI_BADFLAGS\fR invalid value for -ai_flags +\fBai_flags\fR .TP \fBEAI_FAIL\fR -non-recoverable failure in name resolution +non\-recoverable failure in name resolution .TP \fBEAI_FAMILY\fR -ai_family not supported +\fBai_family\fR +not supported .TP \fBEAI_MEMORY\fR memory allocation failure @@ -60,22 +68,25 @@ no address associated with hostname hostname or servname not provided, or not known .TP \fBEAI_SERVICE\fR -servname not supported for ai_socktype +servname not supported for +\fBai_socktype\fR .TP \fBEAI_SOCKTYPE\fR -ai_socktype not supported +\fBai_socktype\fR +not supported .TP \fBEAI_SYSTEM\fR system error returned in errno -.PP -The message \fBinvalid error code\fR is returned if +The message +invalid error code +is returned if \fIecode\fR is out of range. .PP -ai_flags, -ai_family +\fBai_flags\fR, +\fBai_family\fR and -ai_socktype +\fBai_socktype\fR are elements of the \fBstruct addrinfo\fR used by @@ -85,4 +96,4 @@ used by \fBstrerror\fR(3), \fBlwres_getaddrinfo\fR(3), \fBgetaddrinfo\fR(3), -\fBRFC2133\fR. +\fBRFC2133\fR(). diff --git a/contrib/bind9/lib/lwres/man/lwres_gai_strerror.docbook b/contrib/bind9/lib/lwres/man/lwres_gai_strerror.docbook index 475d444..f34836d 100644 --- a/contrib/bind9/lib/lwres/man/lwres_gai_strerror.docbook +++ b/contrib/bind9/lib/lwres/man/lwres_gai_strerror.docbook @@ -1,7 +1,9 @@ -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.0//EN" + "http://www.oasis-open.org/docbook/xml/4.0/docbookx.dtd" + [<!ENTITY mdash "—">]> <!-- - - Copyright (C) 2004 Internet Systems Consortium, Inc. ("ISC") - - Copyright (C) 2001 Internet Software Consortium. + - Copyright (C) 2004, 2005 Internet Systems Consortium, Inc. ("ISC") + - Copyright (C) 2000, 2001 Internet Software Consortium. - - Permission to use, copy, modify, and distribute this software for any - purpose with or without fee is hereby granted, provided that the above @@ -16,7 +18,7 @@ - PERFORMANCE OF THIS SOFTWARE. --> -<!-- $Id: lwres_gai_strerror.docbook,v 1.3.206.1 2004/03/06 08:15:38 marka Exp $ --> +<!-- $Id: lwres_gai_strerror.docbook,v 1.3.206.3 2005/05/12 21:36:13 sra Exp $ --> <refentry> <refentryinfo> @@ -29,6 +31,20 @@ <manvolnum>3</manvolnum> <refmiscinfo>BIND9</refmiscinfo> </refmeta> + + <docinfo> + <copyright> + <year>2004</year> + <year>2005</year> + <holder>Internet Systems Consortium, Inc. ("ISC")</holder> + </copyright> + <copyright> + <year>2000</year> + <year>2001</year> + <holder>Internet Software Consortium.</holder> + </copyright> + </docinfo> + <refnamediv> <refname>gai_strerror</refname> <refpurpose>print suitable error string</refpurpose> diff --git a/contrib/bind9/lib/lwres/man/lwres_gai_strerror.html b/contrib/bind9/lib/lwres/man/lwres_gai_strerror.html index 45dc5cb..5506564 100644 --- a/contrib/bind9/lib/lwres/man/lwres_gai_strerror.html +++ b/contrib/bind9/lib/lwres/man/lwres_gai_strerror.html @@ -1,295 +1,124 @@ <!-- - - Copyright (C) 2004 Internet Systems Consortium, Inc. ("ISC") - - Copyright (C) 2001 Internet Software Consortium. - - + - Copyright (C) 2004, 2005 Internet Systems Consortium, Inc. ("ISC") + - Copyright (C) 2000, 2001 Internet Software Consortium. + - - Permission to use, copy, modify, and distribute this software for any - purpose with or without fee is hereby granted, provided that the above - copyright notice and this permission notice appear in all copies. - - + - - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY - - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT, + - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT, - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> - -<!-- $Id: lwres_gai_strerror.html,v 1.5.2.1.4.2 2004/08/22 23:39:03 marka Exp $ --> - -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<HTML -><HEAD -><TITLE ->lwres_gai_strerror</TITLE -><META -NAME="GENERATOR" -CONTENT="Modular DocBook HTML Stylesheet Version 1.7"></HEAD -><BODY -CLASS="REFENTRY" -BGCOLOR="#FFFFFF" -TEXT="#000000" -LINK="#0000FF" -VLINK="#840084" -ALINK="#0000FF" -><H1 -><A -NAME="AEN1" -></A ->lwres_gai_strerror</H1 -><DIV -CLASS="REFNAMEDIV" -><A -NAME="AEN8" -></A -><H2 ->Name</H2 ->gai_strerror -- print suitable error string</DIV -><DIV -CLASS="REFSYNOPSISDIV" -><A -NAME="AEN11" -></A -><H2 ->Synopsis</H2 -><DIV -CLASS="FUNCSYNOPSIS" -><P -></P -><A -NAME="AEN12" -></A -><PRE -CLASS="FUNCSYNOPSISINFO" ->#include <lwres/netdb.h></PRE -><P -><CODE -><CODE -CLASS="FUNCDEF" ->char * -gai_strerror</CODE ->(int ecode);</CODE -></P -><P -></P -></DIV -></DIV -><DIV -CLASS="REFSECT1" -><A -NAME="AEN18" -></A -><H2 ->DESCRIPTION</H2 -><P -><CODE -CLASS="FUNCTION" ->lwres_gai_strerror()</CODE -> +<!-- $Id: lwres_gai_strerror.html,v 1.5.2.1.4.9 2005/10/13 02:33:55 marka Exp $ --> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> +<title>lwres_gai_strerror</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.69.1"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"> +<a name="id2463721"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2>Name</h2> +<p>gai_strerror — print suitable error string</p> +</div> +<div class="refsynopsisdiv"> +<h2>Synopsis</h2> +<div class="funcsynopsis"> +<pre class="funcsynopsisinfo">#include <lwres/netdb.h></pre> +<p><code class="funcdef"> +char * +<b class="fsfunc">gai_strerror</b>(</code>int ecode<code>)</code>;</p> +</div> +</div> +<div class="refsect1" lang="en"> +<a name="id2525843"></a><h2>DESCRIPTION</h2> +<p> +<code class="function">lwres_gai_strerror()</code> returns an error message corresponding to an error code returned by -<CODE -CLASS="FUNCTION" ->getaddrinfo()</CODE ->. +<code class="function">getaddrinfo()</code>. The following error codes and their meaning are defined in -<TT -CLASS="FILENAME" ->include/lwres/netdb.h</TT ->. -<P -></P -><DIV -CLASS="VARIABLELIST" -><DL -><DT -><SPAN -CLASS="ERRORCODE" ->EAI_ADDRFAMILY</SPAN -></DT -><DD -><P ->address family for hostname not supported</P -></DD -><DT -><SPAN -CLASS="ERRORCODE" ->EAI_AGAIN</SPAN -></DT -><DD -><P ->temporary failure in name resolution</P -></DD -><DT -><SPAN -CLASS="ERRORCODE" ->EAI_BADFLAGS</SPAN -></DT -><DD -><P ->invalid value for -<CODE -CLASS="CONSTANT" ->ai_flags</CODE -></P -></DD -><DT -><SPAN -CLASS="ERRORCODE" ->EAI_FAIL</SPAN -></DT -><DD -><P ->non-recoverable failure in name resolution</P -></DD -><DT -><SPAN -CLASS="ERRORCODE" ->EAI_FAMILY</SPAN -></DT -><DD -><P -><CODE -CLASS="CONSTANT" ->ai_family</CODE -> not supported</P -></DD -><DT -><SPAN -CLASS="ERRORCODE" ->EAI_MEMORY</SPAN -></DT -><DD -><P ->memory allocation failure</P -></DD -><DT -><SPAN -CLASS="ERRORCODE" ->EAI_NODATA</SPAN -></DT -><DD -><P ->no address associated with hostname</P -></DD -><DT -><SPAN -CLASS="ERRORCODE" ->EAI_NONAME</SPAN -></DT -><DD -><P ->hostname or servname not provided, or not known</P -></DD -><DT -><SPAN -CLASS="ERRORCODE" ->EAI_SERVICE</SPAN -></DT -><DD -><P ->servname not supported for <CODE -CLASS="CONSTANT" ->ai_socktype</CODE -></P -></DD -><DT -><SPAN -CLASS="ERRORCODE" ->EAI_SOCKTYPE</SPAN -></DT -><DD -><P -><CODE -CLASS="CONSTANT" ->ai_socktype</CODE -> not supported</P -></DD -><DT -><SPAN -CLASS="ERRORCODE" ->EAI_SYSTEM</SPAN -></DT -><DD -><P ->system error returned in errno</P -></DD -></DL -></DIV -> -The message <SPAN -CLASS="ERRORNAME" ->invalid error code</SPAN -> is returned if -<VAR -CLASS="PARAMETER" ->ecode</VAR -> -is out of range.</P -><P -><CODE -CLASS="CONSTANT" ->ai_flags</CODE ->, -<CODE -CLASS="CONSTANT" ->ai_family</CODE -> +<code class="filename">include/lwres/netdb.h</code>. +</p> +<div class="variablelist"><dl> +<dt><span class="term"><span class="errorcode">EAI_ADDRFAMILY</span></span></dt> +<dd><p> +address family for hostname not supported +</p></dd> +<dt><span class="term"><span class="errorcode">EAI_AGAIN</span></span></dt> +<dd><p> +temporary failure in name resolution +</p></dd> +<dt><span class="term"><span class="errorcode">EAI_BADFLAGS</span></span></dt> +<dd><p> +invalid value for +<code class="constant">ai_flags</code> +</p></dd> +<dt><span class="term"><span class="errorcode">EAI_FAIL</span></span></dt> +<dd><p> +non-recoverable failure in name resolution +</p></dd> +<dt><span class="term"><span class="errorcode">EAI_FAMILY</span></span></dt> +<dd><p> +<code class="constant">ai_family</code> not supported +</p></dd> +<dt><span class="term"><span class="errorcode">EAI_MEMORY</span></span></dt> +<dd><p> +memory allocation failure +</p></dd> +<dt><span class="term"><span class="errorcode">EAI_NODATA</span></span></dt> +<dd><p> +no address associated with hostname +</p></dd> +<dt><span class="term"><span class="errorcode">EAI_NONAME</span></span></dt> +<dd><p> +hostname or servname not provided, or not known +</p></dd> +<dt><span class="term"><span class="errorcode">EAI_SERVICE</span></span></dt> +<dd><p> +servname not supported for <code class="constant">ai_socktype</code> +</p></dd> +<dt><span class="term"><span class="errorcode">EAI_SOCKTYPE</span></span></dt> +<dd><p> +<code class="constant">ai_socktype</code> not supported +</p></dd> +<dt><span class="term"><span class="errorcode">EAI_SYSTEM</span></span></dt> +<dd><p> +system error returned in errno +</p></dd> +</dl></div> +<p> +The message <span class="errorname">invalid error code</span> is returned if +<em class="parameter"><code>ecode</code></em> +is out of range. +</p> +<p> +<code class="constant">ai_flags</code>, +<code class="constant">ai_family</code> and -<CODE -CLASS="CONSTANT" ->ai_socktype</CODE -> +<code class="constant">ai_socktype</code> are elements of the -<SPAN -CLASS="TYPE" ->struct addrinfo</SPAN -> +<span class="type">struct addrinfo</span> used by -<CODE -CLASS="FUNCTION" ->lwres_getaddrinfo()</CODE ->.</P -></DIV -><DIV -CLASS="REFSECT1" -><A -NAME="AEN92" -></A -><H2 ->SEE ALSO</H2 -><P -><SPAN -CLASS="CITEREFENTRY" -><SPAN -CLASS="REFENTRYTITLE" ->strerror</SPAN ->(3)</SPAN ->, +<code class="function">lwres_getaddrinfo()</code>. +</p> +</div> +<div class="refsect1" lang="en"> +<a name="id2526040"></a><h2>SEE ALSO</h2> +<p> +<span class="citerefentry"><span class="refentrytitle">strerror</span>(3)</span>, -<SPAN -CLASS="CITEREFENTRY" -><SPAN -CLASS="REFENTRYTITLE" ->lwres_getaddrinfo</SPAN ->(3)</SPAN ->, +<span class="citerefentry"><span class="refentrytitle">lwres_getaddrinfo</span>(3)</span>, -<SPAN -CLASS="CITEREFENTRY" -><SPAN -CLASS="REFENTRYTITLE" ->getaddrinfo</SPAN ->(3)</SPAN ->, +<span class="citerefentry"><span class="refentrytitle">getaddrinfo</span>(3)</span>, -<SPAN -CLASS="CITEREFENTRY" -><SPAN -CLASS="REFENTRYTITLE" ->RFC2133</SPAN -></SPAN ->.</P -></DIV -></BODY -></HTML -> +<span class="citerefentry"><span class="refentrytitle">RFC2133</span></span>. +</p> +</div> +</div></body> +</html> diff --git a/contrib/bind9/lib/lwres/man/lwres_getaddrinfo.3 b/contrib/bind9/lib/lwres/man/lwres_getaddrinfo.3 index d360b3e..df1390a 100644 --- a/contrib/bind9/lib/lwres/man/lwres_getaddrinfo.3 +++ b/contrib/bind9/lib/lwres/man/lwres_getaddrinfo.3 @@ -1,40 +1,44 @@ -.\" Copyright (C) 2004 Internet Systems Consortium, Inc. ("ISC") -.\" Copyright (C) 2000, 2001 Internet Software Consortium. -.\" +.\" Copyright (C) 2004, 2005 Internet Systems Consortium, Inc. ("ISC") +.\" Copyright (C) 2000, 2001, 2003 Internet Software Consortium. +.\" .\" Permission to use, copy, modify, and distribute this software for any .\" purpose with or without fee is hereby granted, provided that the above .\" copyright notice and this permission notice appear in all copies. -.\" +.\" .\" THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH .\" REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY -.\" AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT, +.\" AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT, .\" INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM .\" LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE .\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR .\" PERFORMANCE OF THIS SOFTWARE. .\" -.\" $Id: lwres_getaddrinfo.3,v 1.16.2.1.8.2 2004/03/06 07:41:43 marka Exp $ +.\" $Id: lwres_getaddrinfo.3,v 1.16.2.1.8.6 2005/10/13 02:33:53 marka Exp $ .\" -.TH "LWRES_GETADDRINFO" "3" "Jun 30, 2000" "BIND9" "" -.SH NAME +.hy 0 +.ad l +.\" ** You probably do not want to edit this file directly ** +.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1). +.\" Instead of manually editing it, you probably should edit the DocBook XML +.\" source for it and then use the DocBook XSL Stylesheets to regenerate it. +.TH "LWRES_GETADDRINFO" "3" "Jun 30, 2000" "BIND9" "BIND9" +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.SH "NAME" lwres_getaddrinfo, lwres_freeaddrinfo \- socket address structure to host and service name -.SH SYNOPSIS -\fB#include <lwres/netdb.h> -.sp -.na -int -lwres_getaddrinfo(const char *hostname, const char *servname, const struct addrinfo *hints, struct addrinfo **res); -.ad -.sp -.na -void -lwres_freeaddrinfo(struct addrinfo *ai); -.ad -\fR +.SH "SYNOPSIS" +.nf +#include <lwres/netdb.h> +.fi +.HP 22 +\fBint\ \fBlwres_getaddrinfo\fR\fR\fB(\fR\fBconst\ char\ *hostname\fR\fB, \fR\fBconst\ char\ *servname\fR\fB, \fR\fBconst\ struct\ addrinfo\ *hints\fR\fB, \fR\fBstruct\ addrinfo\ **res\fR\fB);\fR +.HP 24 +\fBvoid\ \fBlwres_freeaddrinfo\fR\fR\fB(\fR\fBstruct\ addrinfo\ *ai\fR\fB);\fR .PP If the operating system does not provide a -\fBstruct addrinfo\fR, -the following structure is used: +\fBstruct addrinfo\fR, the following structure is used: .sp .nf struct addrinfo { @@ -47,47 +51,38 @@ struct addrinfo { struct sockaddr *ai_addr; /* binary address */ struct addrinfo *ai_next; /* next structure in linked list */ }; -.sp .fi +.sp .SH "DESCRIPTION" .PP \fBlwres_getaddrinfo()\fR is used to get a list of IP addresses and port numbers for host \fIhostname\fR and service -\fIservname\fR. -The function is the lightweight resolver's implementation of +\fIservname\fR. The function is the lightweight resolver's implementation of \fBgetaddrinfo()\fR as defined in RFC2133. \fIhostname\fR and \fIservname\fR -are pointers to null-terminated -strings or +are pointers to null\-terminated strings or \fBNULL\fR. \fIhostname\fR -is either a host name or a numeric host address string: a dotted decimal -IPv4 address or an IPv6 address. +is either a host name or a numeric host address string: a dotted decimal IPv4 address or an IPv6 address. \fIservname\fR is either a decimal port number or a service name as listed in \fI/etc/services\fR. .PP \fIhints\fR is an optional pointer to a -\fBstruct addrinfo\fR. -This structure can be used to provide hints concerning the type of socket -that the caller supports or wishes to use. -The caller can supply the following structure elements in +\fBstruct addrinfo\fR. This structure can be used to provide hints concerning the type of socket that the caller supports or wishes to use. The caller can supply the following structure elements in \fI*hints\fR: .TP \fBai_family\fR -The protocol family that should be used. -When -ai_family +The protocol family that should be used. When +\fBai_family\fR is set to -\fBPF_UNSPEC\fR, -it means the caller will accept any protocol family supported by the -operating system. +\fBPF_UNSPEC\fR, it means the caller will accept any protocol family supported by the operating system. .TP \fBai_socktype\fR denotes the type of socket \(em @@ -95,122 +90,107 @@ denotes the type of socket \(em \fBSOCK_DGRAM\fR or \fBSOCK_RAW\fR -\(em that is wanted. -When -ai_socktype +\(em that is wanted. When +\fBai_socktype\fR is zero the caller will accept any socket type. .TP \fBai_protocol\fR -indicates which transport protocol is wanted: IPPROTO_UDP or -IPPROTO_TCP. -If -ai_protocol +indicates which transport protocol is wanted: IPPROTO_UDP or IPPROTO_TCP. If +\fBai_protocol\fR is zero the caller will accept any protocol. .TP \fBai_flags\fR -Flag bits. -If the +Flag bits. If the \fBAI_CANONNAME\fR bit is set, a successful call to \fBlwres_getaddrinfo()\fR -will return a null-terminated string containing the canonical name -of the specified hostname in -ai_canonname +will return a null\-terminated string containing the canonical name of the specified hostname in +\fBai_canonname\fR of the first \fBaddrinfo\fR -structure returned. -Setting the +structure returned. Setting the \fBAI_PASSIVE\fR -bit indicates that the returned socket address structure is intended -for used in a call to -\fBbind\fR(2). -In this case, if the hostname argument is a +bit indicates that the returned socket address structure is intended for used in a call to +\fBbind\fR(2). In this case, if the hostname argument is a \fBNULL\fR -pointer, then the IP address portion of the socket -address structure will be set to +pointer, then the IP address portion of the socket address structure will be set to \fBINADDR_ANY\fR for an IPv4 address or \fBIN6ADDR_ANY_INIT\fR for an IPv6 address. - +.sp When -ai_flags +\fBai_flags\fR does not set the \fBAI_PASSIVE\fR -bit, the returned socket address structure will be ready -for use in a call to -\fBconnect\fR(2) -for a connection-oriented protocol or +bit, the returned socket address structure will be ready for use in a call to +\fBconnect\fR(2 ) +for a connection\-oriented protocol or \fBconnect\fR(2), -\fBsendto\fR(2), -or -\fBsendmsg\fR(2) -if a connectionless protocol was chosen. -The IP address portion of the socket address structure will be -set to the loopback address if +\fBsendto\fR(2), or +\fBsendmsg\fR(2 ) +if a connectionless protocol was chosen. The IP address portion of the socket address structure will be set to the loopback address if \fIhostname\fR is a \fBNULL\fR pointer and \fBAI_PASSIVE\fR is not set in -ai_flags. - +\fBai_flags\fR. +.sp If -ai_flags +\fBai_flags\fR is set to \fBAI_NUMERICHOST\fR it indicates that \fIhostname\fR -should be treated as a numeric string defining an IPv4 or IPv6 address -and no name resolution should be attempted. +should be treated as a numeric string defining an IPv4 or IPv6 address and no name resolution should be attempted. .PP -All other elements of the \fBstruct addrinfo\fR passed -via \fIhints\fR must be zero. +All other elements of the +\fBstruct addrinfo\fR +passed via +\fIhints\fR +must be zero. .PP -A \fIhints\fR of \fBNULL\fR is treated as if -the caller provided a \fBstruct addrinfo\fR initialized to zero -with ai_familyset to -PF_UNSPEC. +A +\fIhints\fR +of +\fBNULL\fR +is treated as if the caller provided a +\fBstruct addrinfo\fR +initialized to zero with +\fBai_family\fRset to +\fBPF_UNSPEC\fR. .PP After a successful call to \fBlwres_getaddrinfo()\fR, \fI*res\fR is a pointer to a linked list of one or more \fBaddrinfo\fR -structures. -Each +structures. Each \fBstruct addrinfo\fR -in this list cn be processed by following -the -ai_next +in this list cn be processed by following the +\fBai_next\fR pointer, until a \fBNULL\fR -pointer is encountered. -The three members -ai_family, -ai_socktype, -and -ai_protocol -in each -returned +pointer is encountered. The three members +\fBai_family\fR, +\fBai_socktype\fR, and +\fBai_protocol\fR +in each returned \fBaddrinfo\fR structure contain the corresponding arguments for a call to -\fBsocket\fR(2). -For each +\fBsocket\fR(2). For each \fBaddrinfo\fR structure in the list, the -ai_addr -member points to a filled-in socket address structure of length -ai_addrlen. +\fBai_addr\fR +member points to a filled\-in socket address structure of length +\fBai_addrlen\fR. .PP All of the information returned by \fBlwres_getaddrinfo()\fR -is dynamically allocated: the addrinfo structures, and the socket -address structures and canonical host name strings pointed to by the -addrinfostructures. -Memory allocated for the dynamically allocated structures created by -a successful call to +is dynamically allocated: the addrinfo structures, and the socket address structures and canonical host name strings pointed to by the +\fBaddrinfo\fRstructures. Memory allocated for the dynamically allocated structures created by a successful call to \fBlwres_getaddrinfo()\fR is released by \fBlwres_freeaddrinfo()\fR. @@ -223,24 +203,22 @@ created by a call to .PP \fBlwres_getaddrinfo()\fR returns zero on success or one of the error codes listed in -\fBgai_strerror\fR(3) -if an error occurs. -If both +\fBgai_strerror\fR(3 ) +if an error occurs. If both \fIhostname\fR and \fIservname\fR are -\fBNULL\fR -\fBlwres_getaddrinfo()\fR +\fBNULL\fR\fBlwres_getaddrinfo()\fR returns -EAI_NONAME. +\fBEAI_NONAME\fR. .SH "SEE ALSO" .PP \fBlwres\fR(3), \fBlwres_getaddrinfo\fR(3), \fBlwres_freeaddrinfo\fR(3), \fBlwres_gai_strerror\fR(3), -\fBRFC2133\fR, +\fBRFC2133\fR(), \fBgetservbyname\fR(3), \fBbind\fR(2), \fBconnect\fR(2), diff --git a/contrib/bind9/lib/lwres/man/lwres_getaddrinfo.docbook b/contrib/bind9/lib/lwres/man/lwres_getaddrinfo.docbook index 2f2fc82..1907219 100644 --- a/contrib/bind9/lib/lwres/man/lwres_getaddrinfo.docbook +++ b/contrib/bind9/lib/lwres/man/lwres_getaddrinfo.docbook @@ -1,7 +1,9 @@ -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.0//EN" + "http://www.oasis-open.org/docbook/xml/4.0/docbookx.dtd" + [<!ENTITY mdash "—">]> <!-- - - Copyright (C) 2004 Internet Systems Consortium, Inc. ("ISC") - - Copyright (C) 2001, 2003 Internet Software Consortium. + - Copyright (C) 2004, 2005 Internet Systems Consortium, Inc. ("ISC") + - Copyright (C) 2000, 2001, 2003 Internet Software Consortium. - - Permission to use, copy, modify, and distribute this software for any - purpose with or without fee is hereby granted, provided that the above @@ -16,7 +18,7 @@ - PERFORMANCE OF THIS SOFTWARE. --> -<!-- $Id: lwres_getaddrinfo.docbook,v 1.5.206.2 2004/03/06 08:15:39 marka Exp $ --> +<!-- $Id: lwres_getaddrinfo.docbook,v 1.5.206.4 2005/05/12 21:36:14 sra Exp $ --> <refentry> @@ -30,6 +32,20 @@ <refmiscinfo>BIND9</refmiscinfo> </refmeta> + <docinfo> + <copyright> + <year>2004</year> + <year>2005</year> + <holder>Internet Systems Consortium, Inc. ("ISC")</holder> + </copyright> + <copyright> + <year>2000</year> + <year>2001</year> + <year>2003</year> + <holder>Internet Software Consortium.</holder> + </copyright> + </docinfo> + <refnamediv> <refname>lwres_getaddrinfo</refname> <refname>lwres_freeaddrinfo</refname> diff --git a/contrib/bind9/lib/lwres/man/lwres_getaddrinfo.html b/contrib/bind9/lib/lwres/man/lwres_getaddrinfo.html index b568e59..bc84e74 100644 --- a/contrib/bind9/lib/lwres/man/lwres_getaddrinfo.html +++ b/contrib/bind9/lib/lwres/man/lwres_getaddrinfo.html @@ -1,97 +1,78 @@ <!-- - - Copyright (C) 2004 Internet Systems Consortium, Inc. ("ISC") - - Copyright (C) 2001, 2003 Internet Software Consortium. - - + - Copyright (C) 2004, 2005 Internet Systems Consortium, Inc. ("ISC") + - Copyright (C) 2000, 2001, 2003 Internet Software Consortium. + - - Permission to use, copy, modify, and distribute this software for any - purpose with or without fee is hereby granted, provided that the above - copyright notice and this permission notice appear in all copies. - - + - - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY - - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT, + - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT, - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> - -<!-- $Id: lwres_getaddrinfo.html,v 1.8.2.1.4.3 2004/08/22 23:39:03 marka Exp $ --> - -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<HTML -><HEAD -><TITLE ->lwres_getaddrinfo</TITLE -><META -NAME="GENERATOR" -CONTENT="Modular DocBook HTML Stylesheet Version 1.7"></HEAD -><BODY -CLASS="REFENTRY" -BGCOLOR="#FFFFFF" -TEXT="#000000" -LINK="#0000FF" -VLINK="#840084" -ALINK="#0000FF" -><H1 -><A -NAME="AEN1" -></A ->lwres_getaddrinfo</H1 -><DIV -CLASS="REFNAMEDIV" -><A -NAME="AEN8" -></A -><H2 ->Name</H2 ->lwres_getaddrinfo, lwres_freeaddrinfo -- socket address structure to host and service name</DIV -><DIV -CLASS="REFSYNOPSISDIV" -><A -NAME="AEN12" -></A -><H2 ->Synopsis</H2 -><DIV -CLASS="FUNCSYNOPSIS" -><P -></P -><A -NAME="AEN13" -></A -><PRE -CLASS="FUNCSYNOPSISINFO" ->#include <lwres/netdb.h></PRE -><P -><CODE -><CODE -CLASS="FUNCDEF" ->int -lwres_getaddrinfo</CODE ->(const char *hostname, const char *servname, const struct addrinfo *hints, struct addrinfo **res);</CODE -></P -><P -><CODE -><CODE -CLASS="FUNCDEF" ->void -lwres_freeaddrinfo</CODE ->(struct addrinfo *ai);</CODE -></P -><P -></P -></DIV -><P ->If the operating system does not provide a -<SPAN -CLASS="TYPE" ->struct addrinfo</SPAN ->, +<!-- $Id: lwres_getaddrinfo.html,v 1.8.2.1.4.10 2005/10/13 02:33:56 marka Exp $ --> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> +<title>lwres_getaddrinfo</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.69.1"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"> +<a name="id2463721"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2>Name</h2> +<p>lwres_getaddrinfo, lwres_freeaddrinfo — socket address structure to host and service name</p> +</div> +<div class="refsynopsisdiv"> +<h2>Synopsis</h2> +<div class="funcsynopsis"> +<pre class="funcsynopsisinfo">#include <lwres/netdb.h></pre> +<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em"> +<tr> +<td><code class="funcdef"> +int +<b class="fsfunc">lwres_getaddrinfo</b>(</code></td> +<td> </td> +<td>, </td> +</tr> +<tr> +<td> </td> +<td> </td> +<td>, </td> +</tr> +<tr> +<td> </td> +<td> </td> +<td>, </td> +</tr> +<tr> +<td> </td> +<td> </td> +<td> +<code>)</code>;</td> +</tr> +</table> +<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0"><tr> +<td><code class="funcdef"> +void +<b class="fsfunc">lwres_freeaddrinfo</b>(</code></td> +<td> </td> +<td> +<code>)</code>;</td> +</tr></table> +</div> +<p> +If the operating system does not provide a +<span class="type">struct addrinfo</span>, the following structure is used: -<PRE -CLASS="PROGRAMLISTING" ->struct addrinfo { +</p> +<pre class="programlisting"> +struct addrinfo { int ai_flags; /* AI_PASSIVE, AI_CANONNAME */ int ai_family; /* PF_xxx */ int ai_socktype; /* SOCK_xxx */ @@ -100,594 +81,253 @@ CLASS="PROGRAMLISTING" char *ai_canonname; /* canonical name for hostname */ struct sockaddr *ai_addr; /* binary address */ struct addrinfo *ai_next; /* next structure in linked list */ -};</PRE -></P -></DIV -><DIV -CLASS="REFSECT1" -><A -NAME="AEN29" -></A -><H2 ->DESCRIPTION</H2 -><P -><CODE -CLASS="FUNCTION" ->lwres_getaddrinfo()</CODE -> +}; +</pre> +<p> +</p> +</div> +<div class="refsect1" lang="en"> +<a name="id2525883"></a><h2>DESCRIPTION</h2> +<p> +<code class="function">lwres_getaddrinfo()</code> is used to get a list of IP addresses and port numbers for host -<VAR -CLASS="PARAMETER" ->hostname</VAR -> +<em class="parameter"><code>hostname</code></em> and service -<VAR -CLASS="PARAMETER" ->servname</VAR ->. +<em class="parameter"><code>servname</code></em>. The function is the lightweight resolver's implementation of -<CODE -CLASS="FUNCTION" ->getaddrinfo()</CODE -> +<code class="function">getaddrinfo()</code> as defined in RFC2133. -<VAR -CLASS="PARAMETER" ->hostname</VAR -> +<em class="parameter"><code>hostname</code></em> and -<VAR -CLASS="PARAMETER" ->servname</VAR -> +<em class="parameter"><code>servname</code></em> are pointers to null-terminated strings or -<SPAN -CLASS="TYPE" ->NULL</SPAN ->. +<span class="type">NULL</span>. -<VAR -CLASS="PARAMETER" ->hostname</VAR -> +<em class="parameter"><code>hostname</code></em> is either a host name or a numeric host address string: a dotted decimal IPv4 address or an IPv6 address. -<VAR -CLASS="PARAMETER" ->servname</VAR -> +<em class="parameter"><code>servname</code></em> is either a decimal port number or a service name as listed in -<TT -CLASS="FILENAME" ->/etc/services</TT ->.</P -><P -><VAR -CLASS="PARAMETER" ->hints</VAR -> +<code class="filename">/etc/services</code>. +</p> +<p> +<em class="parameter"><code>hints</code></em> is an optional pointer to a -<SPAN -CLASS="TYPE" ->struct addrinfo</SPAN ->. +<span class="type">struct addrinfo</span>. This structure can be used to provide hints concerning the type of socket that the caller supports or wishes to use. The caller can supply the following structure elements in -<VAR -CLASS="PARAMETER" ->*hints</VAR ->: +<em class="parameter"><code>*hints</code></em>: -<P -></P -><DIV -CLASS="VARIABLELIST" -><DL -><DT -><CODE -CLASS="CONSTANT" ->ai_family</CODE -></DT -><DD -><P ->The protocol family that should be used. +</p> +<div class="variablelist"><dl> +<dt><span class="term"><code class="constant">ai_family</code></span></dt> +<dd><p>The protocol family that should be used. When -<CODE -CLASS="CONSTANT" ->ai_family</CODE -> +<code class="constant">ai_family</code> is set to -<SPAN -CLASS="TYPE" ->PF_UNSPEC</SPAN ->, +<span class="type">PF_UNSPEC</span>, it means the caller will accept any protocol family supported by the -operating system.</P -></DD -><DT -><CODE -CLASS="CONSTANT" ->ai_socktype</CODE -></DT -><DD -><P ->denotes the type of socket — -<SPAN -CLASS="TYPE" ->SOCK_STREAM</SPAN ->, -<SPAN -CLASS="TYPE" ->SOCK_DGRAM</SPAN -> +operating system. +</p></dd> +<dt><span class="term"><code class="constant">ai_socktype</code></span></dt> +<dd><p> +denotes the type of socket — +<span class="type">SOCK_STREAM</span>, +<span class="type">SOCK_DGRAM</span> or -<SPAN -CLASS="TYPE" ->SOCK_RAW</SPAN -> -— that is wanted. +<span class="type">SOCK_RAW</span> +— that is wanted. When -<CODE -CLASS="CONSTANT" ->ai_socktype</CODE -> -is zero the caller will accept any socket type.</P -></DD -><DT -><CODE -CLASS="CONSTANT" ->ai_protocol</CODE -></DT -><DD -><P ->indicates which transport protocol is wanted: IPPROTO_UDP or +<code class="constant">ai_socktype</code> +is zero the caller will accept any socket type. +</p></dd> +<dt><span class="term"><code class="constant">ai_protocol</code></span></dt> +<dd><p> +indicates which transport protocol is wanted: IPPROTO_UDP or IPPROTO_TCP. If -<CODE -CLASS="CONSTANT" ->ai_protocol</CODE -> -is zero the caller will accept any protocol.</P -></DD -><DT -><CODE -CLASS="CONSTANT" ->ai_flags</CODE -></DT -><DD -><P ->Flag bits. +<code class="constant">ai_protocol</code> +is zero the caller will accept any protocol. +</p></dd> +<dt><span class="term"><code class="constant">ai_flags</code></span></dt> +<dd> +<p> +Flag bits. If the -<SPAN -CLASS="TYPE" ->AI_CANONNAME</SPAN -> +<span class="type">AI_CANONNAME</span> bit is set, a successful call to -<CODE -CLASS="FUNCTION" ->lwres_getaddrinfo()</CODE -> +<code class="function">lwres_getaddrinfo()</code> will return a null-terminated string containing the canonical name of the specified hostname in -<CODE -CLASS="CONSTANT" ->ai_canonname</CODE -> +<code class="constant">ai_canonname</code> of the first -<SPAN -CLASS="TYPE" ->addrinfo</SPAN -> +<span class="type">addrinfo</span> structure returned. Setting the -<SPAN -CLASS="TYPE" ->AI_PASSIVE</SPAN -> +<span class="type">AI_PASSIVE</span> bit indicates that the returned socket address structure is intended for used in a call to -<SPAN -CLASS="CITEREFENTRY" -><SPAN -CLASS="REFENTRYTITLE" ->bind</SPAN ->(2)</SPAN ->. +<span class="citerefentry"><span class="refentrytitle">bind</span>(2)</span>. In this case, if the hostname argument is a -<SPAN -CLASS="TYPE" ->NULL</SPAN -> +<span class="type">NULL</span> pointer, then the IP address portion of the socket address structure will be set to -<SPAN -CLASS="TYPE" ->INADDR_ANY</SPAN -> +<span class="type">INADDR_ANY</span> for an IPv4 address or -<SPAN -CLASS="TYPE" ->IN6ADDR_ANY_INIT</SPAN -> -for an IPv6 address.</P -><P ->When -<CODE -CLASS="CONSTANT" ->ai_flags</CODE -> +<span class="type">IN6ADDR_ANY_INIT</span> +for an IPv6 address. +</p> +<p> +When +<code class="constant">ai_flags</code> does not set the -<SPAN -CLASS="TYPE" ->AI_PASSIVE</SPAN -> +<span class="type">AI_PASSIVE</span> bit, the returned socket address structure will be ready for use in a call to -<SPAN -CLASS="CITEREFENTRY" -><SPAN -CLASS="REFENTRYTITLE" ->connect</SPAN ->(2)</SPAN -> +<span class="citerefentry"><span class="refentrytitle">connect</span>(2 +)</span> for a connection-oriented protocol or -<SPAN -CLASS="CITEREFENTRY" -><SPAN -CLASS="REFENTRYTITLE" ->connect</SPAN ->(2)</SPAN ->, +<span class="citerefentry"><span class="refentrytitle">connect</span>(2)</span>, -<SPAN -CLASS="CITEREFENTRY" -><SPAN -CLASS="REFENTRYTITLE" ->sendto</SPAN ->(2)</SPAN ->, +<span class="citerefentry"><span class="refentrytitle">sendto</span>(2)</span>, or -<SPAN -CLASS="CITEREFENTRY" -><SPAN -CLASS="REFENTRYTITLE" ->sendmsg</SPAN ->(2)</SPAN -> +<span class="citerefentry"><span class="refentrytitle">sendmsg</span>(2 +)</span> if a connectionless protocol was chosen. The IP address portion of the socket address structure will be set to the loopback address if -<VAR -CLASS="PARAMETER" ->hostname</VAR -> +<em class="parameter"><code>hostname</code></em> is a -<SPAN -CLASS="TYPE" ->NULL</SPAN -> +<span class="type">NULL</span> pointer and -<SPAN -CLASS="TYPE" ->AI_PASSIVE</SPAN -> +<span class="type">AI_PASSIVE</span> is not set in -<CODE -CLASS="CONSTANT" ->ai_flags</CODE ->.</P -><P ->If -<CODE -CLASS="CONSTANT" ->ai_flags</CODE -> +<code class="constant">ai_flags</code>. +</p> +<p> +If +<code class="constant">ai_flags</code> is set to -<SPAN -CLASS="TYPE" ->AI_NUMERICHOST</SPAN -> +<span class="type">AI_NUMERICHOST</span> it indicates that -<VAR -CLASS="PARAMETER" ->hostname</VAR -> +<em class="parameter"><code>hostname</code></em> should be treated as a numeric string defining an IPv4 or IPv6 address -and no name resolution should be attempted.</P -></DD -></DL -></DIV -></P -><P ->All other elements of the <SPAN -CLASS="TYPE" ->struct addrinfo</SPAN -> passed -via <VAR -CLASS="PARAMETER" ->hints</VAR -> must be zero.</P -><P ->A <VAR -CLASS="PARAMETER" ->hints</VAR -> of <SPAN -CLASS="TYPE" ->NULL</SPAN -> is treated as if -the caller provided a <SPAN -CLASS="TYPE" ->struct addrinfo</SPAN -> initialized to zero -with <CODE -CLASS="CONSTANT" ->ai_family</CODE ->set to -<CODE -CLASS="CONSTANT" ->PF_UNSPEC</CODE ->.</P -><P ->After a successful call to -<CODE -CLASS="FUNCTION" ->lwres_getaddrinfo()</CODE ->, -<VAR -CLASS="PARAMETER" ->*res</VAR -> +and no name resolution should be attempted. +</p> +</dd> +</dl></div> +<p> +</p> +<p> +All other elements of the <span class="type">struct addrinfo</span> passed +via <em class="parameter"><code>hints</code></em> must be zero. +</p> +<p> +A <em class="parameter"><code>hints</code></em> of <span class="type">NULL</span> is treated as if +the caller provided a <span class="type">struct addrinfo</span> initialized to zero +with <code class="constant">ai_family</code>set to +<code class="constant">PF_UNSPEC</code>. +</p> +<p> +After a successful call to +<code class="function">lwres_getaddrinfo()</code>, +<em class="parameter"><code>*res</code></em> is a pointer to a linked list of one or more -<SPAN -CLASS="TYPE" ->addrinfo</SPAN -> +<span class="type">addrinfo</span> structures. Each -<SPAN -CLASS="TYPE" ->struct addrinfo</SPAN -> +<span class="type">struct addrinfo</span> in this list cn be processed by following the -<CODE -CLASS="CONSTANT" ->ai_next</CODE -> +<code class="constant">ai_next</code> pointer, until a -<SPAN -CLASS="TYPE" ->NULL</SPAN -> +<span class="type">NULL</span> pointer is encountered. The three members -<CODE -CLASS="CONSTANT" ->ai_family</CODE ->, -<CODE -CLASS="CONSTANT" ->ai_socktype</CODE ->, +<code class="constant">ai_family</code>, +<code class="constant">ai_socktype</code>, and -<CODE -CLASS="CONSTANT" ->ai_protocol</CODE -> +<code class="constant">ai_protocol</code> in each returned -<SPAN -CLASS="TYPE" ->addrinfo</SPAN -> +<span class="type">addrinfo</span> structure contain the corresponding arguments for a call to -<SPAN -CLASS="CITEREFENTRY" -><SPAN -CLASS="REFENTRYTITLE" ->socket</SPAN ->(2)</SPAN ->. +<span class="citerefentry"><span class="refentrytitle">socket</span>(2)</span>. For each -<SPAN -CLASS="TYPE" ->addrinfo</SPAN -> +<span class="type">addrinfo</span> structure in the list, the -<CODE -CLASS="CONSTANT" ->ai_addr</CODE -> +<code class="constant">ai_addr</code> member points to a filled-in socket address structure of length -<CODE -CLASS="CONSTANT" ->ai_addrlen</CODE ->.</P -><P ->All of the information returned by -<CODE -CLASS="FUNCTION" ->lwres_getaddrinfo()</CODE -> +<code class="constant">ai_addrlen</code>. +</p> +<p> +All of the information returned by +<code class="function">lwres_getaddrinfo()</code> is dynamically allocated: the addrinfo structures, and the socket address structures and canonical host name strings pointed to by the -<CODE -CLASS="CONSTANT" ->addrinfo</CODE ->structures. +<code class="constant">addrinfo</code>structures. Memory allocated for the dynamically allocated structures created by a successful call to -<CODE -CLASS="FUNCTION" ->lwres_getaddrinfo()</CODE -> +<code class="function">lwres_getaddrinfo()</code> is released by -<CODE -CLASS="FUNCTION" ->lwres_freeaddrinfo()</CODE ->. -<VAR -CLASS="PARAMETER" ->ai</VAR -> +<code class="function">lwres_freeaddrinfo()</code>. +<em class="parameter"><code>ai</code></em> is a pointer to a -<SPAN -CLASS="TYPE" ->struct addrinfo</SPAN -> +<span class="type">struct addrinfo</span> created by a call to -<CODE -CLASS="FUNCTION" ->lwres_getaddrinfo()</CODE ->.</P -></DIV -><DIV -CLASS="REFSECT1" -><A -NAME="AEN142" -></A -><H2 ->RETURN VALUES</H2 -><P -><CODE -CLASS="FUNCTION" ->lwres_getaddrinfo()</CODE -> +<code class="function">lwres_getaddrinfo()</code>. +</p> +</div> +<div class="refsect1" lang="en"> +<a name="id2526309"></a><h2>RETURN VALUES</h2> +<p> +<code class="function">lwres_getaddrinfo()</code> returns zero on success or one of the error codes listed in -<SPAN -CLASS="CITEREFENTRY" -><SPAN -CLASS="REFENTRYTITLE" ->gai_strerror</SPAN ->(3)</SPAN -> +<span class="citerefentry"><span class="refentrytitle">gai_strerror</span>(3 +)</span> if an error occurs. If both -<VAR -CLASS="PARAMETER" ->hostname</VAR -> +<em class="parameter"><code>hostname</code></em> and -<VAR -CLASS="PARAMETER" ->servname</VAR -> +<em class="parameter"><code>servname</code></em> are -<SPAN -CLASS="TYPE" ->NULL</SPAN -> -<CODE -CLASS="FUNCTION" ->lwres_getaddrinfo()</CODE -> +<span class="type">NULL</span> +<code class="function">lwres_getaddrinfo()</code> returns -<SPAN -CLASS="ERRORCODE" ->EAI_NONAME</SPAN ->. </P -></DIV -><DIV -CLASS="REFSECT1" -><A -NAME="AEN154" -></A -><H2 ->SEE ALSO</H2 -><P -><SPAN -CLASS="CITEREFENTRY" -><SPAN -CLASS="REFENTRYTITLE" ->lwres</SPAN ->(3)</SPAN ->, +<span class="errorcode">EAI_NONAME</span>. + +</p> +</div> +<div class="refsect1" lang="en"> +<a name="id2526347"></a><h2>SEE ALSO</h2> +<p> +<span class="citerefentry"><span class="refentrytitle">lwres</span>(3)</span>, -<SPAN -CLASS="CITEREFENTRY" -><SPAN -CLASS="REFENTRYTITLE" ->lwres_getaddrinfo</SPAN ->(3)</SPAN ->, +<span class="citerefentry"><span class="refentrytitle">lwres_getaddrinfo</span>(3)</span>, -<SPAN -CLASS="CITEREFENTRY" -><SPAN -CLASS="REFENTRYTITLE" ->lwres_freeaddrinfo</SPAN ->(3)</SPAN ->, +<span class="citerefentry"><span class="refentrytitle">lwres_freeaddrinfo</span>(3)</span>, -<SPAN -CLASS="CITEREFENTRY" -><SPAN -CLASS="REFENTRYTITLE" ->lwres_gai_strerror</SPAN ->(3)</SPAN ->, +<span class="citerefentry"><span class="refentrytitle">lwres_gai_strerror</span>(3)</span>, -<SPAN -CLASS="CITEREFENTRY" -><SPAN -CLASS="REFENTRYTITLE" ->RFC2133</SPAN -></SPAN ->, +<span class="citerefentry"><span class="refentrytitle">RFC2133</span></span>, -<SPAN -CLASS="CITEREFENTRY" -><SPAN -CLASS="REFENTRYTITLE" ->getservbyname</SPAN ->(3)</SPAN ->, +<span class="citerefentry"><span class="refentrytitle">getservbyname</span>(3)</span>, -<SPAN -CLASS="CITEREFENTRY" -><SPAN -CLASS="REFENTRYTITLE" ->bind</SPAN ->(2)</SPAN ->, +<span class="citerefentry"><span class="refentrytitle">bind</span>(2)</span>, -<SPAN -CLASS="CITEREFENTRY" -><SPAN -CLASS="REFENTRYTITLE" ->connect</SPAN ->(2)</SPAN ->, +<span class="citerefentry"><span class="refentrytitle">connect</span>(2)</span>, -<SPAN -CLASS="CITEREFENTRY" -><SPAN -CLASS="REFENTRYTITLE" ->sendto</SPAN ->(2)</SPAN ->, +<span class="citerefentry"><span class="refentrytitle">sendto</span>(2)</span>, -<SPAN -CLASS="CITEREFENTRY" -><SPAN -CLASS="REFENTRYTITLE" ->sendmsg</SPAN ->(2)</SPAN ->, +<span class="citerefentry"><span class="refentrytitle">sendmsg</span>(2)</span>, -<SPAN -CLASS="CITEREFENTRY" -><SPAN -CLASS="REFENTRYTITLE" ->socket</SPAN ->(2)</SPAN ->.</P -></DIV -></BODY -></HTML -> +<span class="citerefentry"><span class="refentrytitle">socket</span>(2)</span>. +</p> +</div> +</div></body> +</html> diff --git a/contrib/bind9/lib/lwres/man/lwres_gethostent.3 b/contrib/bind9/lib/lwres/man/lwres_gethostent.3 index 5a42347..99dc533 100644 --- a/contrib/bind9/lib/lwres/man/lwres_gethostent.3 +++ b/contrib/bind9/lib/lwres/man/lwres_gethostent.3 @@ -1,89 +1,64 @@ -.\" Copyright (C) 2004 Internet Systems Consortium, Inc. ("ISC") -.\" Copyright (C) 2001 Internet Software Consortium. -.\" +.\" Copyright (C) 2004, 2005 Internet Systems Consortium, Inc. ("ISC") +.\" Copyright (C) 2001 Internet Software Consortium. +.\" .\" Permission to use, copy, modify, and distribute this software for any .\" purpose with or without fee is hereby granted, provided that the above .\" copyright notice and this permission notice appear in all copies. -.\" +.\" .\" THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH .\" REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY -.\" AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT, +.\" AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT, .\" INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM .\" LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE .\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR .\" PERFORMANCE OF THIS SOFTWARE. .\" -.\" $Id: lwres_gethostent.3,v 1.16.2.1.8.1 2004/03/06 07:41:43 marka Exp $ +.\" $Id: lwres_gethostent.3,v 1.16.2.1.8.5 2005/10/13 02:33:53 marka Exp $ .\" -.TH "LWRES_GETHOSTENT" "3" "Jun 30, 2000" "BIND9" "" -.SH NAME +.hy 0 +.ad l +.\" ** You probably do not want to edit this file directly ** +.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1). +.\" Instead of manually editing it, you probably should edit the DocBook XML +.\" source for it and then use the DocBook XSL Stylesheets to regenerate it. +.TH "LWRES_GETHOSTENT" "3" "Jun 30, 2000" "BIND9" "BIND9" +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.SH "NAME" lwres_gethostbyname, lwres_gethostbyname2, lwres_gethostbyaddr, lwres_gethostent, lwres_sethostent, lwres_endhostent, lwres_gethostbyname_r, lwres_gethostbyaddr_r, lwres_gethostent_r, lwres_sethostent_r, lwres_endhostent_r \- lightweight resolver get network host entry -.SH SYNOPSIS -\fB#include <lwres/netdb.h> -.sp -.na -struct hostent * -lwres_gethostbyname(const char *name); -.ad -.sp -.na -struct hostent * -lwres_gethostbyname2(const char *name, int af); -.ad -.sp -.na -struct hostent * -lwres_gethostbyaddr(const char *addr, int len, int type); -.ad -.sp -.na -struct hostent * -lwres_gethostent(void); -.ad -.sp -.na -void -lwres_sethostent(int stayopen); -.ad -.sp -.na -void -lwres_endhostent(void); -.ad -.sp -.na -struct hostent * -lwres_gethostbyname_r(const char *name, struct hostent *resbuf, char *buf, int buflen, int *error); -.ad -.sp -.na -struct hostent * -lwres_gethostbyaddr_r(const char *addr, int len, int type, struct hostent *resbuf, char *buf, int buflen, int *error); -.ad -.sp -.na -struct hostent * -lwres_gethostent_r(struct hostent *resbuf, char *buf, int buflen, int *error); -.ad -.sp -.na -void -lwres_sethostent_r(int stayopen); -.ad -.sp -.na -void -lwres_endhostent_r(void); -.ad -\fR +.SH "SYNOPSIS" +.nf +#include <lwres/netdb.h> +.fi +.HP 37 +\fBstruct\ hostent\ *\ \fBlwres_gethostbyname\fR\fR\fB(\fR\fBconst\ char\ *name\fR\fB);\fR +.HP 38 +\fBstruct\ hostent\ *\ \fBlwres_gethostbyname2\fR\fR\fB(\fR\fBconst\ char\ *name\fR\fB, \fR\fBint\ af\fR\fB);\fR +.HP 37 +\fBstruct\ hostent\ *\ \fBlwres_gethostbyaddr\fR\fR\fB(\fR\fBconst\ char\ *addr\fR\fB, \fR\fBint\ len\fR\fB, \fR\fBint\ type\fR\fB);\fR +.HP 34 +\fBstruct\ hostent\ *\ \fBlwres_gethostent\fR\fR\fB(\fR\fBvoid\fR\fB);\fR +.HP 22 +\fBvoid\ \fBlwres_sethostent\fR\fR\fB(\fR\fBint\ stayopen\fR\fB);\fR +.HP 22 +\fBvoid\ \fBlwres_endhostent\fR\fR\fB(\fR\fBvoid\fR\fB);\fR +.HP 39 +\fBstruct\ hostent\ *\ \fBlwres_gethostbyname_r\fR\fR\fB(\fR\fBconst\ char\ *name\fR\fB, \fR\fBstruct\ hostent\ *resbuf\fR\fB, \fR\fBchar\ *buf\fR\fB, \fR\fBint\ buflen\fR\fB, \fR\fBint\ *error\fR\fB);\fR +.HP 39 +\fBstruct\ hostent\ *\ \fBlwres_gethostbyaddr_r\fR\fR\fB(\fR\fBconst\ char\ *addr\fR\fB, \fR\fBint\ len\fR\fB, \fR\fBint\ type\fR\fB, \fR\fBstruct\ hostent\ *resbuf\fR\fB, \fR\fBchar\ *buf\fR\fB, \fR\fBint\ buflen\fR\fB, \fR\fBint\ *error\fR\fB);\fR +.HP 36 +\fBstruct\ hostent\ *\ \fBlwres_gethostent_r\fR\fR\fB(\fR\fBstruct\ hostent\ *resbuf\fR\fB, \fR\fBchar\ *buf\fR\fB, \fR\fBint\ buflen\fR\fB, \fR\fBint\ *error\fR\fB);\fR +.HP 24 +\fBvoid\ \fBlwres_sethostent_r\fR\fR\fB(\fR\fBint\ stayopen\fR\fB);\fR +.HP 24 +\fBvoid\ \fBlwres_endhostent_r\fR\fR\fB(\fR\fBvoid\fR\fB);\fR .SH "DESCRIPTION" .PP -These functions provide hostname-to-address and -address-to-hostname lookups by means of the lightweight resolver. -They are similar to the standard -\fBgethostent\fR(3) -functions provided by most operating systems. -They use a +These functions provide hostname\-to\-address and address\-to\-hostname lookups by means of the lightweight resolver. They are similar to the standard +\fBgethostent\fR(3 ) +functions provided by most operating systems. They use a \fBstruct hostent\fR which is usually defined in \fI<namedb.h>\fR. @@ -97,8 +72,8 @@ struct hostent { char **h_addr_list; /* list of addresses from name server */ }; #define h_addr h_addr_list[0] /* address, for backward compatibility */ -.sp .fi +.sp .PP The members of this structure are: .TP @@ -106,7 +81,7 @@ The members of this structure are: The official (canonical) name of the host. .TP \fBh_aliases\fR -A NULL-terminated array of alternate names (nicknames) for the host. +A NULL\-terminated array of alternate names (nicknames) for the host. .TP \fBh_addrtype\fR The type of address being returned \(em @@ -118,14 +93,14 @@ or The length of the address in bytes. .TP \fBh_addr_list\fR -A \fBNULL\fR -terminated array of network addresses for the host. -Host addresses are returned in network byte order. +A +\fBNULL\fR +terminated array of network addresses for the host. Host addresses are returned in network byte order. .PP For backward compatibility with very old software, -h_addr +\fBh_addr\fR is the first address in -h_addr_list. +\fBh_addr_list.\fR .PP \fBlwres_gethostent()\fR, \fBlwres_sethostent()\fR, @@ -134,72 +109,109 @@ h_addr_list. \fBlwres_sethostent_r()\fR and \fBlwres_endhostent_r()\fR -provide iteration over the known host entries on systems that -provide such functionality through facilities like +provide iteration over the known host entries on systems that provide such functionality through facilities like \fI/etc/hosts\fR -or NIS. The lightweight resolver does not currently implement -these functions; it only provides them as stub functions that always -return failure. +or NIS. The lightweight resolver does not currently implement these functions; it only provides them as stub functions that always return failure. .PP -\fBlwres_gethostbyname()\fR and -\fBlwres_gethostbyname2()\fR look up the hostname +\fBlwres_gethostbyname()\fR +and +\fBlwres_gethostbyname2()\fR +look up the hostname \fIname\fR. -\fBlwres_gethostbyname()\fR always looks for an IPv4 -address while \fBlwres_gethostbyname2()\fR looks for an -address of protocol family \fIaf\fR: either -\fBPF_INET\fR or \fBPF_INET6\fR \(em IPv4 or IPV6 -addresses respectively. Successful calls of the functions return a +\fBlwres_gethostbyname()\fR +always looks for an IPv4 address while +\fBlwres_gethostbyname2()\fR +looks for an address of protocol family +\fIaf\fR: either +\fBPF_INET\fR +or +\fBPF_INET6\fR +\(em IPv4 or IPV6 addresses respectively. Successful calls of the functions return a \fBstruct hostent\fRfor the name that was looked up. -\fBNULL\fR is returned if the lookups by -\fBlwres_gethostbyname()\fR or -\fBlwres_gethostbyname2()\fR fail. +\fBNULL\fR +is returned if the lookups by +\fBlwres_gethostbyname()\fR +or +\fBlwres_gethostbyname2()\fR +fail. .PP Reverse lookups of addresses are performed by \fBlwres_gethostbyaddr()\fR. -\fIaddr\fR is an address of length -\fIlen\fR bytes and protocol family -\fItype\fR \(em \fBPF_INET\fR or +\fIaddr\fR +is an address of length +\fIlen\fR +bytes and protocol family +\fItype\fR +\(em +\fBPF_INET\fR +or \fBPF_INET6\fR. -\fBlwres_gethostbyname_r()\fR is a thread-safe function -for forward lookups. If an error occurs, an error code is returned in +\fBlwres_gethostbyname_r()\fR +is a thread\-safe function for forward lookups. If an error occurs, an error code is returned in \fI*error\fR. -\fIresbuf\fR is a pointer to a \fBstruct -hostent\fR which is initialised by a successful call to -\fBlwres_gethostbyname_r()\fR . -\fIbuf\fR is a buffer of length -\fIlen\fR bytes which is used to store the -h_name, h_aliases, and -h_addr_list elements of the \fBstruct -hostent\fR returned in \fIresbuf\fR. -Successful calls to \fBlwres_gethostbyname_r()\fR -return \fIresbuf\fR, -which is a pointer to the \fBstruct hostent\fR it created. +\fIresbuf\fR +is a pointer to a +\fBstruct hostent\fR +which is initialised by a successful call to +\fBlwres_gethostbyname_r()\fR +. +\fIbuf\fR +is a buffer of length +\fIlen\fR +bytes which is used to store the +\fBh_name\fR, +\fBh_aliases\fR, and +\fBh_addr_list\fR +elements of the +\fBstruct hostent\fR +returned in +\fIresbuf\fR. Successful calls to +\fBlwres_gethostbyname_r()\fR +return +\fIresbuf\fR, which is a pointer to the +\fBstruct hostent\fR +it created. .PP -\fBlwres_gethostbyaddr_r()\fR is a thread-safe function -that performs a reverse lookup of address \fIaddr\fR -which is \fIlen\fR bytes long and is of protocol -family \fItype\fR \(em \fBPF_INET\fR or -\fBPF_INET6\fR. If an error occurs, the error code is returned -in \fI*error\fR. The other function parameters are -identical to those in \fBlwres_gethostbyname_r()\fR. -\fIresbuf\fR is a pointer to a \fBstruct -hostent\fR which is initialised by a successful call to +\fBlwres_gethostbyaddr_r()\fR +is a thread\-safe function that performs a reverse lookup of address +\fIaddr\fR +which is +\fIlen\fR +bytes long and is of protocol family +\fItype\fR +\(em +\fBPF_INET\fR +or +\fBPF_INET6\fR. If an error occurs, the error code is returned in +\fI*error\fR. The other function parameters are identical to those in +\fBlwres_gethostbyname_r()\fR. +\fIresbuf\fR +is a pointer to a +\fBstruct hostent\fR +which is initialised by a successful call to \fBlwres_gethostbyaddr_r()\fR. -\fIbuf\fR is a buffer of length -\fIlen\fR bytes which is used to store the -h_name, h_aliases, and -h_addr_list elements of the \fBstruct -hostent\fR returned in \fIresbuf\fR. Successful -calls to \fBlwres_gethostbyaddr_r()\fR return +\fIbuf\fR +is a buffer of length +\fIlen\fR +bytes which is used to store the +\fBh_name\fR, +\fBh_aliases\fR, and +\fBh_addr_list\fR +elements of the +\fBstruct hostent\fR +returned in +\fIresbuf\fR. Successful calls to +\fBlwres_gethostbyaddr_r()\fR +return \fIresbuf\fR, which is a pointer to the -\fBstruct hostent()\fR it created. +\fBstruct hostent()\fR +it created. .SH "RETURN VALUES" .PP The functions \fBlwres_gethostbyname()\fR, \fBlwres_gethostbyname2()\fR, -\fBlwres_gethostbyaddr()\fR, -and +\fBlwres_gethostbyaddr()\fR, and \fBlwres_gethostent()\fR return NULL to indicate an error. In this case the global variable \fBlwres_h_errno\fR @@ -210,20 +222,15 @@ will contain one of the following error codes defined in The host or address was not found. .TP \fBTRY_AGAIN\fR -A recoverable error occurred, e.g., a timeout. -Retrying the lookup may succeed. +A recoverable error occurred, e.g., a timeout. Retrying the lookup may succeed. .TP \fBNO_RECOVERY\fR -A non-recoverable error occurred. +A non\-recoverable error occurred. .TP \fBNO_DATA\fR -The name exists, but has no address information -associated with it (or vice versa in the case -of a reverse lookup). The code NO_ADDRESS -is accepted as a synonym for NO_DATA for backwards -compatibility. +The name exists, but has no address information associated with it (or vice versa in the case of a reverse lookup). The code NO_ADDRESS is accepted as a synonym for NO_DATA for backwards compatibility. .PP -\fBlwres_hstrerror\fR(3) +\fBlwres_hstrerror\fR(3 ) translates these error codes to suitable error messages. .PP \fBlwres_gethostent()\fR @@ -232,23 +239,37 @@ and always return \fBNULL\fR. .PP -Successful calls to \fBlwres_gethostbyname_r()\fR and -\fBlwres_gethostbyaddr_r()\fR return -\fIresbuf\fR, a pointer to the \fBstruct -hostent\fR that was initialised by these functions. They return -\fBNULL\fR if the lookups fail or if \fIbuf\fR -was too small to hold the list of addresses and names referenced by -the h_name, h_aliases, and -h_addr_list elements of the \fBstruct -hostent\fR. If \fIbuf\fR was too small, both -\fBlwres_gethostbyname_r()\fR and -\fBlwres_gethostbyaddr_r()\fR set the global variable -\fBerrno\fR to ERANGE. +Successful calls to +\fBlwres_gethostbyname_r()\fR +and +\fBlwres_gethostbyaddr_r()\fR +return +\fIresbuf\fR, a pointer to the +\fBstruct hostent\fR +that was initialised by these functions. They return +\fBNULL\fR +if the lookups fail or if +\fIbuf\fR +was too small to hold the list of addresses and names referenced by the +\fBh_name\fR, +\fBh_aliases\fR, and +\fBh_addr_list\fR +elements of the +\fBstruct hostent\fR. If +\fIbuf\fR +was too small, both +\fBlwres_gethostbyname_r()\fR +and +\fBlwres_gethostbyaddr_r()\fR +set the global variable +\fBerrno\fR +to +\fBERANGE\fR. .SH "SEE ALSO" .PP \fBgethostent\fR(3), \fBlwres_getipnode\fR(3), -\fBlwres_hstrerror\fR(3) +\fBlwres_hstrerror\fR(3 ) .SH "BUGS" .PP \fBlwres_gethostbyname()\fR, @@ -256,17 +277,12 @@ hostent\fR. If \fIbuf\fR was too small, both \fBlwres_gethostbyaddr()\fR and \fBlwres_endhostent()\fR -are not thread safe; they return pointers to static data and -provide error codes through a global variable. -Thread-safe versions for name and address lookup are provided by -\fBlwres_gethostbyname_r()\fR, -and +are not thread safe; they return pointers to static data and provide error codes through a global variable. Thread\-safe versions for name and address lookup are provided by +\fBlwres_gethostbyname_r()\fR, and \fBlwres_gethostbyaddr_r()\fR respectively. .PP -The resolver daemon does not currently support any non-DNS -name services such as +The resolver daemon does not currently support any non\-DNS name services such as \fI/etc/hosts\fR or -\fBNIS\fR, -consequently the above functions don't, either. +\fBNIS\fR, consequently the above functions don't, either. diff --git a/contrib/bind9/lib/lwres/man/lwres_gethostent.docbook b/contrib/bind9/lib/lwres/man/lwres_gethostent.docbook index 10324c3..9f92d3b 100644 --- a/contrib/bind9/lib/lwres/man/lwres_gethostent.docbook +++ b/contrib/bind9/lib/lwres/man/lwres_gethostent.docbook @@ -1,6 +1,8 @@ -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.0//EN" + "http://www.oasis-open.org/docbook/xml/4.0/docbookx.dtd" + [<!ENTITY mdash "—">]> <!-- - - Copyright (C) 2004 Internet Systems Consortium, Inc. ("ISC") + - Copyright (C) 2004, 2005 Internet Systems Consortium, Inc. ("ISC") - Copyright (C) 2001 Internet Software Consortium. - - Permission to use, copy, modify, and distribute this software for any @@ -16,7 +18,7 @@ - PERFORMANCE OF THIS SOFTWARE. --> -<!-- $Id: lwres_gethostent.docbook,v 1.5.206.1 2004/03/06 08:15:39 marka Exp $ --> +<!-- $Id: lwres_gethostent.docbook,v 1.5.206.3 2005/05/13 01:22:36 marka Exp $ --> <refentry> @@ -30,6 +32,18 @@ <refmiscinfo>BIND9</refmiscinfo> </refmeta> + <docinfo> + <copyright> + <year>2004</year> + <year>2005</year> + <holder>Internet Systems Consortium, Inc. ("ISC")</holder> + </copyright> + <copyright> + <year>2001</year> + <holder>Internet Software Consortium.</holder> + </copyright> + </docinfo> + <refnamediv> <refname>lwres_gethostbyname</refname> <refname>lwres_gethostbyname2</refname> diff --git a/contrib/bind9/lib/lwres/man/lwres_gethostent.html b/contrib/bind9/lib/lwres/man/lwres_gethostent.html index 00b285d..263f993 100644 --- a/contrib/bind9/lib/lwres/man/lwres_gethostent.html +++ b/contrib/bind9/lib/lwres/man/lwres_gethostent.html @@ -1,784 +1,430 @@ <!-- - - Copyright (C) 2004 Internet Systems Consortium, Inc. ("ISC") - - Copyright (C) 2001 Internet Software Consortium. - - + - Copyright (C) 2004, 2005 Internet Systems Consortium, Inc. ("ISC") + - Copyright (C) 2001 Internet Software Consortium. + - - Permission to use, copy, modify, and distribute this software for any - purpose with or without fee is hereby granted, provided that the above - copyright notice and this permission notice appear in all copies. - - + - - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY - - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT, + - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT, - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> - -<!-- $Id: lwres_gethostent.html,v 1.8.2.1.4.2 2004/08/22 23:39:04 marka Exp $ --> - -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<HTML -><HEAD -><TITLE ->lwres_gethostent</TITLE -><META -NAME="GENERATOR" -CONTENT="Modular DocBook HTML Stylesheet Version 1.7"></HEAD -><BODY -CLASS="REFENTRY" -BGCOLOR="#FFFFFF" -TEXT="#000000" -LINK="#0000FF" -VLINK="#840084" -ALINK="#0000FF" -><H1 -><A -NAME="AEN1" -></A ->lwres_gethostent</H1 -><DIV -CLASS="REFNAMEDIV" -><A -NAME="AEN8" -></A -><H2 ->Name</H2 ->lwres_gethostbyname, lwres_gethostbyname2, lwres_gethostbyaddr, lwres_gethostent, lwres_sethostent, lwres_endhostent, lwres_gethostbyname_r, lwres_gethostbyaddr_r, lwres_gethostent_r, lwres_sethostent_r, lwres_endhostent_r -- lightweight resolver get network host entry</DIV -><DIV -CLASS="REFSYNOPSISDIV" -><A -NAME="AEN21" -></A -><H2 ->Synopsis</H2 -><DIV -CLASS="FUNCSYNOPSIS" -><P -></P -><A -NAME="AEN22" -></A -><PRE -CLASS="FUNCSYNOPSISINFO" ->#include <lwres/netdb.h></PRE -><P -><CODE -><CODE -CLASS="FUNCDEF" ->struct hostent * -lwres_gethostbyname</CODE ->(const char *name);</CODE -></P -><P -><CODE -><CODE -CLASS="FUNCDEF" ->struct hostent * -lwres_gethostbyname2</CODE ->(const char *name, int af);</CODE -></P -><P -><CODE -><CODE -CLASS="FUNCDEF" ->struct hostent * -lwres_gethostbyaddr</CODE ->(const char *addr, int len, int type);</CODE -></P -><P -><CODE -><CODE -CLASS="FUNCDEF" ->struct hostent * -lwres_gethostent</CODE ->(void);</CODE -></P -><P -><CODE -><CODE -CLASS="FUNCDEF" ->void -lwres_sethostent</CODE ->(int stayopen);</CODE -></P -><P -><CODE -><CODE -CLASS="FUNCDEF" ->void -lwres_endhostent</CODE ->(void);</CODE -></P -><P -><CODE -><CODE -CLASS="FUNCDEF" ->struct hostent * -lwres_gethostbyname_r</CODE ->(const char *name, struct hostent *resbuf, char *buf, int buflen, int *error);</CODE -></P -><P -><CODE -><CODE -CLASS="FUNCDEF" ->struct hostent * -lwres_gethostbyaddr_r</CODE ->(const char *addr, int len, int type, struct hostent *resbuf, char *buf, int buflen, int *error);</CODE -></P -><P -><CODE -><CODE -CLASS="FUNCDEF" ->struct hostent * -lwres_gethostent_r</CODE ->(struct hostent *resbuf, char *buf, int buflen, int *error);</CODE -></P -><P -><CODE -><CODE -CLASS="FUNCDEF" ->void -lwres_sethostent_r</CODE ->(int stayopen);</CODE -></P -><P -><CODE -><CODE -CLASS="FUNCDEF" ->void -lwres_endhostent_r</CODE ->(void);</CODE -></P -><P -></P -></DIV -></DIV -><DIV -CLASS="REFSECT1" -><A -NAME="AEN84" -></A -><H2 ->DESCRIPTION</H2 -><P ->These functions provide hostname-to-address and +<!-- $Id: lwres_gethostent.html,v 1.8.2.1.4.8 2005/10/13 02:33:56 marka Exp $ --> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> +<title>lwres_gethostent</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.69.1"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"> +<a name="id2463721"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2>Name</h2> +<p>lwres_gethostbyname, lwres_gethostbyname2, lwres_gethostbyaddr, lwres_gethostent, lwres_sethostent, lwres_endhostent, lwres_gethostbyname_r, lwres_gethostbyaddr_r, lwres_gethostent_r, lwres_sethostent_r, lwres_endhostent_r — lightweight resolver get network host entry</p> +</div> +<div class="refsynopsisdiv"> +<h2>Synopsis</h2> +<div class="funcsynopsis"> +<pre class="funcsynopsisinfo">#include <lwres/netdb.h></pre> +<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em"><tr> +<td><code class="funcdef"> +struct hostent * +<b class="fsfunc">lwres_gethostbyname</b>(</code></td> +<td> </td> +<td> +<code>)</code>;</td> +</tr></table> +<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em"> +<tr> +<td><code class="funcdef"> +struct hostent * +<b class="fsfunc">lwres_gethostbyname2</b>(</code></td> +<td> </td> +<td>, </td> +</tr> +<tr> +<td> </td> +<td> </td> +<td> +<code>)</code>;</td> +</tr> +</table> +<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em"> +<tr> +<td><code class="funcdef"> +struct hostent * +<b class="fsfunc">lwres_gethostbyaddr</b>(</code></td> +<td> </td> +<td>, </td> +</tr> +<tr> +<td> </td> +<td> </td> +<td>, </td> +</tr> +<tr> +<td> </td> +<td> </td> +<td> +<code>)</code>;</td> +</tr> +</table> +<p><code class="funcdef"> +struct hostent * +<b class="fsfunc">lwres_gethostent</b>(</code>void<code>)</code>;</p> +<p><code class="funcdef"> +void +<b class="fsfunc">lwres_sethostent</b>(</code>int stayopen<code>)</code>;</p> +<p><code class="funcdef"> +void +<b class="fsfunc">lwres_endhostent</b>(</code>void<code>)</code>;</p> +<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em"> +<tr> +<td><code class="funcdef"> +struct hostent * +<b class="fsfunc">lwres_gethostbyname_r</b>(</code></td> +<td> </td> +<td>, </td> +</tr> +<tr> +<td> </td> +<td> </td> +<td>, </td> +</tr> +<tr> +<td> </td> +<td> </td> +<td>, </td> +</tr> +<tr> +<td> </td> +<td> </td> +<td>, </td> +</tr> +<tr> +<td> </td> +<td> </td> +<td> +<code>)</code>;</td> +</tr> +</table> +<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em"> +<tr> +<td><code class="funcdef"> +struct hostent * +<b class="fsfunc">lwres_gethostbyaddr_r</b>(</code></td> +<td> </td> +<td>, </td> +</tr> +<tr> +<td> </td> +<td> </td> +<td>, </td> +</tr> +<tr> +<td> </td> +<td> </td> +<td>, </td> +</tr> +<tr> +<td> </td> +<td> </td> +<td>, </td> +</tr> +<tr> +<td> </td> +<td> </td> +<td>, </td> +</tr> +<tr> +<td> </td> +<td> </td> +<td>, </td> +</tr> +<tr> +<td> </td> +<td> </td> +<td> +<code>)</code>;</td> +</tr> +</table> +<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em"> +<tr> +<td><code class="funcdef"> +struct hostent * +<b class="fsfunc">lwres_gethostent_r</b>(</code></td> +<td> </td> +<td>, </td> +</tr> +<tr> +<td> </td> +<td> </td> +<td>, </td> +</tr> +<tr> +<td> </td> +<td> </td> +<td>, </td> +</tr> +<tr> +<td> </td> +<td> </td> +<td> +<code>)</code>;</td> +</tr> +</table> +<p><code class="funcdef"> +void +<b class="fsfunc">lwres_sethostent_r</b>(</code>int stayopen<code>)</code>;</p> +<p><code class="funcdef"> +void +<b class="fsfunc">lwres_endhostent_r</b>(</code>void<code>)</code>;</p> +</div> +</div> +<div class="refsect1" lang="en"> +<a name="id2526041"></a><h2>DESCRIPTION</h2> +<p> +These functions provide hostname-to-address and address-to-hostname lookups by means of the lightweight resolver. They are similar to the standard -<SPAN -CLASS="CITEREFENTRY" -><SPAN -CLASS="REFENTRYTITLE" ->gethostent</SPAN ->(3)</SPAN -> +<span class="citerefentry"><span class="refentrytitle">gethostent</span>(3 +)</span> functions provided by most operating systems. They use a -<SPAN -CLASS="TYPE" ->struct hostent</SPAN -> +<span class="type">struct hostent</span> which is usually defined in -<TT -CLASS="FILENAME" -><namedb.h></TT ->. +<code class="filename"><namedb.h></code>. -<PRE -CLASS="PROGRAMLISTING" ->struct hostent { +</p> +<pre class="programlisting"> +struct hostent { char *h_name; /* official name of host */ char **h_aliases; /* alias list */ int h_addrtype; /* host address type */ int h_length; /* length of address */ char **h_addr_list; /* list of addresses from name server */ }; -#define h_addr h_addr_list[0] /* address, for backward compatibility */</PRE -></P -><P ->The members of this structure are: -<P -></P -><DIV -CLASS="VARIABLELIST" -><DL -><DT -><CODE -CLASS="CONSTANT" ->h_name</CODE -></DT -><DD -><P ->The official (canonical) name of the host.</P -></DD -><DT -><CODE -CLASS="CONSTANT" ->h_aliases</CODE -></DT -><DD -><P ->A NULL-terminated array of alternate names (nicknames) for the host.</P -></DD -><DT -><CODE -CLASS="CONSTANT" ->h_addrtype</CODE -></DT -><DD -><P ->The type of address being returned — -<SPAN -CLASS="TYPE" ->PF_INET</SPAN -> +#define h_addr h_addr_list[0] /* address, for backward compatibility */ +</pre> +<p> +</p> +<p> +The members of this structure are: +</p> +<div class="variablelist"><dl> +<dt><span class="term"><code class="constant">h_name</code></span></dt> +<dd><p> +The official (canonical) name of the host. +</p></dd> +<dt><span class="term"><code class="constant">h_aliases</code></span></dt> +<dd><p> +A NULL-terminated array of alternate names (nicknames) for the host. +</p></dd> +<dt><span class="term"><code class="constant">h_addrtype</code></span></dt> +<dd><p> +The type of address being returned — +<span class="type">PF_INET</span> or -<SPAN -CLASS="TYPE" ->PF_INET6</SPAN ->.</P -></DD -><DT -><CODE -CLASS="CONSTANT" ->h_length</CODE -></DT -><DD -><P ->The length of the address in bytes.</P -></DD -><DT -><CODE -CLASS="CONSTANT" ->h_addr_list</CODE -></DT -><DD -><P ->A <SPAN -CLASS="TYPE" ->NULL</SPAN -> +<span class="type">PF_INET6</span>. +</p></dd> +<dt><span class="term"><code class="constant">h_length</code></span></dt> +<dd><p> +The length of the address in bytes. +</p></dd> +<dt><span class="term"><code class="constant">h_addr_list</code></span></dt> +<dd><p> +A <span class="type">NULL</span> terminated array of network addresses for the host. -Host addresses are returned in network byte order.</P -></DD -></DL -></DIV -></P -><P ->For backward compatibility with very old software, -<CODE -CLASS="CONSTANT" ->h_addr</CODE -> +Host addresses are returned in network byte order. +</p></dd> +</dl></div> +<p> +</p> +<p> +For backward compatibility with very old software, +<code class="constant">h_addr</code> is the first address in -<CODE -CLASS="CONSTANT" ->h_addr_list.</CODE -></P -><P -><CODE -CLASS="FUNCTION" ->lwres_gethostent()</CODE ->, -<CODE -CLASS="FUNCTION" ->lwres_sethostent()</CODE ->, -<CODE -CLASS="FUNCTION" ->lwres_endhostent()</CODE ->, -<CODE -CLASS="FUNCTION" ->lwres_gethostent_r()</CODE ->, -<CODE -CLASS="FUNCTION" ->lwres_sethostent_r()</CODE -> +<code class="constant">h_addr_list.</code> +</p> +<p> +<code class="function">lwres_gethostent()</code>, +<code class="function">lwres_sethostent()</code>, +<code class="function">lwres_endhostent()</code>, +<code class="function">lwres_gethostent_r()</code>, +<code class="function">lwres_sethostent_r()</code> and -<CODE -CLASS="FUNCTION" ->lwres_endhostent_r()</CODE -> +<code class="function">lwres_endhostent_r()</code> provide iteration over the known host entries on systems that provide such functionality through facilities like -<TT -CLASS="FILENAME" ->/etc/hosts</TT -> +<code class="filename">/etc/hosts</code> or NIS. The lightweight resolver does not currently implement these functions; it only provides them as stub functions that always -return failure.</P -><P -><CODE -CLASS="FUNCTION" ->lwres_gethostbyname()</CODE -> and -<CODE -CLASS="FUNCTION" ->lwres_gethostbyname2()</CODE -> look up the hostname -<VAR -CLASS="PARAMETER" ->name</VAR ->. -<CODE -CLASS="FUNCTION" ->lwres_gethostbyname()</CODE -> always looks for an IPv4 -address while <CODE -CLASS="FUNCTION" ->lwres_gethostbyname2()</CODE -> looks for an -address of protocol family <VAR -CLASS="PARAMETER" ->af</VAR ->: either -<SPAN -CLASS="TYPE" ->PF_INET</SPAN -> or <SPAN -CLASS="TYPE" ->PF_INET6</SPAN -> — IPv4 or IPV6 +return failure. +</p> +<p> +<code class="function">lwres_gethostbyname()</code> and +<code class="function">lwres_gethostbyname2()</code> look up the hostname +<em class="parameter"><code>name</code></em>. +<code class="function">lwres_gethostbyname()</code> always looks for an IPv4 +address while <code class="function">lwres_gethostbyname2()</code> looks for an +address of protocol family <em class="parameter"><code>af</code></em>: either +<span class="type">PF_INET</span> or <span class="type">PF_INET6</span> — IPv4 or IPV6 addresses respectively. Successful calls of the functions return a -<SPAN -CLASS="TYPE" ->struct hostent</SPAN ->for the name that was looked up. -<SPAN -CLASS="TYPE" ->NULL</SPAN -> is returned if the lookups by -<CODE -CLASS="FUNCTION" ->lwres_gethostbyname()</CODE -> or -<CODE -CLASS="FUNCTION" ->lwres_gethostbyname2()</CODE -> fail.</P -><P ->Reverse lookups of addresses are performed by -<CODE -CLASS="FUNCTION" ->lwres_gethostbyaddr()</CODE ->. -<VAR -CLASS="PARAMETER" ->addr</VAR -> is an address of length -<VAR -CLASS="PARAMETER" ->len</VAR -> bytes and protocol family -<VAR -CLASS="PARAMETER" ->type</VAR -> — <SPAN -CLASS="TYPE" ->PF_INET</SPAN -> or -<SPAN -CLASS="TYPE" ->PF_INET6</SPAN ->. -<CODE -CLASS="FUNCTION" ->lwres_gethostbyname_r()</CODE -> is a thread-safe function +<span class="type">struct hostent</span>for the name that was looked up. +<span class="type">NULL</span> is returned if the lookups by +<code class="function">lwres_gethostbyname()</code> or +<code class="function">lwres_gethostbyname2()</code> fail. +</p> +<p> +Reverse lookups of addresses are performed by +<code class="function">lwres_gethostbyaddr()</code>. +<em class="parameter"><code>addr</code></em> is an address of length +<em class="parameter"><code>len</code></em> bytes and protocol family +<em class="parameter"><code>type</code></em> — <span class="type">PF_INET</span> or +<span class="type">PF_INET6</span>. +<code class="function">lwres_gethostbyname_r()</code> is a thread-safe function for forward lookups. If an error occurs, an error code is returned in -<VAR -CLASS="PARAMETER" ->*error</VAR ->. -<VAR -CLASS="PARAMETER" ->resbuf</VAR -> is a pointer to a <SPAN -CLASS="TYPE" ->struct -hostent</SPAN -> which is initialised by a successful call to -<CODE -CLASS="FUNCTION" ->lwres_gethostbyname_r()</CODE -> . -<VAR -CLASS="PARAMETER" ->buf</VAR -> is a buffer of length -<VAR -CLASS="PARAMETER" ->len</VAR -> bytes which is used to store the -<CODE -CLASS="CONSTANT" ->h_name</CODE ->, <CODE -CLASS="CONSTANT" ->h_aliases</CODE ->, and -<CODE -CLASS="CONSTANT" ->h_addr_list</CODE -> elements of the <SPAN -CLASS="TYPE" ->struct -hostent</SPAN -> returned in <VAR -CLASS="PARAMETER" ->resbuf</VAR ->. -Successful calls to <CODE -CLASS="FUNCTION" ->lwres_gethostbyname_r()</CODE -> -return <VAR -CLASS="PARAMETER" ->resbuf</VAR ->, -which is a pointer to the <SPAN -CLASS="TYPE" ->struct hostent</SPAN -> it created.</P -><P -><CODE -CLASS="FUNCTION" ->lwres_gethostbyaddr_r()</CODE -> is a thread-safe function -that performs a reverse lookup of address <VAR -CLASS="PARAMETER" ->addr</VAR -> -which is <VAR -CLASS="PARAMETER" ->len</VAR -> bytes long and is of protocol -family <VAR -CLASS="PARAMETER" ->type</VAR -> — <SPAN -CLASS="TYPE" ->PF_INET</SPAN -> or -<SPAN -CLASS="TYPE" ->PF_INET6</SPAN ->. If an error occurs, the error code is returned -in <VAR -CLASS="PARAMETER" ->*error</VAR ->. The other function parameters are -identical to those in <CODE -CLASS="FUNCTION" ->lwres_gethostbyname_r()</CODE ->. -<VAR -CLASS="PARAMETER" ->resbuf</VAR -> is a pointer to a <SPAN -CLASS="TYPE" ->struct -hostent</SPAN -> which is initialised by a successful call to -<CODE -CLASS="FUNCTION" ->lwres_gethostbyaddr_r()</CODE ->. -<VAR -CLASS="PARAMETER" ->buf</VAR -> is a buffer of length -<VAR -CLASS="PARAMETER" ->len</VAR -> bytes which is used to store the -<CODE -CLASS="CONSTANT" ->h_name</CODE ->, <CODE -CLASS="CONSTANT" ->h_aliases</CODE ->, and -<CODE -CLASS="CONSTANT" ->h_addr_list</CODE -> elements of the <SPAN -CLASS="TYPE" ->struct -hostent</SPAN -> returned in <VAR -CLASS="PARAMETER" ->resbuf</VAR ->. Successful -calls to <CODE -CLASS="FUNCTION" ->lwres_gethostbyaddr_r()</CODE -> return -<VAR -CLASS="PARAMETER" ->resbuf</VAR ->, which is a pointer to the -<CODE -CLASS="FUNCTION" ->struct hostent()</CODE -> it created.</P -></DIV -><DIV -CLASS="REFSECT1" -><A -NAME="AEN191" -></A -><H2 ->RETURN VALUES</H2 -><P ->The functions -<CODE -CLASS="FUNCTION" ->lwres_gethostbyname()</CODE ->, -<CODE -CLASS="FUNCTION" ->lwres_gethostbyname2()</CODE ->, -<CODE -CLASS="FUNCTION" ->lwres_gethostbyaddr()</CODE ->, +<em class="parameter"><code>*error</code></em>. +<em class="parameter"><code>resbuf</code></em> is a pointer to a <span class="type">struct +hostent</span> which is initialised by a successful call to +<code class="function">lwres_gethostbyname_r()</code> . +<em class="parameter"><code>buf</code></em> is a buffer of length +<em class="parameter"><code>len</code></em> bytes which is used to store the +<code class="constant">h_name</code>, <code class="constant">h_aliases</code>, and +<code class="constant">h_addr_list</code> elements of the <span class="type">struct +hostent</span> returned in <em class="parameter"><code>resbuf</code></em>. +Successful calls to <code class="function">lwres_gethostbyname_r()</code> +return <em class="parameter"><code>resbuf</code></em>, +which is a pointer to the <span class="type">struct hostent</span> it created. +</p> +<p> +<code class="function">lwres_gethostbyaddr_r()</code> is a thread-safe function +that performs a reverse lookup of address <em class="parameter"><code>addr</code></em> +which is <em class="parameter"><code>len</code></em> bytes long and is of protocol +family <em class="parameter"><code>type</code></em> — <span class="type">PF_INET</span> or +<span class="type">PF_INET6</span>. If an error occurs, the error code is returned +in <em class="parameter"><code>*error</code></em>. The other function parameters are +identical to those in <code class="function">lwres_gethostbyname_r()</code>. +<em class="parameter"><code>resbuf</code></em> is a pointer to a <span class="type">struct +hostent</span> which is initialised by a successful call to +<code class="function">lwres_gethostbyaddr_r()</code>. +<em class="parameter"><code>buf</code></em> is a buffer of length +<em class="parameter"><code>len</code></em> bytes which is used to store the +<code class="constant">h_name</code>, <code class="constant">h_aliases</code>, and +<code class="constant">h_addr_list</code> elements of the <span class="type">struct +hostent</span> returned in <em class="parameter"><code>resbuf</code></em>. Successful +calls to <code class="function">lwres_gethostbyaddr_r()</code> return +<em class="parameter"><code>resbuf</code></em>, which is a pointer to the +<code class="function">struct hostent()</code> it created. +</p> +</div> +<div class="refsect1" lang="en"> +<a name="id2526380"></a><h2>RETURN VALUES</h2> +<p> +The functions +<code class="function">lwres_gethostbyname()</code>, +<code class="function">lwres_gethostbyname2()</code>, +<code class="function">lwres_gethostbyaddr()</code>, and -<CODE -CLASS="FUNCTION" ->lwres_gethostent()</CODE -> +<code class="function">lwres_gethostent()</code> return NULL to indicate an error. In this case the global variable -<SPAN -CLASS="TYPE" ->lwres_h_errno</SPAN -> +<span class="type">lwres_h_errno</span> will contain one of the following error codes defined in -<TT -CLASS="FILENAME" -><lwres/netdb.h></TT ->: +<code class="filename"><lwres/netdb.h></code>: -<P -></P -><DIV -CLASS="VARIABLELIST" -><DL -><DT -><CODE -CLASS="CONSTANT" ->HOST_NOT_FOUND</CODE -></DT -><DD -><P ->The host or address was not found.</P -></DD -><DT -><CODE -CLASS="CONSTANT" ->TRY_AGAIN</CODE -></DT -><DD -><P ->A recoverable error occurred, e.g., a timeout. -Retrying the lookup may succeed.</P -></DD -><DT -><CODE -CLASS="CONSTANT" ->NO_RECOVERY</CODE -></DT -><DD -><P ->A non-recoverable error occurred.</P -></DD -><DT -><CODE -CLASS="CONSTANT" ->NO_DATA</CODE -></DT -><DD -><P ->The name exists, but has no address information +</p> +<div class="variablelist"><dl> +<dt><span class="term"><code class="constant">HOST_NOT_FOUND</code></span></dt> +<dd><p> +The host or address was not found. +</p></dd> +<dt><span class="term"><code class="constant">TRY_AGAIN</code></span></dt> +<dd><p> +A recoverable error occurred, e.g., a timeout. +Retrying the lookup may succeed. +</p></dd> +<dt><span class="term"><code class="constant">NO_RECOVERY</code></span></dt> +<dd><p> +A non-recoverable error occurred. +</p></dd> +<dt><span class="term"><code class="constant">NO_DATA</code></span></dt> +<dd><p> +The name exists, but has no address information associated with it (or vice versa in the case of a reverse lookup). The code NO_ADDRESS is accepted as a synonym for NO_DATA for backwards -compatibility.</P -></DD -></DL -></DIV -></P -><P -><SPAN -CLASS="CITEREFENTRY" -><SPAN -CLASS="REFENTRYTITLE" ->lwres_hstrerror</SPAN ->(3)</SPAN -> -translates these error codes to suitable error messages.</P -><P -><CODE -CLASS="FUNCTION" ->lwres_gethostent()</CODE -> +compatibility. +</p></dd> +</dl></div> +<p> +</p> +<p> +<span class="citerefentry"><span class="refentrytitle">lwres_hstrerror</span>(3 +)</span> +translates these error codes to suitable error messages. +</p> +<p> +<code class="function">lwres_gethostent()</code> and -<CODE -CLASS="FUNCTION" ->lwres_gethostent_r()</CODE -> +<code class="function">lwres_gethostent_r()</code> always return -<SPAN -CLASS="TYPE" ->NULL</SPAN ->.</P -><P ->Successful calls to <CODE -CLASS="FUNCTION" ->lwres_gethostbyname_r()</CODE -> and -<CODE -CLASS="FUNCTION" ->lwres_gethostbyaddr_r()</CODE -> return -<VAR -CLASS="PARAMETER" ->resbuf</VAR ->, a pointer to the <SPAN -CLASS="TYPE" ->struct -hostent</SPAN -> that was initialised by these functions. They return -<SPAN -CLASS="TYPE" ->NULL</SPAN -> if the lookups fail or if <VAR -CLASS="PARAMETER" ->buf</VAR -> +<span class="type">NULL</span>. +</p> +<p> +Successful calls to <code class="function">lwres_gethostbyname_r()</code> and +<code class="function">lwres_gethostbyaddr_r()</code> return +<em class="parameter"><code>resbuf</code></em>, a pointer to the <span class="type">struct +hostent</span> that was initialised by these functions. They return +<span class="type">NULL</span> if the lookups fail or if <em class="parameter"><code>buf</code></em> was too small to hold the list of addresses and names referenced by -the <CODE -CLASS="CONSTANT" ->h_name</CODE ->, <CODE -CLASS="CONSTANT" ->h_aliases</CODE ->, and -<CODE -CLASS="CONSTANT" ->h_addr_list</CODE -> elements of the <SPAN -CLASS="TYPE" ->struct -hostent</SPAN ->. If <VAR -CLASS="PARAMETER" ->buf</VAR -> was too small, both -<CODE -CLASS="FUNCTION" ->lwres_gethostbyname_r()</CODE -> and -<CODE -CLASS="FUNCTION" ->lwres_gethostbyaddr_r()</CODE -> set the global variable -<SPAN -CLASS="TYPE" ->errno</SPAN -> to <SPAN -CLASS="ERRORCODE" ->ERANGE</SPAN ->.</P -></DIV -><DIV -CLASS="REFSECT1" -><A -NAME="AEN245" -></A -><H2 ->SEE ALSO</H2 -><P -><SPAN -CLASS="CITEREFENTRY" -><SPAN -CLASS="REFENTRYTITLE" ->gethostent</SPAN ->(3)</SPAN ->, +the <code class="constant">h_name</code>, <code class="constant">h_aliases</code>, and +<code class="constant">h_addr_list</code> elements of the <span class="type">struct +hostent</span>. If <em class="parameter"><code>buf</code></em> was too small, both +<code class="function">lwres_gethostbyname_r()</code> and +<code class="function">lwres_gethostbyaddr_r()</code> set the global variable +<span class="type">errno</span> to <span class="errorcode">ERANGE</span>. +</p> +</div> +<div class="refsect1" lang="en"> +<a name="id2526540"></a><h2>SEE ALSO</h2> +<p> +<span class="citerefentry"><span class="refentrytitle">gethostent</span>(3)</span>, -<SPAN -CLASS="CITEREFENTRY" -><SPAN -CLASS="REFENTRYTITLE" ->lwres_getipnode</SPAN ->(3)</SPAN ->, +<span class="citerefentry"><span class="refentrytitle">lwres_getipnode</span>(3)</span>, -<SPAN -CLASS="CITEREFENTRY" -><SPAN -CLASS="REFENTRYTITLE" ->lwres_hstrerror</SPAN ->(3)</SPAN -></P -></DIV -><DIV -CLASS="REFSECT1" -><A -NAME="AEN257" -></A -><H2 ->BUGS</H2 -><P -><CODE -CLASS="FUNCTION" ->lwres_gethostbyname()</CODE ->, -<CODE -CLASS="FUNCTION" ->lwres_gethostbyname2()</CODE ->, -<CODE -CLASS="FUNCTION" ->lwres_gethostbyaddr()</CODE -> +<span class="citerefentry"><span class="refentrytitle">lwres_hstrerror</span>(3 +)</span> +</p> +</div> +<div class="refsect1" lang="en"> +<a name="id2526644"></a><h2>BUGS</h2> +<p> +<code class="function">lwres_gethostbyname()</code>, +<code class="function">lwres_gethostbyname2()</code>, +<code class="function">lwres_gethostbyaddr()</code> and -<CODE -CLASS="FUNCTION" ->lwres_endhostent()</CODE -> +<code class="function">lwres_endhostent()</code> are not thread safe; they return pointers to static data and provide error codes through a global variable. Thread-safe versions for name and address lookup are provided by -<CODE -CLASS="FUNCTION" ->lwres_gethostbyname_r()</CODE ->, +<code class="function">lwres_gethostbyname_r()</code>, and -<CODE -CLASS="FUNCTION" ->lwres_gethostbyaddr_r()</CODE -> -respectively.</P -><P ->The resolver daemon does not currently support any non-DNS +<code class="function">lwres_gethostbyaddr_r()</code> +respectively. +</p> +<p> +The resolver daemon does not currently support any non-DNS name services such as -<TT -CLASS="FILENAME" ->/etc/hosts</TT -> +<code class="filename">/etc/hosts</code> or -<SPAN -CLASS="TYPE" ->NIS</SPAN ->, -consequently the above functions don't, either.</P -></DIV -></BODY -></HTML -> +<span class="type">NIS</span>, +consequently the above functions don't, either. +</p> +</div> +</div></body> +</html> diff --git a/contrib/bind9/lib/lwres/man/lwres_getipnode.3 b/contrib/bind9/lib/lwres/man/lwres_getipnode.3 index 815a841..d83758c 100644 --- a/contrib/bind9/lib/lwres/man/lwres_getipnode.3 +++ b/contrib/bind9/lib/lwres/man/lwres_getipnode.3 @@ -1,46 +1,46 @@ -.\" Copyright (C) 2004 Internet Systems Consortium, Inc. ("ISC") -.\" Copyright (C) 2000, 2001 Internet Software Consortium. -.\" +.\" Copyright (C) 2004, 2005 Internet Systems Consortium, Inc. ("ISC") +.\" Copyright (C) 2000, 2001, 2003 Internet Software Consortium. +.\" .\" Permission to use, copy, modify, and distribute this software for any .\" purpose with or without fee is hereby granted, provided that the above .\" copyright notice and this permission notice appear in all copies. -.\" +.\" .\" THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH .\" REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY -.\" AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT, +.\" AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT, .\" INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM .\" LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE .\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR .\" PERFORMANCE OF THIS SOFTWARE. .\" -.\" $Id: lwres_getipnode.3,v 1.13.2.2.4.2 2004/03/09 05:21:10 marka Exp $ +.\" $Id: lwres_getipnode.3,v 1.13.2.2.4.6 2005/10/13 02:33:53 marka Exp $ .\" -.TH "LWRES_GETIPNODE" "3" "Jun 30, 2000" "BIND9" "" -.SH NAME +.hy 0 +.ad l +.\" ** You probably do not want to edit this file directly ** +.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1). +.\" Instead of manually editing it, you probably should edit the DocBook XML +.\" source for it and then use the DocBook XSL Stylesheets to regenerate it. +.TH "LWRES_GETIPNODE" "3" "Jun 30, 2000" "BIND9" "BIND9" +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.SH "NAME" lwres_getipnodebyname, lwres_getipnodebyaddr, lwres_freehostent \- lightweight resolver nodename / address translation API -.SH SYNOPSIS -\fB#include <lwres/netdb.h> -.sp -.na -struct hostent * -lwres_getipnodebyname(const char *name, int af, int flags, int *error_num); -.ad -.sp -.na -struct hostent * -lwres_getipnodebyaddr(const void *src, size_t len, int af, int *error_num); -.ad -.sp -.na -void -lwres_freehostent(struct hostent *he); -.ad -\fR +.SH "SYNOPSIS" +.nf +#include <lwres/netdb.h> +.fi +.HP 39 +\fBstruct\ hostent\ *\ \fBlwres_getipnodebyname\fR\fR\fB(\fR\fBconst\ char\ *name\fR\fB, \fR\fBint\ af\fR\fB, \fR\fBint\ flags\fR\fB, \fR\fBint\ *error_num\fR\fB);\fR +.HP 39 +\fBstruct\ hostent\ *\ \fBlwres_getipnodebyaddr\fR\fR\fB(\fR\fBconst\ void\ *src\fR\fB, \fR\fBsize_t\ len\fR\fB, \fR\fBint\ af\fR\fB, \fR\fBint\ *error_num\fR\fB);\fR +.HP 23 +\fBvoid\ \fBlwres_freehostent\fR\fR\fB(\fR\fBstruct\ hostent\ *he\fR\fB);\fR .SH "DESCRIPTION" .PP -These functions perform thread safe, protocol independent -nodename-to-address and address-to-nodename -translation as defined in RFC2553. +These functions perform thread safe, protocol independent nodename\-to\-address and address\-to\-nodename translation as defined in RFC2553. .PP They use a \fBstruct hostent\fR @@ -56,8 +56,8 @@ struct hostent { char **h_addr_list; /* list of addresses from name server */ }; #define h_addr h_addr_list[0] /* address, for backward compatibility */ -.sp .fi +.sp .PP The members of this structure are: .TP @@ -65,10 +65,10 @@ The members of this structure are: The official (canonical) name of the host. .TP \fBh_aliases\fR -A NULL-terminated array of alternate names (nicknames) for the host. +A NULL\-terminated array of alternate names (nicknames) for the host. .TP \fBh_addrtype\fR -The type of address being returned - usually +The type of address being returned \- usually \fBPF_INET\fR or \fBPF_INET6\fR. @@ -79,49 +79,38 @@ The length of the address in bytes. \fBh_addr_list\fR A \fBNULL\fR -terminated array of network addresses for the host. -Host addresses are returned in network byte order. +terminated array of network addresses for the host. Host addresses are returned in network byte order. .PP \fBlwres_getipnodebyname()\fR looks up addresses of protocol family \fIaf\fR for the hostname -\fIname\fR. -The +\fIname\fR. The \fIflags\fR -parameter contains ORed flag bits to -specify the types of addresses that are searched -for, and the types of addresses that are returned. -The flag bits are: +parameter contains ORed flag bits to specify the types of addresses that are searched for, and the types of addresses that are returned. The flag bits are: .TP \fBAI_V4MAPPED\fR This is used with an \fIaf\fR -of AF_INET6, and causes IPv4 addresses to be returned as IPv4-mapped -IPv6 addresses. +of AF_INET6, and causes IPv4 addresses to be returned as IPv4\-mapped IPv6 addresses. .TP \fBAI_ALL\fR This is used with an \fIaf\fR -of AF_INET6, and causes all known addresses (IPv6 and IPv4) to be returned. -If AI_V4MAPPED is also set, the IPv4 addresses are return as mapped -IPv6 addresses. +of AF_INET6, and causes all known addresses (IPv6 and IPv4) to be returned. If AI_V4MAPPED is also set, the IPv4 addresses are return as mapped IPv6 addresses. .TP \fBAI_ADDRCONFIG\fR -Only return an IPv6 or IPv4 address if here is an active network -interface of that type. This is not currently implemented -in the BIND 9 lightweight resolver, and the flag is ignored. +Only return an IPv6 or IPv4 address if here is an active network interface of that type. This is not currently implemented in the BIND 9 lightweight resolver, and the flag is ignored. .TP \fBAI_DEFAULT\fR This default sets the -AI_V4MAPPED +\fBAI_V4MAPPED\fR and -AI_ADDRCONFIG +\fBAI_ADDRCONFIG\fR flag bits. .PP \fBlwres_getipnodebyaddr()\fR -performs a reverse lookup -of address +performs a reverse lookup of address \fIsrc\fR which is \fIlen\fR @@ -133,16 +122,14 @@ or \fBPF_INET6\fR. .PP \fBlwres_freehostent()\fR -releases all the memory associated with -the +releases all the memory associated with the \fBstruct hostent\fR pointer -\fIhe\fR. -Any memory allocated for the -h_name, -h_addr_list +\fIhe\fR. Any memory allocated for the +\fBh_name\fR, +\fBh_addr_list\fR and -h_aliases +\fBh_aliases\fR is freed, as is the memory for the \fBhostent\fR structure itself. @@ -156,32 +143,26 @@ set \fI*error_num\fR to an appropriate error code and the function returns a \fBNULL\fR -pointer. -The error codes and their meanings are defined in +pointer. The error codes and their meanings are defined in \fI<lwres/netdb.h>\fR: .TP \fBHOST_NOT_FOUND\fR No such host is known. .TP \fBNO_ADDRESS\fR -The server recognised the request and the name but no address is -available. Another type of request to the name server for the -domain might return an answer. +The server recognised the request and the name but no address is available. Another type of request to the name server for the domain might return an answer. .TP \fBTRY_AGAIN\fR -A temporary and possibly transient error occurred, such as a -failure of a server to respond. The request may succeed if -retried. +A temporary and possibly transient error occurred, such as a failure of a server to respond. The request may succeed if retried. .TP \fBNO_RECOVERY\fR -An unexpected failure occurred, and retrying the request -is pointless. +An unexpected failure occurred, and retrying the request is pointless. .PP -\fBlwres_hstrerror\fR(3) +\fBlwres_hstrerror\fR(3 ) translates these error codes to suitable error messages. .SH "SEE ALSO" .PP -\fBRFC2553\fR, +\fBRFC2553\fR(), \fBlwres\fR(3), \fBlwres_gethostent\fR(3), \fBlwres_getaddrinfo\fR(3), diff --git a/contrib/bind9/lib/lwres/man/lwres_getipnode.docbook b/contrib/bind9/lib/lwres/man/lwres_getipnode.docbook index 30c04a3..94de72c 100644 --- a/contrib/bind9/lib/lwres/man/lwres_getipnode.docbook +++ b/contrib/bind9/lib/lwres/man/lwres_getipnode.docbook @@ -1,7 +1,9 @@ -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.0//EN" + "http://www.oasis-open.org/docbook/xml/4.0/docbookx.dtd" + [<!ENTITY mdash "—">]> <!-- - - Copyright (C) 2004 Internet Systems Consortium, Inc. ("ISC") - - Copyright (C) 2001, 2003 Internet Software Consortium. + - Copyright (C) 2004, 2005 Internet Systems Consortium, Inc. ("ISC") + - Copyright (C) 2000, 2001, 2003 Internet Software Consortium. - - Permission to use, copy, modify, and distribute this software for any - purpose with or without fee is hereby granted, provided that the above @@ -16,7 +18,7 @@ - PERFORMANCE OF THIS SOFTWARE. --> -<!-- $Id: lwres_getipnode.docbook,v 1.4.2.2.4.1 2004/03/06 08:15:39 marka Exp $ --> +<!-- $Id: lwres_getipnode.docbook,v 1.4.2.2.4.3 2005/05/12 21:36:14 sra Exp $ --> <refentry> @@ -30,6 +32,20 @@ <refmiscinfo>BIND9</refmiscinfo> </refmeta> + <docinfo> + <copyright> + <year>2004</year> + <year>2005</year> + <holder>Internet Systems Consortium, Inc. ("ISC")</holder> + </copyright> + <copyright> + <year>2000</year> + <year>2001</year> + <year>2003</year> + <holder>Internet Software Consortium.</holder> + </copyright> + </docinfo> + <refnamediv> <refname>lwres_getipnodebyname</refname> <refname>lwres_getipnodebyaddr</refname> diff --git a/contrib/bind9/lib/lwres/man/lwres_getipnode.html b/contrib/bind9/lib/lwres/man/lwres_getipnode.html index 3063d44..c5038b4 100644 --- a/contrib/bind9/lib/lwres/man/lwres_getipnode.html +++ b/contrib/bind9/lib/lwres/man/lwres_getipnode.html @@ -1,512 +1,298 @@ <!-- - - Copyright (C) 2004 Internet Systems Consortium, Inc. ("ISC") - - Copyright (C) 2001, 2003 Internet Software Consortium. - - + - Copyright (C) 2004, 2005 Internet Systems Consortium, Inc. ("ISC") + - Copyright (C) 2000, 2001, 2003 Internet Software Consortium. + - - Permission to use, copy, modify, and distribute this software for any - purpose with or without fee is hereby granted, provided that the above - copyright notice and this permission notice appear in all copies. - - + - - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY - - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT, + - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT, - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> - -<!-- $Id: lwres_getipnode.html,v 1.7.2.1.4.2 2004/08/22 23:39:04 marka Exp $ --> - -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<HTML -><HEAD -><TITLE ->lwres_getipnode</TITLE -><META -NAME="GENERATOR" -CONTENT="Modular DocBook HTML Stylesheet Version 1.7"></HEAD -><BODY -CLASS="REFENTRY" -BGCOLOR="#FFFFFF" -TEXT="#000000" -LINK="#0000FF" -VLINK="#840084" -ALINK="#0000FF" -><H1 -><A -NAME="AEN1" -></A ->lwres_getipnode</H1 -><DIV -CLASS="REFNAMEDIV" -><A -NAME="AEN8" -></A -><H2 ->Name</H2 ->lwres_getipnodebyname, lwres_getipnodebyaddr, lwres_freehostent -- lightweight resolver nodename / address translation API</DIV -><DIV -CLASS="REFSYNOPSISDIV" -><A -NAME="AEN13" -></A -><H2 ->Synopsis</H2 -><DIV -CLASS="FUNCSYNOPSIS" -><P -></P -><A -NAME="AEN14" -></A -><PRE -CLASS="FUNCSYNOPSISINFO" ->#include <lwres/netdb.h></PRE -><P -><CODE -><CODE -CLASS="FUNCDEF" ->struct hostent * -lwres_getipnodebyname</CODE ->(const char *name, int af, int flags, int *error_num);</CODE -></P -><P -><CODE -><CODE -CLASS="FUNCDEF" ->struct hostent * -lwres_getipnodebyaddr</CODE ->(const void *src, size_t len, int af, int *error_num);</CODE -></P -><P -><CODE -><CODE -CLASS="FUNCDEF" ->void -lwres_freehostent</CODE ->(struct hostent *he);</CODE -></P -><P -></P -></DIV -></DIV -><DIV -CLASS="REFSECT1" -><A -NAME="AEN34" -></A -><H2 ->DESCRIPTION</H2 -><P ->These functions perform thread safe, protocol independent +<!-- $Id: lwres_getipnode.html,v 1.7.2.1.4.9 2005/10/13 02:33:56 marka Exp $ --> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> +<title>lwres_getipnode</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.69.1"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"> +<a name="id2463721"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2>Name</h2> +<p>lwres_getipnodebyname, lwres_getipnodebyaddr, lwres_freehostent — lightweight resolver nodename / address translation API</p> +</div> +<div class="refsynopsisdiv"> +<h2>Synopsis</h2> +<div class="funcsynopsis"> +<pre class="funcsynopsisinfo">#include <lwres/netdb.h></pre> +<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em"> +<tr> +<td><code class="funcdef"> +struct hostent * +<b class="fsfunc">lwres_getipnodebyname</b>(</code></td> +<td> </td> +<td>, </td> +</tr> +<tr> +<td> </td> +<td> </td> +<td>, </td> +</tr> +<tr> +<td> </td> +<td> </td> +<td>, </td> +</tr> +<tr> +<td> </td> +<td> </td> +<td> +<code>)</code>;</td> +</tr> +</table> +<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em"> +<tr> +<td><code class="funcdef"> +struct hostent * +<b class="fsfunc">lwres_getipnodebyaddr</b>(</code></td> +<td> </td> +<td>, </td> +</tr> +<tr> +<td> </td> +<td> </td> +<td>, </td> +</tr> +<tr> +<td> </td> +<td> </td> +<td>, </td> +</tr> +<tr> +<td> </td> +<td> </td> +<td> +<code>)</code>;</td> +</tr> +</table> +<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0"><tr> +<td><code class="funcdef"> +void +<b class="fsfunc">lwres_freehostent</b>(</code></td> +<td> </td> +<td> +<code>)</code>;</td> +</tr></table> +</div> +</div> +<div class="refsect1" lang="en"> +<a name="id2525896"></a><h2>DESCRIPTION</h2> +<p> +These functions perform thread safe, protocol independent nodename-to-address and address-to-nodename -translation as defined in RFC2553.</P -><P ->They use a -<SPAN -CLASS="TYPE" ->struct hostent</SPAN -> +translation as defined in RFC2553. +</p> +<p> +They use a +<span class="type">struct hostent</span> which is defined in -<TT -CLASS="FILENAME" ->namedb.h</TT ->: -<PRE -CLASS="PROGRAMLISTING" ->struct hostent { +<code class="filename">namedb.h</code>: +</p> +<pre class="programlisting"> +struct hostent { char *h_name; /* official name of host */ char **h_aliases; /* alias list */ int h_addrtype; /* host address type */ int h_length; /* length of address */ char **h_addr_list; /* list of addresses from name server */ }; -#define h_addr h_addr_list[0] /* address, for backward compatibility */</PRE -></P -><P ->The members of this structure are: -<P -></P -><DIV -CLASS="VARIABLELIST" -><DL -><DT -><CODE -CLASS="CONSTANT" ->h_name</CODE -></DT -><DD -><P ->The official (canonical) name of the host.</P -></DD -><DT -><CODE -CLASS="CONSTANT" ->h_aliases</CODE -></DT -><DD -><P ->A NULL-terminated array of alternate names (nicknames) for the host.</P -></DD -><DT -><CODE -CLASS="CONSTANT" ->h_addrtype</CODE -></DT -><DD -><P ->The type of address being returned - usually -<SPAN -CLASS="TYPE" ->PF_INET</SPAN -> +#define h_addr h_addr_list[0] /* address, for backward compatibility */ +</pre> +<p> +</p> +<p> +The members of this structure are: +</p> +<div class="variablelist"><dl> +<dt><span class="term"><code class="constant">h_name</code></span></dt> +<dd><p> +The official (canonical) name of the host. +</p></dd> +<dt><span class="term"><code class="constant">h_aliases</code></span></dt> +<dd><p> +A NULL-terminated array of alternate names (nicknames) for the host. +</p></dd> +<dt><span class="term"><code class="constant">h_addrtype</code></span></dt> +<dd><p> +The type of address being returned - usually +<span class="type">PF_INET</span> or -<SPAN -CLASS="TYPE" ->PF_INET6</SPAN ->. </P -></DD -><DT -><CODE -CLASS="CONSTANT" ->h_length</CODE -></DT -><DD -><P ->The length of the address in bytes.</P -></DD -><DT -><CODE -CLASS="CONSTANT" ->h_addr_list</CODE -></DT -><DD -><P ->A -<SPAN -CLASS="TYPE" ->NULL</SPAN -> +<span class="type">PF_INET6</span>. + +</p></dd> +<dt><span class="term"><code class="constant">h_length</code></span></dt> +<dd><p> +The length of the address in bytes. +</p></dd> +<dt><span class="term"><code class="constant">h_addr_list</code></span></dt> +<dd><p> +A +<span class="type">NULL</span> terminated array of network addresses for the host. -Host addresses are returned in network byte order.</P -></DD -></DL -></DIV -></P -><P -><CODE -CLASS="FUNCTION" ->lwres_getipnodebyname()</CODE -> +Host addresses are returned in network byte order. +</p></dd> +</dl></div> +<p> +</p> +<p> +<code class="function">lwres_getipnodebyname()</code> looks up addresses of protocol family -<VAR -CLASS="PARAMETER" ->af</VAR -> +<em class="parameter"><code>af</code></em> for the hostname -<VAR -CLASS="PARAMETER" ->name</VAR ->. +<em class="parameter"><code>name</code></em>. The -<VAR -CLASS="PARAMETER" ->flags</VAR -> +<em class="parameter"><code>flags</code></em> parameter contains ORed flag bits to specify the types of addresses that are searched for, and the types of addresses that are returned. The flag bits are: -<P -></P -><DIV -CLASS="VARIABLELIST" -><DL -><DT -><CODE -CLASS="CONSTANT" ->AI_V4MAPPED</CODE -></DT -><DD -><P ->This is used with an -<VAR -CLASS="PARAMETER" ->af</VAR -> +</p> +<div class="variablelist"><dl> +<dt><span class="term"><code class="constant">AI_V4MAPPED</code></span></dt> +<dd><p> +This is used with an +<em class="parameter"><code>af</code></em> of AF_INET6, and causes IPv4 addresses to be returned as IPv4-mapped -IPv6 addresses.</P -></DD -><DT -><CODE -CLASS="CONSTANT" ->AI_ALL</CODE -></DT -><DD -><P ->This is used with an -<VAR -CLASS="PARAMETER" ->af</VAR -> +IPv6 addresses. +</p></dd> +<dt><span class="term"><code class="constant">AI_ALL</code></span></dt> +<dd><p> +This is used with an +<em class="parameter"><code>af</code></em> of AF_INET6, and causes all known addresses (IPv6 and IPv4) to be returned. If AI_V4MAPPED is also set, the IPv4 addresses are return as mapped -IPv6 addresses.</P -></DD -><DT -><CODE -CLASS="CONSTANT" ->AI_ADDRCONFIG</CODE -></DT -><DD -><P ->Only return an IPv6 or IPv4 address if here is an active network +IPv6 addresses. +</p></dd> +<dt><span class="term"><code class="constant">AI_ADDRCONFIG</code></span></dt> +<dd><p> +Only return an IPv6 or IPv4 address if here is an active network interface of that type. This is not currently implemented -in the BIND 9 lightweight resolver, and the flag is ignored.</P -></DD -><DT -><CODE -CLASS="CONSTANT" ->AI_DEFAULT</CODE -></DT -><DD -><P ->This default sets the -<CODE -CLASS="CONSTANT" ->AI_V4MAPPED</CODE -> +in the BIND 9 lightweight resolver, and the flag is ignored. +</p></dd> +<dt><span class="term"><code class="constant">AI_DEFAULT</code></span></dt> +<dd><p> +This default sets the +<code class="constant">AI_V4MAPPED</code> and -<CODE -CLASS="CONSTANT" ->AI_ADDRCONFIG</CODE -> -flag bits.</P -></DD -></DL -></DIV -></P -><P -><CODE -CLASS="FUNCTION" ->lwres_getipnodebyaddr()</CODE -> +<code class="constant">AI_ADDRCONFIG</code> +flag bits. +</p></dd> +</dl></div> +<p> +</p> +<p> +<code class="function">lwres_getipnodebyaddr()</code> performs a reverse lookup of address -<VAR -CLASS="PARAMETER" ->src</VAR -> +<em class="parameter"><code>src</code></em> which is -<VAR -CLASS="PARAMETER" ->len</VAR -> +<em class="parameter"><code>len</code></em> bytes long. -<VAR -CLASS="PARAMETER" ->af</VAR -> +<em class="parameter"><code>af</code></em> denotes the protocol family, typically -<SPAN -CLASS="TYPE" ->PF_INET</SPAN -> +<span class="type">PF_INET</span> or -<SPAN -CLASS="TYPE" ->PF_INET6</SPAN ->. </P -><P -><CODE -CLASS="FUNCTION" ->lwres_freehostent()</CODE -> +<span class="type">PF_INET6</span>. + +</p> +<p> +<code class="function">lwres_freehostent()</code> releases all the memory associated with the -<SPAN -CLASS="TYPE" ->struct hostent</SPAN -> +<span class="type">struct hostent</span> pointer -<VAR -CLASS="PARAMETER" ->he</VAR ->. +<em class="parameter"><code>he</code></em>. Any memory allocated for the -<CODE -CLASS="CONSTANT" ->h_name</CODE ->, +<code class="constant">h_name</code>, -<CODE -CLASS="CONSTANT" ->h_addr_list</CODE -> +<code class="constant">h_addr_list</code> and -<CODE -CLASS="CONSTANT" ->h_aliases</CODE -> +<code class="constant">h_aliases</code> is freed, as is the memory for the -<SPAN -CLASS="TYPE" ->hostent</SPAN -> -structure itself.</P -></DIV -><DIV -CLASS="REFSECT1" -><A -NAME="AEN116" -></A -><H2 ->RETURN VALUES</H2 -><P ->If an error occurs, -<CODE -CLASS="FUNCTION" ->lwres_getipnodebyname()</CODE -> +<span class="type">hostent</span> +structure itself. +</p> +</div> +<div class="refsect1" lang="en"> +<a name="id2526131"></a><h2>RETURN VALUES</h2> +<p> +If an error occurs, +<code class="function">lwres_getipnodebyname()</code> and -<CODE -CLASS="FUNCTION" ->lwres_getipnodebyaddr()</CODE -> +<code class="function">lwres_getipnodebyaddr()</code> set -<VAR -CLASS="PARAMETER" ->*error_num</VAR -> +<em class="parameter"><code>*error_num</code></em> to an appropriate error code and the function returns a -<SPAN -CLASS="TYPE" ->NULL</SPAN -> +<span class="type">NULL</span> pointer. The error codes and their meanings are defined in -<TT -CLASS="FILENAME" -><lwres/netdb.h></TT ->: -<P -></P -><DIV -CLASS="VARIABLELIST" -><DL -><DT -><CODE -CLASS="CONSTANT" ->HOST_NOT_FOUND</CODE -></DT -><DD -><P ->No such host is known.</P -></DD -><DT -><CODE -CLASS="CONSTANT" ->NO_ADDRESS</CODE -></DT -><DD -><P ->The server recognised the request and the name but no address is +<code class="filename"><lwres/netdb.h></code>: +</p> +<div class="variablelist"><dl> +<dt><span class="term"><code class="constant">HOST_NOT_FOUND</code></span></dt> +<dd><p> +No such host is known. +</p></dd> +<dt><span class="term"><code class="constant">NO_ADDRESS</code></span></dt> +<dd><p> +The server recognised the request and the name but no address is available. Another type of request to the name server for the -domain might return an answer.</P -></DD -><DT -><CODE -CLASS="CONSTANT" ->TRY_AGAIN</CODE -></DT -><DD -><P ->A temporary and possibly transient error occurred, such as a +domain might return an answer. +</p></dd> +<dt><span class="term"><code class="constant">TRY_AGAIN</code></span></dt> +<dd><p> +A temporary and possibly transient error occurred, such as a failure of a server to respond. The request may succeed if -retried.</P -></DD -><DT -><CODE -CLASS="CONSTANT" ->NO_RECOVERY</CODE -></DT -><DD -><P ->An unexpected failure occurred, and retrying the request -is pointless.</P -></DD -></DL -></DIV -></P -><P -><SPAN -CLASS="CITEREFENTRY" -><SPAN -CLASS="REFENTRYTITLE" ->lwres_hstrerror</SPAN ->(3)</SPAN -> -translates these error codes to suitable error messages.</P -></DIV -><DIV -CLASS="REFSECT1" -><A -NAME="AEN149" -></A -><H2 ->SEE ALSO</H2 -><P -><SPAN -CLASS="CITEREFENTRY" -><SPAN -CLASS="REFENTRYTITLE" ->RFC2553</SPAN -></SPAN ->, +retried. +</p></dd> +<dt><span class="term"><code class="constant">NO_RECOVERY</code></span></dt> +<dd><p> +An unexpected failure occurred, and retrying the request +is pointless. +</p></dd> +</dl></div> +<p> +</p> +<p> +<span class="citerefentry"><span class="refentrytitle">lwres_hstrerror</span>(3 +)</span> +translates these error codes to suitable error messages. +</p> +</div> +<div class="refsect1" lang="en"> +<a name="id2526290"></a><h2>SEE ALSO</h2> +<p> +<span class="citerefentry"><span class="refentrytitle">RFC2553</span></span>, -<SPAN -CLASS="CITEREFENTRY" -><SPAN -CLASS="REFENTRYTITLE" ->lwres</SPAN ->(3)</SPAN ->, +<span class="citerefentry"><span class="refentrytitle">lwres</span>(3)</span>, -<SPAN -CLASS="CITEREFENTRY" -><SPAN -CLASS="REFENTRYTITLE" ->lwres_gethostent</SPAN ->(3)</SPAN ->, +<span class="citerefentry"><span class="refentrytitle">lwres_gethostent</span>(3)</span>, -<SPAN -CLASS="CITEREFENTRY" -><SPAN -CLASS="REFENTRYTITLE" ->lwres_getaddrinfo</SPAN ->(3)</SPAN ->, +<span class="citerefentry"><span class="refentrytitle">lwres_getaddrinfo</span>(3)</span>, -<SPAN -CLASS="CITEREFENTRY" -><SPAN -CLASS="REFENTRYTITLE" ->lwres_getnameinfo</SPAN ->(3)</SPAN ->, +<span class="citerefentry"><span class="refentrytitle">lwres_getnameinfo</span>(3)</span>, -<SPAN -CLASS="CITEREFENTRY" -><SPAN -CLASS="REFENTRYTITLE" ->lwres_hstrerror</SPAN ->(3)</SPAN ->.</P -></DIV -></BODY -></HTML -> +<span class="citerefentry"><span class="refentrytitle">lwres_hstrerror</span>(3)</span>. +</p> +</div> +</div></body> +</html> diff --git a/contrib/bind9/lib/lwres/man/lwres_getnameinfo.3 b/contrib/bind9/lib/lwres/man/lwres_getnameinfo.3 index a512270..853c2b9 100644 --- a/contrib/bind9/lib/lwres/man/lwres_getnameinfo.3 +++ b/contrib/bind9/lib/lwres/man/lwres_getnameinfo.3 @@ -1,79 +1,91 @@ -.\" Copyright (C) 2004 Internet Systems Consortium, Inc. ("ISC") -.\" Copyright (C) 2000, 2001 Internet Software Consortium. -.\" +.\" Copyright (C) 2004, 2005 Internet Systems Consortium, Inc. ("ISC") +.\" Copyright (C) 2000, 2001 Internet Software Consortium. +.\" .\" Permission to use, copy, modify, and distribute this software for any .\" purpose with or without fee is hereby granted, provided that the above .\" copyright notice and this permission notice appear in all copies. -.\" +.\" .\" THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH .\" REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY -.\" AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT, +.\" AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT, .\" INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM .\" LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE .\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR .\" PERFORMANCE OF THIS SOFTWARE. .\" -.\" $Id: lwres_getnameinfo.3,v 1.15.2.1.8.1 2004/03/06 07:41:43 marka Exp $ +.\" $Id: lwres_getnameinfo.3,v 1.15.2.1.8.5 2005/10/13 02:33:53 marka Exp $ .\" -.TH "LWRES_GETNAMEINFO" "3" "Jun 30, 2000" "BIND9" "" -.SH NAME +.hy 0 +.ad l +.\" ** You probably do not want to edit this file directly ** +.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1). +.\" Instead of manually editing it, you probably should edit the DocBook XML +.\" source for it and then use the DocBook XSL Stylesheets to regenerate it. +.TH "LWRES_GETNAMEINFO" "3" "Jun 30, 2000" "BIND9" "BIND9" +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.SH "NAME" lwres_getnameinfo \- lightweight resolver socket address structure to hostname and service name -.SH SYNOPSIS -\fB#include <lwres/netdb.h> -.sp -.na -int -lwres_getnameinfo(const struct sockaddr *sa, size_t salen, char *host, size_t hostlen, char *serv, size_t servlen, int flags); -.ad -\fR +.SH "SYNOPSIS" +.nf +#include <lwres/netdb.h> +.fi +.HP 22 +\fBint\ \fBlwres_getnameinfo\fR\fR\fB(\fR\fBconst\ struct\ sockaddr\ *sa\fR\fB, \fR\fBsize_t\ salen\fR\fB, \fR\fBchar\ *host\fR\fB, \fR\fBsize_t\ hostlen\fR\fB, \fR\fBchar\ *serv\fR\fB, \fR\fBsize_t\ servlen\fR\fB, \fR\fBint\ flags\fR\fB);\fR .SH "DESCRIPTION" .PP -This function is equivalent to the \fBgetnameinfo\fR(3) function defined in RFC2133. -\fBlwres_getnameinfo()\fR returns the hostname for the -\fBstruct sockaddr\fR \fIsa\fR which is -\fIsalen\fR bytes long. The hostname is of length -\fIhostlen\fR and is returned via -\fI*host.\fR The maximum length of the hostname is -1025 bytes: NI_MAXHOST. +This function is equivalent to the +\fBgetnameinfo\fR(3) +function defined in RFC2133. +\fBlwres_getnameinfo()\fR +returns the hostname for the +\fBstruct sockaddr\fR\fIsa\fR +which is +\fIsalen\fR +bytes long. The hostname is of length +\fIhostlen\fR +and is returned via +\fI*host.\fR +The maximum length of the hostname is 1025 bytes: +\fBNI_MAXHOST\fR. .PP The name of the service associated with the port number in -\fIsa\fR is returned in \fI*serv.\fR -It is \fIservlen\fR bytes long. The maximum length -of the service name is NI_MAXSERV - 32 bytes. +\fIsa\fR +is returned in +\fI*serv.\fR +It is +\fIservlen\fR +bytes long. The maximum length of the service name is +\fBNI_MAXSERV\fR +\- 32 bytes. .PP -The \fIflags\fR argument sets the following -bits: +The +\fIflags\fR +argument sets the following bits: .TP \fBNI_NOFQDN\fR -A fully qualified domain name is not required for local hosts. -The local part of the fully qualified domain name is returned instead. +A fully qualified domain name is not required for local hosts. The local part of the fully qualified domain name is returned instead. .TP \fBNI_NUMERICHOST\fR -Return the address in numeric form, as if calling inet_ntop(), -instead of a host name. +Return the address in numeric form, as if calling inet_ntop(), instead of a host name. .TP \fBNI_NAMEREQD\fR -A name is required. If the hostname cannot be found in the DNS and -this flag is set, a non-zero error code is returned. -If the hostname is not found and the flag is not set, the -address is returned in numeric form. +A name is required. If the hostname cannot be found in the DNS and this flag is set, a non\-zero error code is returned. If the hostname is not found and the flag is not set, the address is returned in numeric form. .TP \fBNI_NUMERICSERV\fR The service name is returned as a digit string representing the port number. .TP \fBNI_DGRAM\fR -Specifies that the service being looked up is a datagram -service, and causes getservbyport() to be called with a second -argument of "udp" instead of its default of "tcp". This is required -for the few ports (512-514) that have different services for UDP and -TCP. +Specifies that the service being looked up is a datagram service, and causes getservbyport() to be called with a second argument of "udp" instead of its default of "tcp". This is required for the few ports (512\-514) that have different services for UDP and TCP. .SH "RETURN VALUES" .PP \fBlwres_getnameinfo()\fR -returns 0 on success or a non-zero error code if an error occurs. +returns 0 on success or a non\-zero error code if an error occurs. .SH "SEE ALSO" .PP -\fBRFC2133\fR, +\fBRFC2133\fR(), \fBgetservbyport\fR(3), \fBlwres\fR(3), \fBlwres_getnameinfo\fR(3), diff --git a/contrib/bind9/lib/lwres/man/lwres_getnameinfo.docbook b/contrib/bind9/lib/lwres/man/lwres_getnameinfo.docbook index ff2eaad..b6e10ac 100644 --- a/contrib/bind9/lib/lwres/man/lwres_getnameinfo.docbook +++ b/contrib/bind9/lib/lwres/man/lwres_getnameinfo.docbook @@ -1,7 +1,9 @@ -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.0//EN" + "http://www.oasis-open.org/docbook/xml/4.0/docbookx.dtd" + [<!ENTITY mdash "—">]> <!-- - - Copyright (C) 2004 Internet Systems Consortium, Inc. ("ISC") - - Copyright (C) 2001 Internet Software Consortium. + - Copyright (C) 2004, 2005 Internet Systems Consortium, Inc. ("ISC") + - Copyright (C) 2000, 2001 Internet Software Consortium. - - Permission to use, copy, modify, and distribute this software for any - purpose with or without fee is hereby granted, provided that the above @@ -16,7 +18,7 @@ - PERFORMANCE OF THIS SOFTWARE. --> -<!-- $Id: lwres_getnameinfo.docbook,v 1.3.206.1 2004/03/06 08:15:40 marka Exp $ --> +<!-- $Id: lwres_getnameinfo.docbook,v 1.3.206.3 2005/05/12 21:36:15 sra Exp $ --> <refentry> @@ -30,6 +32,19 @@ <refmiscinfo>BIND9</refmiscinfo> </refmeta> + <docinfo> + <copyright> + <year>2004</year> + <year>2005</year> + <holder>Internet Systems Consortium, Inc. ("ISC")</holder> + </copyright> + <copyright> + <year>2000</year> + <year>2001</year> + <holder>Internet Software Consortium.</holder> + </copyright> + </docinfo> + <refnamediv> <refname>lwres_getnameinfo</refname> <refpurpose>lightweight resolver socket address structure to hostname and service name</refpurpose> @@ -140,6 +155,7 @@ returns 0 on success or a non-zero error code if an error occurs. <citerefentry> <refentrytitle>lwres_net_ntop</refentrytitle><manvolnum>3</manvolnum> </citerefentry>. +</para> </refsect1> <refsect1> <title>BUGS</title> diff --git a/contrib/bind9/lib/lwres/man/lwres_getnameinfo.html b/contrib/bind9/lib/lwres/man/lwres_getnameinfo.html index 8130fe8..6e7a7b1 100644 --- a/contrib/bind9/lib/lwres/man/lwres_getnameinfo.html +++ b/contrib/bind9/lib/lwres/man/lwres_getnameinfo.html @@ -1,290 +1,154 @@ <!-- - - Copyright (C) 2004 Internet Systems Consortium, Inc. ("ISC") - - Copyright (C) 2001 Internet Software Consortium. - - + - Copyright (C) 2004, 2005 Internet Systems Consortium, Inc. ("ISC") + - Copyright (C) 2000, 2001 Internet Software Consortium. + - - Permission to use, copy, modify, and distribute this software for any - purpose with or without fee is hereby granted, provided that the above - copyright notice and this permission notice appear in all copies. - - + - - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY - - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT, + - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT, - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> - -<!-- $Id: lwres_getnameinfo.html,v 1.5.2.1.4.2 2004/08/22 23:39:04 marka Exp $ --> - -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<HTML -><HEAD -><TITLE ->lwres_getnameinfo</TITLE -><META -NAME="GENERATOR" -CONTENT="Modular DocBook HTML Stylesheet Version 1.7"></HEAD -><BODY -CLASS="REFENTRY" -BGCOLOR="#FFFFFF" -TEXT="#000000" -LINK="#0000FF" -VLINK="#840084" -ALINK="#0000FF" -><H1 -><A -NAME="AEN1" -></A ->lwres_getnameinfo</H1 -><DIV -CLASS="REFNAMEDIV" -><A -NAME="AEN8" -></A -><H2 ->Name</H2 ->lwres_getnameinfo -- lightweight resolver socket address structure to hostname and service name</DIV -><DIV -CLASS="REFSYNOPSISDIV" -><A -NAME="AEN11" -></A -><H2 ->Synopsis</H2 -><DIV -CLASS="FUNCSYNOPSIS" -><P -></P -><A -NAME="AEN12" -></A -><PRE -CLASS="FUNCSYNOPSISINFO" ->#include <lwres/netdb.h></PRE -><P -><CODE -><CODE -CLASS="FUNCDEF" ->int -lwres_getnameinfo</CODE ->(const struct sockaddr *sa, size_t salen, char *host, size_t hostlen, char *serv, size_t servlen, int flags);</CODE -></P -><P -></P -></DIV -></DIV -><DIV -CLASS="REFSECT1" -><A -NAME="AEN24" -></A -><H2 ->DESCRIPTION</H2 -><P -> This function is equivalent to the <SPAN -CLASS="CITEREFENTRY" -><SPAN -CLASS="REFENTRYTITLE" ->getnameinfo</SPAN ->(3)</SPAN -> function defined in RFC2133. -<CODE -CLASS="FUNCTION" ->lwres_getnameinfo()</CODE -> returns the hostname for the -<SPAN -CLASS="TYPE" ->struct sockaddr</SPAN -> <VAR -CLASS="PARAMETER" ->sa</VAR -> which is -<VAR -CLASS="PARAMETER" ->salen</VAR -> bytes long. The hostname is of length -<VAR -CLASS="PARAMETER" ->hostlen</VAR -> and is returned via -<VAR -CLASS="PARAMETER" ->*host.</VAR -> The maximum length of the hostname is -1025 bytes: <CODE -CLASS="CONSTANT" ->NI_MAXHOST</CODE ->.</P -><P -> The name of the service associated with the port number in -<VAR -CLASS="PARAMETER" ->sa</VAR -> is returned in <VAR -CLASS="PARAMETER" ->*serv.</VAR -> -It is <VAR -CLASS="PARAMETER" ->servlen</VAR -> bytes long. The maximum length -of the service name is <CODE -CLASS="CONSTANT" ->NI_MAXSERV</CODE -> - 32 bytes.</P -><P -> The <VAR -CLASS="PARAMETER" ->flags</VAR -> argument sets the following +<!-- $Id: lwres_getnameinfo.html,v 1.5.2.1.4.9 2005/10/13 02:33:56 marka Exp $ --> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> +<title>lwres_getnameinfo</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.69.1"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"> +<a name="id2463721"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2>Name</h2> +<p>lwres_getnameinfo — lightweight resolver socket address structure to hostname and service name</p> +</div> +<div class="refsynopsisdiv"> +<h2>Synopsis</h2> +<div class="funcsynopsis"> +<pre class="funcsynopsisinfo">#include <lwres/netdb.h></pre> +<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0"> +<tr> +<td><code class="funcdef"> +int +<b class="fsfunc">lwres_getnameinfo</b>(</code></td> +<td> </td> +<td>, </td> +</tr> +<tr> +<td> </td> +<td> </td> +<td>, </td> +</tr> +<tr> +<td> </td> +<td> </td> +<td>, </td> +</tr> +<tr> +<td> </td> +<td> </td> +<td>, </td> +</tr> +<tr> +<td> </td> +<td> </td> +<td>, </td> +</tr> +<tr> +<td> </td> +<td> </td> +<td>, </td> +</tr> +<tr> +<td> </td> +<td> </td> +<td> +<code>)</code>;</td> +</tr> +</table> +</div> +</div> +<div class="refsect1" lang="en"> +<a name="id2525862"></a><h2>DESCRIPTION</h2> +<p> This function is equivalent to the <span class="citerefentry"><span class="refentrytitle">getnameinfo</span>(3)</span> function defined in RFC2133. +<code class="function">lwres_getnameinfo()</code> returns the hostname for the +<span class="type">struct sockaddr</span> <em class="parameter"><code>sa</code></em> which is +<em class="parameter"><code>salen</code></em> bytes long. The hostname is of length +<em class="parameter"><code>hostlen</code></em> and is returned via +<em class="parameter"><code>*host.</code></em> The maximum length of the hostname is +1025 bytes: <code class="constant">NI_MAXHOST</code>.</p> +<p> The name of the service associated with the port number in +<em class="parameter"><code>sa</code></em> is returned in <em class="parameter"><code>*serv.</code></em> +It is <em class="parameter"><code>servlen</code></em> bytes long. The maximum length +of the service name is <code class="constant">NI_MAXSERV</code> - 32 bytes. +</p> +<p> The <em class="parameter"><code>flags</code></em> argument sets the following bits: -<P -></P -><DIV -CLASS="VARIABLELIST" -><DL -><DT -><CODE -CLASS="CONSTANT" ->NI_NOFQDN</CODE -></DT -><DD -><P ->A fully qualified domain name is not required for local hosts. -The local part of the fully qualified domain name is returned instead.</P -></DD -><DT -><CODE -CLASS="CONSTANT" ->NI_NUMERICHOST</CODE -></DT -><DD -><P ->Return the address in numeric form, as if calling inet_ntop(), -instead of a host name.</P -></DD -><DT -><CODE -CLASS="CONSTANT" ->NI_NAMEREQD</CODE -></DT -><DD -><P ->A name is required. If the hostname cannot be found in the DNS and +</p> +<div class="variablelist"><dl> +<dt><span class="term"><code class="constant">NI_NOFQDN</code></span></dt> +<dd><p> +A fully qualified domain name is not required for local hosts. +The local part of the fully qualified domain name is returned instead. +</p></dd> +<dt><span class="term"><code class="constant">NI_NUMERICHOST</code></span></dt> +<dd><p> +Return the address in numeric form, as if calling inet_ntop(), +instead of a host name. +</p></dd> +<dt><span class="term"><code class="constant">NI_NAMEREQD</code></span></dt> +<dd><p> +A name is required. If the hostname cannot be found in the DNS and this flag is set, a non-zero error code is returned. If the hostname is not found and the flag is not set, the -address is returned in numeric form.</P -></DD -><DT -><CODE -CLASS="CONSTANT" ->NI_NUMERICSERV</CODE -></DT -><DD -><P ->The service name is returned as a digit string representing the port number.</P -></DD -><DT -><CODE -CLASS="CONSTANT" ->NI_DGRAM</CODE -></DT -><DD -><P ->Specifies that the service being looked up is a datagram +address is returned in numeric form. +</p></dd> +<dt><span class="term"><code class="constant">NI_NUMERICSERV</code></span></dt> +<dd><p> +The service name is returned as a digit string representing the port number. +</p></dd> +<dt><span class="term"><code class="constant">NI_DGRAM</code></span></dt> +<dd><p> +Specifies that the service being looked up is a datagram service, and causes getservbyport() to be called with a second argument of "udp" instead of its default of "tcp". This is required for the few ports (512-514) that have different services for UDP and -TCP.</P -></DD -></DL -></DIV -></P -></DIV -><DIV -CLASS="REFSECT1" -><A -NAME="AEN70" -></A -><H2 ->RETURN VALUES</H2 -><P -><CODE -CLASS="FUNCTION" ->lwres_getnameinfo()</CODE -> -returns 0 on success or a non-zero error code if an error occurs.</P -></DIV -><DIV -CLASS="REFSECT1" -><A -NAME="AEN74" -></A -><H2 ->SEE ALSO</H2 -><P -><SPAN -CLASS="CITEREFENTRY" -><SPAN -CLASS="REFENTRYTITLE" ->RFC2133</SPAN -></SPAN ->, -<SPAN -CLASS="CITEREFENTRY" -><SPAN -CLASS="REFENTRYTITLE" ->getservbyport</SPAN ->(3)</SPAN ->, -<SPAN -CLASS="CITEREFENTRY" -><SPAN -CLASS="REFENTRYTITLE" ->lwres</SPAN ->(3)</SPAN ->, -<SPAN -CLASS="CITEREFENTRY" -><SPAN -CLASS="REFENTRYTITLE" ->lwres_getnameinfo</SPAN ->(3)</SPAN ->, -<SPAN -CLASS="CITEREFENTRY" -><SPAN -CLASS="REFENTRYTITLE" ->lwres_getnamebyaddr</SPAN ->(3)</SPAN ->. -<SPAN -CLASS="CITEREFENTRY" -><SPAN -CLASS="REFENTRYTITLE" ->lwres_net_ntop</SPAN ->(3)</SPAN ->.</P -></DIV -><DIV -CLASS="REFSECT1" -><A -NAME="AEN94" -></A -><H2 ->BUGS</H2 -><P ->RFC2133 fails to define what the nonzero return values of -<SPAN -CLASS="CITEREFENTRY" -><SPAN -CLASS="REFENTRYTITLE" ->getnameinfo</SPAN ->(3)</SPAN -> -are.</P -></DIV -></BODY -></HTML -> +TCP. +</p></dd> +</dl></div> +<p> +</p> +</div> +<div class="refsect1" lang="en"> +<a name="id2525988"></a><h2>RETURN VALUES</h2> +<p> +<code class="function">lwres_getnameinfo()</code> +returns 0 on success or a non-zero error code if an error occurs. +</p> +</div> +<div class="refsect1" lang="en"> +<a name="id2526001"></a><h2>SEE ALSO</h2> +<p> +<span class="citerefentry"><span class="refentrytitle">RFC2133</span></span>, +<span class="citerefentry"><span class="refentrytitle">getservbyport</span>(3)</span>, +<span class="citerefentry"><span class="refentrytitle">lwres</span>(3)</span>, +<span class="citerefentry"><span class="refentrytitle">lwres_getnameinfo</span>(3)</span>, +<span class="citerefentry"><span class="refentrytitle">lwres_getnamebyaddr</span>(3)</span>. +<span class="citerefentry"><span class="refentrytitle">lwres_net_ntop</span>(3)</span>. +</p> +</div> +<div class="refsect1" lang="en"> +<a name="id2526059"></a><h2>BUGS</h2> +<p> +RFC2133 fails to define what the nonzero return values of +<span class="citerefentry"><span class="refentrytitle">getnameinfo</span>(3)</span> +are. +</p> +</div> +</div></body> +</html> diff --git a/contrib/bind9/lib/lwres/man/lwres_getrrsetbyname.3 b/contrib/bind9/lib/lwres/man/lwres_getrrsetbyname.3 index 1558f6d..6d900f8 100644 --- a/contrib/bind9/lib/lwres/man/lwres_getrrsetbyname.3 +++ b/contrib/bind9/lib/lwres/man/lwres_getrrsetbyname.3 @@ -1,36 +1,41 @@ -.\" Copyright (C) 2004 Internet Systems Consortium, Inc. ("ISC") -.\" Copyright (C) 2000, 2001 Internet Software Consortium. -.\" +.\" Copyright (C) 2004, 2005 Internet Systems Consortium, Inc. ("ISC") +.\" Copyright (C) 2000, 2001 Internet Software Consortium. +.\" .\" Permission to use, copy, modify, and distribute this software for any .\" purpose with or without fee is hereby granted, provided that the above .\" copyright notice and this permission notice appear in all copies. -.\" +.\" .\" THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH .\" REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY -.\" AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT, +.\" AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT, .\" INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM .\" LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE .\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR .\" PERFORMANCE OF THIS SOFTWARE. .\" -.\" $Id: lwres_getrrsetbyname.3,v 1.11.2.1.8.1 2004/03/06 07:41:43 marka Exp $ +.\" $Id: lwres_getrrsetbyname.3,v 1.11.2.1.8.5 2005/10/13 02:33:53 marka Exp $ .\" -.TH "LWRES_GETRRSETBYNAME" "3" "Oct 18, 2000" "BIND9" "" -.SH NAME +.hy 0 +.ad l +.\" ** You probably do not want to edit this file directly ** +.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1). +.\" Instead of manually editing it, you probably should edit the DocBook XML +.\" source for it and then use the DocBook XSL Stylesheets to regenerate it. +.TH "LWRES_GETRRSETBYNAME" "3" "Oct 18, 2000" "BIND9" "BIND9" +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.SH "NAME" lwres_getrrsetbyname, lwres_freerrset \- retrieve DNS records -.SH SYNOPSIS -\fB#include <lwres/netdb.h> -.sp -.na -int -lwres_getrrsetbyname(const char *hostname, unsigned int rdclass, unsigned int rdtype, unsigned int flags, struct rrsetinfo **res); -.ad -.sp -.na -void -lwres_freerrset(struct rrsetinfo *rrset); -.ad -\fR +.SH "SYNOPSIS" +.nf +#include <lwres/netdb.h> +.fi +.HP 25 +\fBint\ \fBlwres_getrrsetbyname\fR\fR\fB(\fR\fBconst\ char\ *hostname\fR\fB, \fR\fBunsigned\ int\ rdclass\fR\fB, \fR\fBunsigned\ int\ rdtype\fR\fB, \fR\fBunsigned\ int\ flags\fR\fB, \fR\fBstruct\ rrsetinfo\ **res\fR\fB);\fR +.HP 21 +\fBvoid\ \fBlwres_freerrset\fR\fR\fB(\fR\fBstruct\ rrsetinfo\ *rrset\fR\fB);\fR .PP The following structures are used: .sp @@ -39,7 +44,6 @@ struct rdatainfo { unsigned int rdi_length; /* length of data */ unsigned char *rdi_data; /* record data */ }; - struct rrsetinfo { unsigned int rri_flags; /* RRSET_VALIDATED... */ unsigned int rri_rdclass; /* class number */ @@ -51,19 +55,17 @@ struct rrsetinfo { struct rdatainfo *rri_rdatas; /* individual records */ struct rdatainfo *rri_sigs; /* individual signatures */ }; -.sp .fi +.sp .SH "DESCRIPTION" .PP \fBlwres_getrrsetbyname()\fR gets a set of resource records associated with a \fIhostname\fR, -\fIclass\fR, -and +\fIclass\fR, and \fItype\fR. \fIhostname\fR -is -a pointer a to null-terminated string. The +is a pointer a to null\-terminated string. The \fIflags\fR field is currently unused and must be zero. .PP @@ -76,38 +78,30 @@ structure, containing a list of one or more \fBrdatainfo\fR structures containing resource records and potentially another list of \fBrdatainfo\fR -structures containing SIG resource records -associated with those records. -The members -rri_rdclass +structures containing SIG resource records associated with those records. The members +\fBrri_rdclass\fR and -rri_rdtype +\fBrri_rdtype\fR are copied from the parameters. -rri_ttl +\fBrri_ttl\fR and -rri_name -are properties of the obtained rrset. -The resource records contained in -rri_rdatas +\fBrri_name\fR +are properties of the obtained rrset. The resource records contained in +\fBrri_rdatas\fR and -rri_sigs -are in uncompressed DNS wire format. -Properties of the rdataset are represented in the -rri_flags -bitfield. If the RRSET_VALIDATED bit is set, the data has been DNSSEC -validated and the signatures verified. +\fBrri_sigs\fR +are in uncompressed DNS wire format. Properties of the rdataset are represented in the +\fBrri_flags\fR +bitfield. If the RRSET_VALIDATED bit is set, the data has been DNSSEC validated and the signatures verified. .PP All of the information returned by \fBlwres_getrrsetbyname()\fR is dynamically allocated: the -rrsetinfo +\fBrrsetinfo\fR and -rdatainfo -structures, -and the canonical host name strings pointed to by the -rrsetinfostructure. -Memory allocated for the dynamically allocated structures created by -a successful call to +\fBrdatainfo\fR +structures, and the canonical host name strings pointed to by the +\fBrrsetinfo\fRstructure. Memory allocated for the dynamically allocated structures created by a successful call to \fBlwres_getrrsetbyname()\fR is released by \fBlwres_freerrset()\fR. @@ -120,8 +114,7 @@ created by a call to .SH "RETURN VALUES" .PP \fBlwres_getrrsetbyname()\fR -returns zero on success, and one of the following error -codes if an error occurred: +returns zero on success, and one of the following error codes if an error occurred: .TP \fBERRSET_NONAME\fR the name does not exist @@ -138,7 +131,6 @@ a parameter is invalid \fBERRSET_FAIL\fR other failure .TP -\fB\fR .SH "SEE ALSO" .PP \fBlwres\fR(3). diff --git a/contrib/bind9/lib/lwres/man/lwres_getrrsetbyname.docbook b/contrib/bind9/lib/lwres/man/lwres_getrrsetbyname.docbook index 5ec7884..53c33be 100644 --- a/contrib/bind9/lib/lwres/man/lwres_getrrsetbyname.docbook +++ b/contrib/bind9/lib/lwres/man/lwres_getrrsetbyname.docbook @@ -1,7 +1,9 @@ -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.0//EN" + "http://www.oasis-open.org/docbook/xml/4.0/docbookx.dtd" + [<!ENTITY mdash "—">]> <!-- - - Copyright (C) 2004 Internet Systems Consortium, Inc. ("ISC") - - Copyright (C) 2001 Internet Software Consortium. + - Copyright (C) 2004, 2005 Internet Systems Consortium, Inc. ("ISC") + - Copyright (C) 2000, 2001 Internet Software Consortium. - - Permission to use, copy, modify, and distribute this software for any - purpose with or without fee is hereby granted, provided that the above @@ -16,7 +18,7 @@ - PERFORMANCE OF THIS SOFTWARE. --> -<!-- $Id: lwres_getrrsetbyname.docbook,v 1.3.206.1 2004/03/06 08:15:40 marka Exp $ --> +<!-- $Id: lwres_getrrsetbyname.docbook,v 1.3.206.3 2005/05/12 21:36:15 sra Exp $ --> <refentry> <refentryinfo> @@ -29,6 +31,20 @@ <manvolnum>3</manvolnum> <refmiscinfo>BIND9</refmiscinfo> </refmeta> + + <docinfo> + <copyright> + <year>2004</year> + <year>2005</year> + <holder>Internet Systems Consortium, Inc. ("ISC")</holder> + </copyright> + <copyright> + <year>2000</year> + <year>2001</year> + <holder>Internet Software Consortium.</holder> + </copyright> + </docinfo> + <refnamediv> <refname>lwres_getrrsetbyname</refname> <refname>lwres_freerrset</refname> diff --git a/contrib/bind9/lib/lwres/man/lwres_getrrsetbyname.html b/contrib/bind9/lib/lwres/man/lwres_getrrsetbyname.html index 8a688e9..f36a1d2 100644 --- a/contrib/bind9/lib/lwres/man/lwres_getrrsetbyname.html +++ b/contrib/bind9/lib/lwres/man/lwres_getrrsetbyname.html @@ -1,91 +1,80 @@ <!-- - - Copyright (C) 2004 Internet Systems Consortium, Inc. ("ISC") - - Copyright (C) 2001 Internet Software Consortium. - - + - Copyright (C) 2004, 2005 Internet Systems Consortium, Inc. ("ISC") + - Copyright (C) 2000, 2001 Internet Software Consortium. + - - Permission to use, copy, modify, and distribute this software for any - purpose with or without fee is hereby granted, provided that the above - copyright notice and this permission notice appear in all copies. - - + - - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY - - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT, + - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT, - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> - -<!-- $Id: lwres_getrrsetbyname.html,v 1.5.2.1.4.2 2004/08/22 23:39:04 marka Exp $ --> - -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<HTML -><HEAD -><TITLE ->lwres_getrrsetbyname</TITLE -><META -NAME="GENERATOR" -CONTENT="Modular DocBook HTML Stylesheet Version 1.7"></HEAD -><BODY -CLASS="REFENTRY" -BGCOLOR="#FFFFFF" -TEXT="#000000" -LINK="#0000FF" -VLINK="#840084" -ALINK="#0000FF" -><H1 -><A -NAME="AEN1" -></A ->lwres_getrrsetbyname</H1 -><DIV -CLASS="REFNAMEDIV" -><A -NAME="AEN8" -></A -><H2 ->Name</H2 ->lwres_getrrsetbyname, lwres_freerrset -- retrieve DNS records</DIV -><DIV -CLASS="REFSYNOPSISDIV" -><A -NAME="AEN12" -></A -><H2 ->Synopsis</H2 -><DIV -CLASS="FUNCSYNOPSIS" -><P -></P -><A -NAME="AEN13" -></A -><PRE -CLASS="FUNCSYNOPSISINFO" ->#include <lwres/netdb.h></PRE -><P -><CODE -><CODE -CLASS="FUNCDEF" ->int -lwres_getrrsetbyname</CODE ->(const char *hostname, unsigned int rdclass, unsigned int rdtype, unsigned int flags, struct rrsetinfo **res);</CODE -></P -><P -><CODE -><CODE -CLASS="FUNCDEF" ->void -lwres_freerrset</CODE ->(struct rrsetinfo *rrset);</CODE -></P -><P -></P -></DIV -><P ->The following structures are used: -<PRE -CLASS="PROGRAMLISTING" ->struct rdatainfo { +<!-- $Id: lwres_getrrsetbyname.html,v 1.5.2.1.4.9 2005/10/13 02:33:57 marka Exp $ --> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> +<title>lwres_getrrsetbyname</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.69.1"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"> +<a name="id2463721"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2>Name</h2> +<p>lwres_getrrsetbyname, lwres_freerrset — retrieve DNS records</p> +</div> +<div class="refsynopsisdiv"> +<h2>Synopsis</h2> +<div class="funcsynopsis"> +<pre class="funcsynopsisinfo">#include <lwres/netdb.h></pre> +<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em"> +<tr> +<td><code class="funcdef"> +int +<b class="fsfunc">lwres_getrrsetbyname</b>(</code></td> +<td> </td> +<td>, </td> +</tr> +<tr> +<td> </td> +<td> </td> +<td>, </td> +</tr> +<tr> +<td> </td> +<td> </td> +<td>, </td> +</tr> +<tr> +<td> </td> +<td> </td> +<td>, </td> +</tr> +<tr> +<td> </td> +<td> </td> +<td> +<code>)</code>;</td> +</tr> +</table> +<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0"><tr> +<td><code class="funcdef"> +void +<b class="fsfunc">lwres_freerrset</b>(</code></td> +<td> </td> +<td> +<code>)</code>;</td> +</tr></table> +</div> +<p> +The following structures are used: +</p> +<pre class="programlisting"> +struct rdatainfo { unsigned int rdi_length; /* length of data */ unsigned char *rdi_data; /* record data */ }; @@ -100,261 +89,129 @@ struct rrsetinfo { char *rri_name; /* canonical name */ struct rdatainfo *rri_rdatas; /* individual records */ struct rdatainfo *rri_sigs; /* individual signatures */ -};</PRE -></P -></DIV -><DIV -CLASS="REFSECT1" -><A -NAME="AEN29" -></A -><H2 ->DESCRIPTION</H2 -><P -><CODE -CLASS="FUNCTION" ->lwres_getrrsetbyname()</CODE -> +}; +</pre> +<p> +</p> +</div> +<div class="refsect1" lang="en"> +<a name="id2525878"></a><h2>DESCRIPTION</h2> +<p> +<code class="function">lwres_getrrsetbyname()</code> gets a set of resource records associated with a -<VAR -CLASS="PARAMETER" ->hostname</VAR ->, +<em class="parameter"><code>hostname</code></em>, -<VAR -CLASS="PARAMETER" ->class</VAR ->, +<em class="parameter"><code>class</code></em>, and -<VAR -CLASS="PARAMETER" ->type</VAR ->. +<em class="parameter"><code>type</code></em>. -<VAR -CLASS="PARAMETER" ->hostname</VAR -> +<em class="parameter"><code>hostname</code></em> is a pointer a to null-terminated string. The -<VAR -CLASS="PARAMETER" ->flags</VAR -> -field is currently unused and must be zero.</P -><P ->After a successful call to -<CODE -CLASS="FUNCTION" ->lwres_getrrsetbyname()</CODE ->, +<em class="parameter"><code>flags</code></em> +field is currently unused and must be zero. +</p> +<p> +After a successful call to +<code class="function">lwres_getrrsetbyname()</code>, -<VAR -CLASS="PARAMETER" ->*res</VAR -> +<em class="parameter"><code>*res</code></em> is a pointer to an -<SPAN -CLASS="TYPE" ->rrsetinfo</SPAN -> +<span class="type">rrsetinfo</span> structure, containing a list of one or more -<SPAN -CLASS="TYPE" ->rdatainfo</SPAN -> +<span class="type">rdatainfo</span> structures containing resource records and potentially another list of -<SPAN -CLASS="TYPE" ->rdatainfo</SPAN -> +<span class="type">rdatainfo</span> structures containing SIG resource records associated with those records. The members -<CODE -CLASS="CONSTANT" ->rri_rdclass</CODE -> +<code class="constant">rri_rdclass</code> and -<CODE -CLASS="CONSTANT" ->rri_rdtype</CODE -> +<code class="constant">rri_rdtype</code> are copied from the parameters. -<CODE -CLASS="CONSTANT" ->rri_ttl</CODE -> +<code class="constant">rri_ttl</code> and -<CODE -CLASS="CONSTANT" ->rri_name</CODE -> +<code class="constant">rri_name</code> are properties of the obtained rrset. The resource records contained in -<CODE -CLASS="CONSTANT" ->rri_rdatas</CODE -> +<code class="constant">rri_rdatas</code> and -<CODE -CLASS="CONSTANT" ->rri_sigs</CODE -> +<code class="constant">rri_sigs</code> are in uncompressed DNS wire format. Properties of the rdataset are represented in the -<CODE -CLASS="CONSTANT" ->rri_flags</CODE -> +<code class="constant">rri_flags</code> bitfield. If the RRSET_VALIDATED bit is set, the data has been DNSSEC -validated and the signatures verified. </P -><P ->All of the information returned by -<CODE -CLASS="FUNCTION" ->lwres_getrrsetbyname()</CODE -> +validated and the signatures verified. +</p> +<p> +All of the information returned by +<code class="function">lwres_getrrsetbyname()</code> is dynamically allocated: the -<CODE -CLASS="CONSTANT" ->rrsetinfo</CODE -> +<code class="constant">rrsetinfo</code> and -<CODE -CLASS="CONSTANT" ->rdatainfo</CODE -> +<code class="constant">rdatainfo</code> structures, and the canonical host name strings pointed to by the -<CODE -CLASS="CONSTANT" ->rrsetinfo</CODE ->structure. +<code class="constant">rrsetinfo</code>structure. Memory allocated for the dynamically allocated structures created by a successful call to -<CODE -CLASS="FUNCTION" ->lwres_getrrsetbyname()</CODE -> +<code class="function">lwres_getrrsetbyname()</code> is released by -<CODE -CLASS="FUNCTION" ->lwres_freerrset()</CODE ->. +<code class="function">lwres_freerrset()</code>. -<VAR -CLASS="PARAMETER" ->rrset</VAR -> +<em class="parameter"><code>rrset</code></em> is a pointer to a -<SPAN -CLASS="TYPE" ->struct rrset</SPAN -> +<span class="type">struct rrset</span> created by a call to -<CODE -CLASS="FUNCTION" ->lwres_getrrsetbyname()</CODE ->. </P -><P -></P -></DIV -><DIV -CLASS="REFSECT1" -><A -NAME="AEN62" -></A -><H2 ->RETURN VALUES</H2 -><P -><CODE -CLASS="FUNCTION" ->lwres_getrrsetbyname()</CODE -> +<code class="function">lwres_getrrsetbyname()</code>. + +</p> +<p> +</p> +</div> +<div class="refsect1" lang="en"> +<a name="id2526058"></a><h2>RETURN VALUES</h2> +<p> +<code class="function">lwres_getrrsetbyname()</code> returns zero on success, and one of the following error codes if an error occurred: -<P -></P -><DIV -CLASS="VARIABLELIST" -><DL -><DT -><CODE -CLASS="CONSTANT" ->ERRSET_NONAME</CODE -></DT -><DD -><P ->the name does not exist</P -></DD -><DT -><CODE -CLASS="CONSTANT" ->ERRSET_NODATA</CODE -></DT -><DD -><P ->the name exists, but does not have data of the desired type</P -></DD -><DT -><CODE -CLASS="CONSTANT" ->ERRSET_NOMEMORY</CODE -></DT -><DD -><P ->memory could not be allocated</P -></DD -><DT -><CODE -CLASS="CONSTANT" ->ERRSET_INVAL</CODE -></DT -><DD -><P ->a parameter is invalid</P -></DD -><DT -><CODE -CLASS="CONSTANT" ->ERRSET_FAIL</CODE -></DT -><DD -><P ->other failure</P -></DD -><DT -><CODE -CLASS="CONSTANT" -></CODE -></DT -><DD -><P -></P -></DD -></DL -></DIV -> </P -></DIV -><DIV -CLASS="REFSECT1" -><A -NAME="AEN97" -></A -><H2 ->SEE ALSO</H2 -><P -><SPAN -CLASS="CITEREFENTRY" -><SPAN -CLASS="REFENTRYTITLE" ->lwres</SPAN ->(3)</SPAN ->.</P -></DIV -></BODY -></HTML -> +</p> +<div class="variablelist"><dl> +<dt><span class="term"><code class="constant">ERRSET_NONAME</code></span></dt> +<dd><p> +the name does not exist +</p></dd> +<dt><span class="term"><code class="constant">ERRSET_NODATA</code></span></dt> +<dd><p> +the name exists, but does not have data of the desired type +</p></dd> +<dt><span class="term"><code class="constant">ERRSET_NOMEMORY</code></span></dt> +<dd><p> +memory could not be allocated +</p></dd> +<dt><span class="term"><code class="constant">ERRSET_INVAL</code></span></dt> +<dd><p> +a parameter is invalid +</p></dd> +<dt><span class="term"><code class="constant">ERRSET_FAIL</code></span></dt> +<dd><p> +other failure +</p></dd> +<dt><span class="term"><code class="constant"></code></span></dt> +<dd><p> +</p></dd> +</dl></div> +<p> + +</p> +</div> +<div class="refsect1" lang="en"> +<a name="id2526132"></a><h2>SEE ALSO</h2> +<p> +<span class="citerefentry"><span class="refentrytitle">lwres</span>(3)</span>. +</p> +</div> +</div></body> +</html> diff --git a/contrib/bind9/lib/lwres/man/lwres_gnba.3 b/contrib/bind9/lib/lwres/man/lwres_gnba.3 index 404ae41..58047ce 100644 --- a/contrib/bind9/lib/lwres/man/lwres_gnba.3 +++ b/contrib/bind9/lib/lwres/man/lwres_gnba.3 @@ -1,86 +1,68 @@ -.\" Copyright (C) 2004 Internet Systems Consortium, Inc. ("ISC") -.\" Copyright (C) 2000, 2001 Internet Software Consortium. -.\" +.\" Copyright (C) 2004, 2005 Internet Systems Consortium, Inc. ("ISC") +.\" Copyright (C) 2000, 2001 Internet Software Consortium. +.\" .\" Permission to use, copy, modify, and distribute this software for any .\" purpose with or without fee is hereby granted, provided that the above .\" copyright notice and this permission notice appear in all copies. -.\" +.\" .\" THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH .\" REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY -.\" AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT, +.\" AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT, .\" INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM .\" LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE .\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR .\" PERFORMANCE OF THIS SOFTWARE. .\" -.\" $Id: lwres_gnba.3,v 1.13.2.1.8.1 2004/03/06 07:41:43 marka Exp $ +.\" $Id: lwres_gnba.3,v 1.13.2.1.8.5 2005/10/13 02:33:53 marka Exp $ .\" -.TH "LWRES_GNBA" "3" "Jun 30, 2000" "BIND9" "" -.SH NAME +.hy 0 +.ad l +.\" ** You probably do not want to edit this file directly ** +.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1). +.\" Instead of manually editing it, you probably should edit the DocBook XML +.\" source for it and then use the DocBook XSL Stylesheets to regenerate it. +.TH "LWRES_GNBA" "3" "Jun 30, 2000" "BIND9" "BIND9" +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.SH "NAME" lwres_gnbarequest_render, lwres_gnbaresponse_render, lwres_gnbarequest_parse, lwres_gnbaresponse_parse, lwres_gnbaresponse_free, lwres_gnbarequest_free \- lightweight resolver getnamebyaddress message handling -.SH SYNOPSIS -\fB#include <lwres/lwres.h> -.sp -.na -lwres_result_t -lwres_gnbarequest_render(lwres_context_t *\fIctx\fB, lwres_gnbarequest_t *\fIreq\fB, lwres_lwpacket_t *\fIpkt\fB, lwres_buffer_t *\fIb\fB); -.ad -.sp -.na -lwres_result_t -lwres_gnbaresponse_render(lwres_context_t *ctx, lwres_gnbaresponse_t *req, lwres_lwpacket_t *pkt, lwres_buffer_t *b); -.ad -.sp -.na -lwres_result_t -lwres_gnbarequest_parse(lwres_context_t *ctx, lwres_buffer_t *b, lwres_lwpacket_t *pkt, lwres_gnbarequest_t **structp); -.ad -.sp -.na -lwres_result_t -lwres_gnbaresponse_parse(lwres_context_t *ctx, lwres_buffer_t *b, lwres_lwpacket_t *pkt, lwres_gnbaresponse_t **structp); -.ad -.sp -.na -void -lwres_gnbaresponse_free(lwres_context_t *ctx, lwres_gnbaresponse_t **structp); -.ad -.sp -.na -void -lwres_gnbarequest_free(lwres_context_t *ctx, lwres_gnbarequest_t **structp); -.ad -\fR +.SH "SYNOPSIS" +.nf +#include <lwres/lwres.h> +.fi +.HP 40 +\fBlwres_result_t\ \fBlwres_gnbarequest_render\fR\fR\fB(\fR\fBlwres_context_t\ *\fR\fB\fIctx\fR\fR\fB, \fR\fBlwres_gnbarequest_t\ *\fR\fB\fIreq\fR\fR\fB, \fR\fBlwres_lwpacket_t\ *\fR\fB\fIpkt\fR\fR\fB, \fR\fBlwres_buffer_t\ *\fR\fB\fIb\fR\fR\fB);\fR +.HP 41 +\fBlwres_result_t\ \fBlwres_gnbaresponse_render\fR\fR\fB(\fR\fBlwres_context_t\ *ctx\fR\fB, \fR\fBlwres_gnbaresponse_t\ *req\fR\fB, \fR\fBlwres_lwpacket_t\ *pkt\fR\fB, \fR\fBlwres_buffer_t\ *b\fR\fB);\fR +.HP 39 +\fBlwres_result_t\ \fBlwres_gnbarequest_parse\fR\fR\fB(\fR\fBlwres_context_t\ *ctx\fR\fB, \fR\fBlwres_buffer_t\ *b\fR\fB, \fR\fBlwres_lwpacket_t\ *pkt\fR\fB, \fR\fBlwres_gnbarequest_t\ **structp\fR\fB);\fR +.HP 40 +\fBlwres_result_t\ \fBlwres_gnbaresponse_parse\fR\fR\fB(\fR\fBlwres_context_t\ *ctx\fR\fB, \fR\fBlwres_buffer_t\ *b\fR\fB, \fR\fBlwres_lwpacket_t\ *pkt\fR\fB, \fR\fBlwres_gnbaresponse_t\ **structp\fR\fB);\fR +.HP 29 +\fBvoid\ \fBlwres_gnbaresponse_free\fR\fR\fB(\fR\fBlwres_context_t\ *ctx\fR\fB, \fR\fBlwres_gnbaresponse_t\ **structp\fR\fB);\fR +.HP 28 +\fBvoid\ \fBlwres_gnbarequest_free\fR\fR\fB(\fR\fBlwres_context_t\ *ctx\fR\fB, \fR\fBlwres_gnbarequest_t\ **structp\fR\fB);\fR .SH "DESCRIPTION" .PP -These are low-level routines for creating and parsing -lightweight resolver address-to-name lookup request and -response messages. +These are low\-level routines for creating and parsing lightweight resolver address\-to\-name lookup request and response messages. .PP -There are four main functions for the getnamebyaddr opcode. -One render function converts a getnamebyaddr request structure \(em -\fBlwres_gnbarequest_t\fR \(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 +There are four main functions for the getnamebyaddr opcode. One render function converts a getnamebyaddr request structure \(em +\fBlwres_gnbarequest_t\fR +\(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 \fBlwres_gnbaresponse_t\fR -to the canonical format. -This is complemented by a parse function which converts a packet in -canonical format to a getnamebyaddr response structure. +to the canonical format. This is complemented by a parse function which converts a packet in canonical format to a getnamebyaddr response structure. .PP These structures are defined in -\fIlwres/lwres.h\fR. -They are shown below. +\fIlwres/lwres.h\fR. They are shown below. .sp .nf #define LWRES_OPCODE_GETNAMEBYADDR 0x00010002U - typedef struct { lwres_uint32_t flags; lwres_addr_t addr; } lwres_gnbarequest_t; - typedef struct { lwres_uint32_t flags; lwres_uint16_t naliases; @@ -91,22 +73,19 @@ typedef struct { void *base; size_t baselen; } lwres_gnbaresponse_t; -.sp .fi +.sp .PP \fBlwres_gnbarequest_render()\fR uses resolver context -ctx +\fIctx\fR to convert getnamebyaddr request structure -req -to canonical format. -The packet header structure -pkt -is initialised and transferred to -buffer -b. -The contents of -*req +\fIreq\fR +to canonical format. The packet header structure +\fIpkt\fR +is initialised and transferred to buffer +\fIb\fR. The contents of +\fI*req\fR are then appended to the buffer in canonical format. \fBlwres_gnbaresponse_render()\fR performs the same task, except it converts a getnamebyaddr response structure @@ -115,19 +94,17 @@ to the lightweight resolver's canonical format. .PP \fBlwres_gnbarequest_parse()\fR uses context -ctx +\fIctx\fR to convert the contents of packet -pkt +\fIpkt\fR to a \fBlwres_gnbarequest_t\fR -structure. -Buffer -b -provides space to be used for storing this structure. -When the function succeeds, the resulting +structure. Buffer +\fIb\fR +provides space to be used for storing this structure. When the function succeeds, the resulting \fBlwres_gnbarequest_t\fR is made available through -*structp. +\fI*structp\fR. \fBlwres_gnbaresponse_parse()\fR offers the same semantics as \fBlwres_gnbarequest_parse()\fR @@ -139,32 +116,28 @@ structure. and \fBlwres_gnbarequest_free()\fR release the memory in resolver context -ctx +\fIctx\fR that was allocated to the \fBlwres_gnbaresponse_t\fR or \fBlwres_gnbarequest_t\fR structures referenced via -structp. -Any memory associated with ancillary buffers and strings for those -structures is also discarded. +\fIstructp\fR. Any memory associated with ancillary buffers and strings for those structures is also discarded. .SH "RETURN VALUES" .PP The getnamebyaddr opcode functions \fBlwres_gnbarequest_render()\fR, -\fBlwres_gnbaresponse_render()\fR -\fBlwres_gnbarequest_parse()\fR +\fBlwres_gnbaresponse_render()\fR\fBlwres_gnbarequest_parse()\fR and \fBlwres_gnbaresponse_parse()\fR all return -LWRES_R_SUCCESS -on success. -They return -LWRES_R_NOMEMORY +\fBLWRES_R_SUCCESS\fR +on success. They return +\fBLWRES_R_NOMEMORY\fR if memory allocation fails. -LWRES_R_UNEXPECTEDEND +\fBLWRES_R_UNEXPECTEDEND\fR is returned if the available space in the buffer -b +\fIb\fR is too small to accommodate the packet header or the \fBlwres_gnbarequest_t\fR and @@ -174,12 +147,11 @@ structures. and \fBlwres_gnbaresponse_parse()\fR will return -LWRES_R_UNEXPECTEDEND -if the buffer is not empty after decoding the received packet. -These functions will return -LWRES_R_FAILURE +\fBLWRES_R_UNEXPECTEDEND\fR +if the buffer is not empty after decoding the received packet. These functions will return +\fBLWRES_R_FAILURE\fR if -\fBpktflags\fR +pktflags in the packet header structure \fBlwres_lwpacket_t\fR indicate that the packet is not a response to an earlier query. diff --git a/contrib/bind9/lib/lwres/man/lwres_gnba.docbook b/contrib/bind9/lib/lwres/man/lwres_gnba.docbook index 5bd4172..7531486 100644 --- a/contrib/bind9/lib/lwres/man/lwres_gnba.docbook +++ b/contrib/bind9/lib/lwres/man/lwres_gnba.docbook @@ -1,7 +1,9 @@ -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.0//EN" + "http://www.oasis-open.org/docbook/xml/4.0/docbookx.dtd" + [<!ENTITY mdash "—">]> <!-- - - Copyright (C) 2004 Internet Systems Consortium, Inc. ("ISC") - - Copyright (C) 2001 Internet Software Consortium. + - Copyright (C) 2004, 2005 Internet Systems Consortium, Inc. ("ISC") + - Copyright (C) 2000, 2001 Internet Software Consortium. - - Permission to use, copy, modify, and distribute this software for any - purpose with or without fee is hereby granted, provided that the above @@ -16,7 +18,7 @@ - PERFORMANCE OF THIS SOFTWARE. --> -<!-- $Id: lwres_gnba.docbook,v 1.4.206.1 2004/03/06 08:15:40 marka Exp $ --> +<!-- $Id: lwres_gnba.docbook,v 1.4.206.3 2005/05/12 21:36:15 sra Exp $ --> <refentry> @@ -30,6 +32,19 @@ <refmiscinfo>BIND9</refmiscinfo> </refmeta> + <docinfo> + <copyright> + <year>2004</year> + <year>2005</year> + <holder>Internet Systems Consortium, Inc. ("ISC")</holder> + </copyright> + <copyright> + <year>2000</year> + <year>2001</year> + <holder>Internet Software Consortium.</holder> + </copyright> + </docinfo> + <refnamediv> <refname>lwres_gnbarequest_render</refname> <refname>lwres_gnbaresponse_render</refname> diff --git a/contrib/bind9/lib/lwres/man/lwres_gnba.html b/contrib/bind9/lib/lwres/man/lwres_gnba.html index 537b259..89cf35e 100644 --- a/contrib/bind9/lib/lwres/man/lwres_gnba.html +++ b/contrib/bind9/lib/lwres/man/lwres_gnba.html @@ -1,158 +1,203 @@ <!-- - - Copyright (C) 2004 Internet Systems Consortium, Inc. ("ISC") - - Copyright (C) 2001 Internet Software Consortium. - - + - Copyright (C) 2004, 2005 Internet Systems Consortium, Inc. ("ISC") + - Copyright (C) 2000, 2001 Internet Software Consortium. + - - Permission to use, copy, modify, and distribute this software for any - purpose with or without fee is hereby granted, provided that the above - copyright notice and this permission notice appear in all copies. - - + - - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY - - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT, + - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT, - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> - -<!-- $Id: lwres_gnba.html,v 1.6.2.1.4.2 2004/08/22 23:39:04 marka Exp $ --> - -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<HTML -><HEAD -><TITLE ->lwres_gnba</TITLE -><META -NAME="GENERATOR" -CONTENT="Modular DocBook HTML Stylesheet Version 1.7"></HEAD -><BODY -CLASS="REFENTRY" -BGCOLOR="#FFFFFF" -TEXT="#000000" -LINK="#0000FF" -VLINK="#840084" -ALINK="#0000FF" -><H1 -><A -NAME="AEN1" -></A ->lwres_gnba</H1 -><DIV -CLASS="REFNAMEDIV" -><A -NAME="AEN8" -></A -><H2 ->Name</H2 ->lwres_gnbarequest_render, lwres_gnbaresponse_render, lwres_gnbarequest_parse, lwres_gnbaresponse_parse, lwres_gnbaresponse_free, lwres_gnbarequest_free -- lightweight resolver getnamebyaddress message handling</DIV -><DIV -CLASS="REFSYNOPSISDIV" -><A -NAME="AEN16" -></A -><H2 ->Synopsis</H2 -><DIV -CLASS="FUNCSYNOPSIS" -><P -></P -><A -NAME="AEN17" -></A -><PRE -CLASS="FUNCSYNOPSISINFO" ->#include <lwres/lwres.h></PRE -><P -><CODE -><CODE -CLASS="FUNCDEF" ->lwres_result_t -lwres_gnbarequest_render</CODE ->(lwres_context_t *ctx, lwres_gnbarequest_t *req, lwres_lwpacket_t *pkt, lwres_buffer_t *b);</CODE -></P -><P -><CODE -><CODE -CLASS="FUNCDEF" ->lwres_result_t -lwres_gnbaresponse_render</CODE ->(lwres_context_t *ctx, lwres_gnbaresponse_t *req, lwres_lwpacket_t *pkt, lwres_buffer_t *b);</CODE -></P -><P -><CODE -><CODE -CLASS="FUNCDEF" ->lwres_result_t -lwres_gnbarequest_parse</CODE ->(lwres_context_t *ctx, lwres_buffer_t *b, lwres_lwpacket_t *pkt, lwres_gnbarequest_t **structp);</CODE -></P -><P -><CODE -><CODE -CLASS="FUNCDEF" ->lwres_result_t -lwres_gnbaresponse_parse</CODE ->(lwres_context_t *ctx, lwres_buffer_t *b, lwres_lwpacket_t *pkt, lwres_gnbaresponse_t **structp);</CODE -></P -><P -><CODE -><CODE -CLASS="FUNCDEF" ->void -lwres_gnbaresponse_free</CODE ->(lwres_context_t *ctx, lwres_gnbaresponse_t **structp);</CODE -></P -><P -><CODE -><CODE -CLASS="FUNCDEF" ->void -lwres_gnbarequest_free</CODE ->(lwres_context_t *ctx, lwres_gnbarequest_t **structp);</CODE -></P -><P -></P -></DIV -></DIV -><DIV -CLASS="REFSECT1" -><A -NAME="AEN61" -></A -><H2 ->DESCRIPTION</H2 -><P ->These are low-level routines for creating and parsing +<!-- $Id: lwres_gnba.html,v 1.6.2.1.4.9 2005/10/13 02:33:57 marka Exp $ --> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> +<title>lwres_gnba</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.69.1"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"> +<a name="id2463721"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2>Name</h2> +<p>lwres_gnbarequest_render, lwres_gnbaresponse_render, lwres_gnbarequest_parse, lwres_gnbaresponse_parse, lwres_gnbaresponse_free, lwres_gnbarequest_free — lightweight resolver getnamebyaddress message handling</p> +</div> +<div class="refsynopsisdiv"> +<h2>Synopsis</h2> +<div class="funcsynopsis"> +<pre class="funcsynopsisinfo"> +#include <lwres/lwres.h> +</pre> +<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em"> +<tr> +<td><code class="funcdef"> +lwres_result_t +<b class="fsfunc">lwres_gnbarequest_render</b> +(</code></td> +<td>lwres_context_t * </td> +<td> +<var class="pdparam">ctx</var>, </td> +</tr> +<tr> +<td> </td> +<td>lwres_gnbarequest_t * </td> +<td> +<var class="pdparam">req</var>, </td> +</tr> +<tr> +<td> </td> +<td>lwres_lwpacket_t * </td> +<td> +<var class="pdparam">pkt</var>, </td> +</tr> +<tr> +<td> </td> +<td>lwres_buffer_t * </td> +<td> +<var class="pdparam">b</var><code>)</code>;</td> +</tr> +</table> +<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em"> +<tr> +<td><code class="funcdef"> +lwres_result_t +<b class="fsfunc">lwres_gnbaresponse_render</b> +(</code></td> +<td> </td> +<td>, </td> +</tr> +<tr> +<td> </td> +<td> </td> +<td>, </td> +</tr> +<tr> +<td> </td> +<td> </td> +<td>, </td> +</tr> +<tr> +<td> </td> +<td> </td> +<td> +<code>)</code>;</td> +</tr> +</table> +<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em"> +<tr> +<td><code class="funcdef"> +lwres_result_t +<b class="fsfunc">lwres_gnbarequest_parse</b>(</code></td> +<td> </td> +<td>, </td> +</tr> +<tr> +<td> </td> +<td> </td> +<td>, </td> +</tr> +<tr> +<td> </td> +<td> </td> +<td>, </td> +</tr> +<tr> +<td> </td> +<td> </td> +<td> +<code>)</code>;</td> +</tr> +</table> +<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em"> +<tr> +<td><code class="funcdef"> +lwres_result_t +<b class="fsfunc">lwres_gnbaresponse_parse</b>(</code></td> +<td> </td> +<td>, </td> +</tr> +<tr> +<td> </td> +<td> </td> +<td>, </td> +</tr> +<tr> +<td> </td> +<td> </td> +<td>, </td> +</tr> +<tr> +<td> </td> +<td> </td> +<td> +<code>)</code>;</td> +</tr> +</table> +<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em"> +<tr> +<td><code class="funcdef"> +void +<b class="fsfunc">lwres_gnbaresponse_free</b> +(</code></td> +<td> </td> +<td>, </td> +</tr> +<tr> +<td> </td> +<td> </td> +<td> +<code>)</code>;</td> +</tr> +</table> +<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0"> +<tr> +<td><code class="funcdef"> +void +<b class="fsfunc">lwres_gnbarequest_free</b>(</code></td> +<td> </td> +<td>, </td> +</tr> +<tr> +<td> </td> +<td> </td> +<td> +<code>)</code>;</td> +</tr> +</table> +</div> +</div> +<div class="refsect1" lang="en"> +<a name="id2525975"></a><h2>DESCRIPTION</h2> +<p> +These are low-level routines for creating and parsing lightweight resolver address-to-name lookup request and -response messages.</P -><P ->There are four main functions for the getnamebyaddr opcode. -One render function converts a getnamebyaddr request structure — -<SPAN -CLASS="TYPE" ->lwres_gnbarequest_t</SPAN -> — +response messages. +</p> +<p> +There are four main functions for the getnamebyaddr opcode. +One render function converts a getnamebyaddr request structure — +<span class="type">lwres_gnbarequest_t</span> — 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 — -<SPAN -CLASS="TYPE" ->lwres_gnbaresponse_t</SPAN -> +Another render function converts the getnamebyaddr response structure — +<span class="type">lwres_gnbaresponse_t</span> to the canonical format. This is complemented by a parse function which converts a packet in -canonical format to a getnamebyaddr response structure.</P -><P ->These structures are defined in -<TT -CLASS="FILENAME" ->lwres/lwres.h</TT ->. +canonical format to a getnamebyaddr response structure. +</p> +<p> +These structures are defined in +<code class="filename">lwres/lwres.h</code>. They are shown below. -<PRE -CLASS="PROGRAMLISTING" ->#define LWRES_OPCODE_GETNAMEBYADDR 0x00010002U +</p> +<pre class="programlisting"> +#define LWRES_OPCODE_GETNAMEBYADDR 0x00010002U typedef struct { lwres_uint32_t flags; @@ -168,242 +213,112 @@ typedef struct { lwres_uint16_t *aliaslen; void *base; size_t baselen; -} lwres_gnbaresponse_t;</PRE -></P -><P -><CODE -CLASS="FUNCTION" ->lwres_gnbarequest_render()</CODE -> +} lwres_gnbaresponse_t; +</pre> +<p> +</p> +<p> +<code class="function">lwres_gnbarequest_render()</code> uses resolver context -<VAR -CLASS="VARNAME" ->ctx</VAR -> +<code class="varname">ctx</code> to convert getnamebyaddr request structure -<VAR -CLASS="VARNAME" ->req</VAR -> +<code class="varname">req</code> to canonical format. The packet header structure -<VAR -CLASS="VARNAME" ->pkt</VAR -> +<code class="varname">pkt</code> is initialised and transferred to buffer -<VAR -CLASS="VARNAME" ->b</VAR ->. +<code class="varname">b</code>. The contents of -<VAR -CLASS="VARNAME" ->*req</VAR -> +<code class="varname">*req</code> are then appended to the buffer in canonical format. -<CODE -CLASS="FUNCTION" ->lwres_gnbaresponse_render()</CODE -> +<code class="function">lwres_gnbaresponse_render()</code> performs the same task, except it converts a getnamebyaddr response structure -<SPAN -CLASS="TYPE" ->lwres_gnbaresponse_t</SPAN -> -to the lightweight resolver's canonical format.</P -><P -><CODE -CLASS="FUNCTION" ->lwres_gnbarequest_parse()</CODE -> +<span class="type">lwres_gnbaresponse_t</span> +to the lightweight resolver's canonical format. +</p> +<p> +<code class="function">lwres_gnbarequest_parse()</code> uses context -<VAR -CLASS="VARNAME" ->ctx</VAR -> +<code class="varname">ctx</code> to convert the contents of packet -<VAR -CLASS="VARNAME" ->pkt</VAR -> +<code class="varname">pkt</code> to a -<SPAN -CLASS="TYPE" ->lwres_gnbarequest_t</SPAN -> +<span class="type">lwres_gnbarequest_t</span> structure. Buffer -<VAR -CLASS="VARNAME" ->b</VAR -> +<code class="varname">b</code> provides space to be used for storing this structure. When the function succeeds, the resulting -<SPAN -CLASS="TYPE" ->lwres_gnbarequest_t</SPAN -> +<span class="type">lwres_gnbarequest_t</span> is made available through -<VAR -CLASS="VARNAME" ->*structp</VAR ->. -<CODE -CLASS="FUNCTION" ->lwres_gnbaresponse_parse()</CODE -> +<code class="varname">*structp</code>. +<code class="function">lwres_gnbaresponse_parse()</code> offers the same semantics as -<CODE -CLASS="FUNCTION" ->lwres_gnbarequest_parse()</CODE -> +<code class="function">lwres_gnbarequest_parse()</code> except it yields a -<SPAN -CLASS="TYPE" ->lwres_gnbaresponse_t</SPAN -> -structure.</P -><P -><CODE -CLASS="FUNCTION" ->lwres_gnbaresponse_free()</CODE -> +<span class="type">lwres_gnbaresponse_t</span> +structure. +</p> +<p> +<code class="function">lwres_gnbaresponse_free()</code> and -<CODE -CLASS="FUNCTION" ->lwres_gnbarequest_free()</CODE -> +<code class="function">lwres_gnbarequest_free()</code> release the memory in resolver context -<VAR -CLASS="VARNAME" ->ctx</VAR -> +<code class="varname">ctx</code> that was allocated to the -<SPAN -CLASS="TYPE" ->lwres_gnbaresponse_t</SPAN -> +<span class="type">lwres_gnbaresponse_t</span> or -<SPAN -CLASS="TYPE" ->lwres_gnbarequest_t</SPAN -> +<span class="type">lwres_gnbarequest_t</span> structures referenced via -<VAR -CLASS="VARNAME" ->structp</VAR ->. +<code class="varname">structp</code>. Any memory associated with ancillary buffers and strings for those -structures is also discarded.</P -></DIV -><DIV -CLASS="REFSECT1" -><A -NAME="AEN97" -></A -><H2 ->RETURN VALUES</H2 -><P ->The getnamebyaddr opcode functions -<CODE -CLASS="FUNCTION" ->lwres_gnbarequest_render()</CODE ->, -<CODE -CLASS="FUNCTION" ->lwres_gnbaresponse_render()</CODE -> -<CODE -CLASS="FUNCTION" ->lwres_gnbarequest_parse()</CODE -> +structures is also discarded. +</p> +</div> +<div class="refsect1" lang="en"> +<a name="id2526100"></a><h2>RETURN VALUES</h2> +<p> +The getnamebyaddr opcode functions +<code class="function">lwres_gnbarequest_render()</code>, +<code class="function">lwres_gnbaresponse_render()</code> +<code class="function">lwres_gnbarequest_parse()</code> and -<CODE -CLASS="FUNCTION" ->lwres_gnbaresponse_parse()</CODE -> +<code class="function">lwres_gnbaresponse_parse()</code> all return -<SPAN -CLASS="ERRORCODE" ->LWRES_R_SUCCESS</SPAN -> +<span class="errorcode">LWRES_R_SUCCESS</span> on success. They return -<SPAN -CLASS="ERRORCODE" ->LWRES_R_NOMEMORY</SPAN -> +<span class="errorcode">LWRES_R_NOMEMORY</span> if memory allocation fails. -<SPAN -CLASS="ERRORCODE" ->LWRES_R_UNEXPECTEDEND</SPAN -> +<span class="errorcode">LWRES_R_UNEXPECTEDEND</span> is returned if the available space in the buffer -<VAR -CLASS="VARNAME" ->b</VAR -> +<code class="varname">b</code> is too small to accommodate the packet header or the -<SPAN -CLASS="TYPE" ->lwres_gnbarequest_t</SPAN -> +<span class="type">lwres_gnbarequest_t</span> and -<SPAN -CLASS="TYPE" ->lwres_gnbaresponse_t</SPAN -> +<span class="type">lwres_gnbaresponse_t</span> structures. -<CODE -CLASS="FUNCTION" ->lwres_gnbarequest_parse()</CODE -> +<code class="function">lwres_gnbarequest_parse()</code> and -<CODE -CLASS="FUNCTION" ->lwres_gnbaresponse_parse()</CODE -> +<code class="function">lwres_gnbaresponse_parse()</code> will return -<SPAN -CLASS="ERRORCODE" ->LWRES_R_UNEXPECTEDEND</SPAN -> +<span class="errorcode">LWRES_R_UNEXPECTEDEND</span> if the buffer is not empty after decoding the received packet. These functions will return -<SPAN -CLASS="ERRORCODE" ->LWRES_R_FAILURE</SPAN -> +<span class="errorcode">LWRES_R_FAILURE</span> if -<CODE -CLASS="STRUCTFIELD" ->pktflags</CODE -> +<em class="structfield"><code>pktflags</code></em> in the packet header structure -<SPAN -CLASS="TYPE" ->lwres_lwpacket_t</SPAN -> -indicate that the packet is not a response to an earlier query.</P -></DIV -><DIV -CLASS="REFSECT1" -><A -NAME="AEN116" -></A -><H2 ->SEE ALSO</H2 -><P -><SPAN -CLASS="CITEREFENTRY" -><SPAN -CLASS="REFENTRYTITLE" ->lwres_packet</SPAN ->(3)</SPAN ->.</P -></DIV -></BODY -></HTML -> +<span class="type">lwres_lwpacket_t</span> +indicate that the packet is not a response to an earlier query. +</p> +</div> +<div class="refsect1" lang="en"> +<a name="id2526165"></a><h2>SEE ALSO</h2> +<p> +<span class="citerefentry"><span class="refentrytitle">lwres_packet</span>(3)</span>. +</p> +</div> +</div></body> +</html> diff --git a/contrib/bind9/lib/lwres/man/lwres_hstrerror.3 b/contrib/bind9/lib/lwres/man/lwres_hstrerror.3 index 2260088..a1ecf7c 100644 --- a/contrib/bind9/lib/lwres/man/lwres_hstrerror.3 +++ b/contrib/bind9/lib/lwres/man/lwres_hstrerror.3 @@ -1,67 +1,79 @@ -.\" Copyright (C) 2004 Internet Systems Consortium, Inc. ("ISC") -.\" Copyright (C) 2000, 2001 Internet Software Consortium. -.\" +.\" Copyright (C) 2004, 2005 Internet Systems Consortium, Inc. ("ISC") +.\" Copyright (C) 2000, 2001 Internet Software Consortium. +.\" .\" Permission to use, copy, modify, and distribute this software for any .\" purpose with or without fee is hereby granted, provided that the above .\" copyright notice and this permission notice appear in all copies. -.\" +.\" .\" THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH .\" REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY -.\" AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT, +.\" AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT, .\" INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM .\" LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE .\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR .\" PERFORMANCE OF THIS SOFTWARE. .\" -.\" $Id: lwres_hstrerror.3,v 1.13.2.1.8.1 2004/03/06 07:41:43 marka Exp $ +.\" $Id: lwres_hstrerror.3,v 1.13.2.1.8.5 2005/10/13 02:33:53 marka Exp $ .\" -.TH "LWRES_HSTRERROR" "3" "Jun 30, 2000" "BIND9" "" -.SH NAME +.hy 0 +.ad l +.\" ** You probably do not want to edit this file directly ** +.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1). +.\" Instead of manually editing it, you probably should edit the DocBook XML +.\" source for it and then use the DocBook XSL Stylesheets to regenerate it. +.TH "LWRES_HSTRERROR" "3" "Jun 30, 2000" "BIND9" "BIND9" +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.SH "NAME" lwres_herror, lwres_hstrerror \- lightweight resolver error message generation -.SH SYNOPSIS -\fB#include <lwres/netdb.h> -.sp -.na -void -lwres_herror(const char *s); -.ad -.sp -.na -const char * -lwres_hstrerror(int err); -.ad -\fR +.SH "SYNOPSIS" +.nf +#include <lwres/netdb.h> +.fi +.HP 18 +\fBvoid\ \fBlwres_herror\fR\fR\fB(\fR\fBconst\ char\ *s\fR\fB);\fR +.HP 29 +\fBconst\ char\ *\ \fBlwres_hstrerror\fR\fR\fB(\fR\fBint\ err\fR\fB);\fR .SH "DESCRIPTION" .PP -\fBlwres_herror()\fR prints the string -\fIs\fR on \fBstderr\fR followed by the string -generated by \fBlwres_hstrerror()\fR for the error code -stored in the global variable lwres_h_errno. +\fBlwres_herror()\fR +prints the string +\fIs\fR +on +\fBstderr\fR +followed by the string generated by +\fBlwres_hstrerror()\fR +for the error code stored in the global variable +\fBlwres_h_errno\fR. .PP -\fBlwres_hstrerror()\fR returns an appropriate string -for the error code gievn by \fIerr\fR. The values of -the error codes and messages are as follows: +\fBlwres_hstrerror()\fR +returns an appropriate string for the error code gievn by +\fIerr\fR. The values of the error codes and messages are as follows: .TP \fBNETDB_SUCCESS\fR -\fBResolver Error 0 (no error)\fR +Resolver Error 0 (no error) .TP \fBHOST_NOT_FOUND\fR -\fBUnknown host\fR +Unknown host .TP \fBTRY_AGAIN\fR -\fBHost name lookup failure\fR +Host name lookup failure .TP \fBNO_RECOVERY\fR -\fBUnknown server error\fR +Unknown server error .TP \fBNO_DATA\fR -\fBNo address associated with name\fR +No address associated with name .SH "RETURN VALUES" .PP -The string \fBUnknown resolver error\fR is returned by +The string +Unknown resolver error +is returned by \fBlwres_hstrerror()\fR when the value of -lwres_h_errno +\fBlwres_h_errno\fR is not a valid error code. .SH "SEE ALSO" .PP diff --git a/contrib/bind9/lib/lwres/man/lwres_hstrerror.docbook b/contrib/bind9/lib/lwres/man/lwres_hstrerror.docbook index 2ad4c49..a36c072 100644 --- a/contrib/bind9/lib/lwres/man/lwres_hstrerror.docbook +++ b/contrib/bind9/lib/lwres/man/lwres_hstrerror.docbook @@ -1,7 +1,9 @@ -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.0//EN" + "http://www.oasis-open.org/docbook/xml/4.0/docbookx.dtd" + [<!ENTITY mdash "—">]> <!-- - - Copyright (C) 2004 Internet Systems Consortium, Inc. ("ISC") - - Copyright (C) 2001 Internet Software Consortium. + - Copyright (C) 2004, 2005 Internet Systems Consortium, Inc. ("ISC") + - Copyright (C) 2000, 2001 Internet Software Consortium. - - Permission to use, copy, modify, and distribute this software for any - purpose with or without fee is hereby granted, provided that the above @@ -16,7 +18,7 @@ - PERFORMANCE OF THIS SOFTWARE. --> -<!-- $Id: lwres_hstrerror.docbook,v 1.4.206.1 2004/03/06 08:15:41 marka Exp $ --> +<!-- $Id: lwres_hstrerror.docbook,v 1.4.206.3 2005/05/12 21:36:15 sra Exp $ --> <refentry> @@ -30,6 +32,19 @@ <refmiscinfo>BIND9</refmiscinfo> </refmeta> + <docinfo> + <copyright> + <year>2004</year> + <year>2005</year> + <holder>Internet Systems Consortium, Inc. ("ISC")</holder> + </copyright> + <copyright> + <year>2000</year> + <year>2001</year> + <holder>Internet Software Consortium.</holder> + </copyright> + </docinfo> + <refnamediv> <refname>lwres_herror</refname> <refname>lwres_hstrerror</refname> diff --git a/contrib/bind9/lib/lwres/man/lwres_hstrerror.html b/contrib/bind9/lib/lwres/man/lwres_hstrerror.html index 0c264af..4204a33 100644 --- a/contrib/bind9/lib/lwres/man/lwres_hstrerror.html +++ b/contrib/bind9/lib/lwres/man/lwres_hstrerror.html @@ -1,241 +1,100 @@ <!-- - - Copyright (C) 2004 Internet Systems Consortium, Inc. ("ISC") - - Copyright (C) 2001 Internet Software Consortium. - - + - Copyright (C) 2004, 2005 Internet Systems Consortium, Inc. ("ISC") + - Copyright (C) 2000, 2001 Internet Software Consortium. + - - Permission to use, copy, modify, and distribute this software for any - purpose with or without fee is hereby granted, provided that the above - copyright notice and this permission notice appear in all copies. - - + - - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY - - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT, + - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT, - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> - -<!-- $Id: lwres_hstrerror.html,v 1.5.2.1.4.2 2004/08/22 23:39:04 marka Exp $ --> - -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<HTML -><HEAD -><TITLE ->lwres_hstrerror</TITLE -><META -NAME="GENERATOR" -CONTENT="Modular DocBook HTML Stylesheet Version 1.7"></HEAD -><BODY -CLASS="REFENTRY" -BGCOLOR="#FFFFFF" -TEXT="#000000" -LINK="#0000FF" -VLINK="#840084" -ALINK="#0000FF" -><H1 -><A -NAME="AEN1" -></A ->lwres_hstrerror</H1 -><DIV -CLASS="REFNAMEDIV" -><A -NAME="AEN8" -></A -><H2 ->Name</H2 ->lwres_herror, lwres_hstrerror -- lightweight resolver error message generation</DIV -><DIV -CLASS="REFSYNOPSISDIV" -><A -NAME="AEN12" -></A -><H2 ->Synopsis</H2 -><DIV -CLASS="FUNCSYNOPSIS" -><P -></P -><A -NAME="AEN13" -></A -><PRE -CLASS="FUNCSYNOPSISINFO" ->#include <lwres/netdb.h></PRE -><P -><CODE -><CODE -CLASS="FUNCDEF" ->void -lwres_herror</CODE ->(const char *s);</CODE -></P -><P -><CODE -><CODE -CLASS="FUNCDEF" ->const char * -lwres_hstrerror</CODE ->(int err);</CODE -></P -><P -></P -></DIV -></DIV -><DIV -CLASS="REFSECT1" -><A -NAME="AEN23" -></A -><H2 ->DESCRIPTION</H2 -><P -><CODE -CLASS="FUNCTION" ->lwres_herror()</CODE -> prints the string -<VAR -CLASS="PARAMETER" ->s</VAR -> on <SPAN -CLASS="TYPE" ->stderr</SPAN -> followed by the string -generated by <CODE -CLASS="FUNCTION" ->lwres_hstrerror()</CODE -> for the error code -stored in the global variable <CODE -CLASS="CONSTANT" ->lwres_h_errno</CODE ->.</P -><P -><CODE -CLASS="FUNCTION" ->lwres_hstrerror()</CODE -> returns an appropriate string -for the error code gievn by <VAR -CLASS="PARAMETER" ->err</VAR ->. The values of +<!-- $Id: lwres_hstrerror.html,v 1.5.2.1.4.9 2005/10/13 02:33:57 marka Exp $ --> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> +<title>lwres_hstrerror</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.69.1"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"> +<a name="id2463721"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2>Name</h2> +<p>lwres_herror, lwres_hstrerror — lightweight resolver error message generation</p> +</div> +<div class="refsynopsisdiv"> +<h2>Synopsis</h2> +<div class="funcsynopsis"> +<pre class="funcsynopsisinfo">#include <lwres/netdb.h></pre> +<p><code class="funcdef"> +void +<b class="fsfunc">lwres_herror</b>(</code>const char *s<code>)</code>;</p> +<p><code class="funcdef"> +const char * +<b class="fsfunc">lwres_hstrerror</b>(</code>int err<code>)</code>;</p> +</div> +</div> +<div class="refsect1" lang="en"> +<a name="id2525859"></a><h2>DESCRIPTION</h2> +<p> +<code class="function">lwres_herror()</code> prints the string +<em class="parameter"><code>s</code></em> on <span class="type">stderr</span> followed by the string +generated by <code class="function">lwres_hstrerror()</code> for the error code +stored in the global variable <code class="constant">lwres_h_errno</code>. +</p> +<p> +<code class="function">lwres_hstrerror()</code> returns an appropriate string +for the error code gievn by <em class="parameter"><code>err</code></em>. The values of the error codes and messages are as follows: -<P -></P -><DIV -CLASS="VARIABLELIST" -><DL -><DT -><SPAN -CLASS="ERRORCODE" ->NETDB_SUCCESS</SPAN -></DT -><DD -><P -><SPAN -CLASS="ERRORNAME" ->Resolver Error 0 (no error)</SPAN -></P -></DD -><DT -><SPAN -CLASS="ERRORCODE" ->HOST_NOT_FOUND</SPAN -></DT -><DD -><P -><SPAN -CLASS="ERRORNAME" ->Unknown host</SPAN -></P -></DD -><DT -><SPAN -CLASS="ERRORCODE" ->TRY_AGAIN</SPAN -></DT -><DD -><P -><SPAN -CLASS="ERRORNAME" ->Host name lookup failure</SPAN -></P -></DD -><DT -><SPAN -CLASS="ERRORCODE" ->NO_RECOVERY</SPAN -></DT -><DD -><P -><SPAN -CLASS="ERRORNAME" ->Unknown server error</SPAN -></P -></DD -><DT -><SPAN -CLASS="ERRORCODE" ->NO_DATA</SPAN -></DT -><DD -><P -><SPAN -CLASS="ERRORNAME" ->No address associated with name</SPAN -></P -></DD -></DL -></DIV -></P -></DIV -><DIV -CLASS="REFSECT1" -><A -NAME="AEN65" -></A -><H2 ->RETURN VALUES</H2 -><P ->The string <SPAN -CLASS="ERRORNAME" ->Unknown resolver error</SPAN -> is returned by -<CODE -CLASS="FUNCTION" ->lwres_hstrerror()</CODE -> +</p> +<div class="variablelist"><dl> +<dt><span class="term"><span class="errorcode">NETDB_SUCCESS</span></span></dt> +<dd><p> +<span class="errorname">Resolver Error 0 (no error)</span> +</p></dd> +<dt><span class="term"><span class="errorcode">HOST_NOT_FOUND</span></span></dt> +<dd><p> +<span class="errorname">Unknown host</span> +</p></dd> +<dt><span class="term"><span class="errorcode">TRY_AGAIN</span></span></dt> +<dd><p> +<span class="errorname">Host name lookup failure</span> +</p></dd> +<dt><span class="term"><span class="errorcode">NO_RECOVERY</span></span></dt> +<dd><p> +<span class="errorname">Unknown server error</span> +</p></dd> +<dt><span class="term"><span class="errorcode">NO_DATA</span></span></dt> +<dd><p> +<span class="errorname">No address associated with name</span> +</p></dd> +</dl></div> +<p> +</p> +</div> +<div class="refsect1" lang="en"> +<a name="id2525971"></a><h2>RETURN VALUES</h2> +<p> +The string <span class="errorname">Unknown resolver error</span> is returned by +<code class="function">lwres_hstrerror()</code> when the value of -<CODE -CLASS="CONSTANT" ->lwres_h_errno</CODE -> -is not a valid error code.</P -></DIV -><DIV -CLASS="REFSECT1" -><A -NAME="AEN71" -></A -><H2 ->SEE ALSO</H2 -><P -><SPAN -CLASS="CITEREFENTRY" -><SPAN -CLASS="REFENTRYTITLE" ->herror</SPAN ->(3)</SPAN ->, +<code class="constant">lwres_h_errno</code> +is not a valid error code. +</p> +</div> +<div class="refsect1" lang="en"> +<a name="id2525990"></a><h2>SEE ALSO</h2> +<p> +<span class="citerefentry"><span class="refentrytitle">herror</span>(3)</span>, -<SPAN -CLASS="CITEREFENTRY" -><SPAN -CLASS="REFENTRYTITLE" ->lwres_hstrerror</SPAN ->(3)</SPAN ->.</P -></DIV -></BODY -></HTML -> +<span class="citerefentry"><span class="refentrytitle">lwres_hstrerror</span>(3)</span>. +</p> +</div> +</div></body> +</html> diff --git a/contrib/bind9/lib/lwres/man/lwres_inetntop.3 b/contrib/bind9/lib/lwres/man/lwres_inetntop.3 index a4603c6..782cbaf 100644 --- a/contrib/bind9/lib/lwres/man/lwres_inetntop.3 +++ b/contrib/bind9/lib/lwres/man/lwres_inetntop.3 @@ -1,54 +1,69 @@ -.\" Copyright (C) 2004 Internet Systems Consortium, Inc. ("ISC") -.\" Copyright (C) 2000, 2001 Internet Software Consortium. -.\" +.\" Copyright (C) 2004, 2005 Internet Systems Consortium, Inc. ("ISC") +.\" Copyright (C) 2000, 2001 Internet Software Consortium. +.\" .\" Permission to use, copy, modify, and distribute this software for any .\" purpose with or without fee is hereby granted, provided that the above .\" copyright notice and this permission notice appear in all copies. -.\" +.\" .\" THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH .\" REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY -.\" AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT, +.\" AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT, .\" INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM .\" LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE .\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR .\" PERFORMANCE OF THIS SOFTWARE. .\" -.\" $Id: lwres_inetntop.3,v 1.12.2.1.8.1 2004/03/06 07:41:44 marka Exp $ +.\" $Id: lwres_inetntop.3,v 1.12.2.1.8.5 2005/10/13 02:33:53 marka Exp $ .\" -.TH "LWRES_INETNTOP" "3" "Jun 30, 2000" "BIND9" "" -.SH NAME +.hy 0 +.ad l +.\" ** You probably do not want to edit this file directly ** +.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1). +.\" Instead of manually editing it, you probably should edit the DocBook XML +.\" source for it and then use the DocBook XSL Stylesheets to regenerate it. +.TH "LWRES_INETNTOP" "3" "Jun 30, 2000" "BIND9" "BIND9" +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.SH "NAME" lwres_net_ntop \- lightweight resolver IP address presentation -.SH SYNOPSIS -\fB#include <lwres/net.h> -.sp -.na -const char * -lwres_net_ntop(int af, const void *src, char *dst, size_t size); -.ad -\fR +.SH "SYNOPSIS" +.nf +#include <lwres/net.h> +.fi +.HP 28 +\fBconst\ char\ *\ \fBlwres_net_ntop\fR\fR\fB(\fR\fBint\ af\fR\fB, \fR\fBconst\ void\ *src\fR\fB, \fR\fBchar\ *dst\fR\fB, \fR\fBsize_t\ size\fR\fB);\fR .SH "DESCRIPTION" .PP -\fBlwres_net_ntop()\fR converts an IP address of -protocol family \fIaf\fR \(em IPv4 or IPv6 \(em -at location \fIsrc\fR from network format to its -conventional representation as a string. For IPv4 addresses, that -string would be a dotted-decimal. An IPv6 address would be -represented in colon notation as described in RFC1884. +\fBlwres_net_ntop()\fR +converts an IP address of protocol family +\fIaf\fR +\(em IPv4 or IPv6 \(em at location +\fIsrc\fR +from network format to its conventional representation as a string. For IPv4 addresses, that string would be a dotted\-decimal. An IPv6 address would be represented in colon notation as described in RFC1884. .PP -The generated string is copied to \fIdst\fR provided -\fIsize\fR indicates it is long enough to store the -ASCII representation of the address. +The generated string is copied to +\fIdst\fR +provided +\fIsize\fR +indicates it is long enough to store the ASCII representation of the address. .SH "RETURN VALUES" .PP -If successful, the function returns \fIdst\fR: -a pointer to a string containing the presentation format of the -address. \fBlwres_net_ntop()\fR returns -\fBNULL\fR and sets the global variable -errno to EAFNOSUPPORT if -the protocol family given in \fIaf\fR is not -supported. +If successful, the function returns +\fIdst\fR: a pointer to a string containing the presentation format of the address. +\fBlwres_net_ntop()\fR +returns +\fBNULL\fR +and sets the global variable +\fBerrno\fR +to +\fBEAFNOSUPPORT\fR +if the protocol family given in +\fIaf\fR +is not supported. .SH "SEE ALSO" .PP -\fBRFC1884\fR, +\fBRFC1884\fR(), \fBinet_ntop\fR(3), \fBerrno\fR(3). diff --git a/contrib/bind9/lib/lwres/man/lwres_inetntop.docbook b/contrib/bind9/lib/lwres/man/lwres_inetntop.docbook index e771478..651ef04 100644 --- a/contrib/bind9/lib/lwres/man/lwres_inetntop.docbook +++ b/contrib/bind9/lib/lwres/man/lwres_inetntop.docbook @@ -1,7 +1,9 @@ -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.0//EN" + "http://www.oasis-open.org/docbook/xml/4.0/docbookx.dtd" + [<!ENTITY mdash "—">]> <!-- - - Copyright (C) 2004 Internet Systems Consortium, Inc. ("ISC") - - Copyright (C) 2001 Internet Software Consortium. + - Copyright (C) 2004, 2005 Internet Systems Consortium, Inc. ("ISC") + - Copyright (C) 2000, 2001 Internet Software Consortium. - - Permission to use, copy, modify, and distribute this software for any - purpose with or without fee is hereby granted, provided that the above @@ -16,7 +18,7 @@ - PERFORMANCE OF THIS SOFTWARE. --> -<!-- $Id: lwres_inetntop.docbook,v 1.3.206.1 2004/03/06 08:15:41 marka Exp $ --> +<!-- $Id: lwres_inetntop.docbook,v 1.3.206.3 2005/05/12 21:36:15 sra Exp $ --> <refentry> @@ -30,6 +32,19 @@ <refmiscinfo>BIND9</refmiscinfo> </refmeta> + <docinfo> + <copyright> + <year>2004</year> + <year>2005</year> + <holder>Internet Systems Consortium, Inc. ("ISC")</holder> + </copyright> + <copyright> + <year>2000</year> + <year>2001</year> + <holder>Internet Software Consortium.</holder> + </copyright> + </docinfo> + <refnamediv> <refname>lwres_net_ntop</refname> <refpurpose>lightweight resolver IP address presentation</refpurpose> diff --git a/contrib/bind9/lib/lwres/man/lwres_inetntop.html b/contrib/bind9/lib/lwres/man/lwres_inetntop.html index 3453345..3c794a5 100644 --- a/contrib/bind9/lib/lwres/man/lwres_inetntop.html +++ b/contrib/bind9/lib/lwres/man/lwres_inetntop.html @@ -1,177 +1,98 @@ <!-- - - Copyright (C) 2004 Internet Systems Consortium, Inc. ("ISC") - - Copyright (C) 2001 Internet Software Consortium. - - + - Copyright (C) 2004, 2005 Internet Systems Consortium, Inc. ("ISC") + - Copyright (C) 2000, 2001 Internet Software Consortium. + - - Permission to use, copy, modify, and distribute this software for any - purpose with or without fee is hereby granted, provided that the above - copyright notice and this permission notice appear in all copies. - - + - - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY - - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT, + - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT, - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> - -<!-- $Id: lwres_inetntop.html,v 1.5.2.1.4.2 2004/08/22 23:39:05 marka Exp $ --> - -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<HTML -><HEAD -><TITLE ->lwres_inetntop</TITLE -><META -NAME="GENERATOR" -CONTENT="Modular DocBook HTML Stylesheet Version 1.7"></HEAD -><BODY -CLASS="REFENTRY" -BGCOLOR="#FFFFFF" -TEXT="#000000" -LINK="#0000FF" -VLINK="#840084" -ALINK="#0000FF" -><H1 -><A -NAME="AEN1" -></A ->lwres_inetntop</H1 -><DIV -CLASS="REFNAMEDIV" -><A -NAME="AEN8" -></A -><H2 ->Name</H2 ->lwres_net_ntop -- lightweight resolver IP address presentation</DIV -><DIV -CLASS="REFSYNOPSISDIV" -><A -NAME="AEN11" -></A -><H2 ->Synopsis</H2 -><DIV -CLASS="FUNCSYNOPSIS" -><P -></P -><A -NAME="AEN12" -></A -><PRE -CLASS="FUNCSYNOPSISINFO" ->#include <lwres/net.h></PRE -><P -><CODE -><CODE -CLASS="FUNCDEF" ->const char * -lwres_net_ntop</CODE ->(int af, const void *src, char *dst, size_t size);</CODE -></P -><P -></P -></DIV -></DIV -><DIV -CLASS="REFSECT1" -><A -NAME="AEN21" -></A -><H2 ->DESCRIPTION</H2 -><P -><CODE -CLASS="FUNCTION" ->lwres_net_ntop()</CODE -> converts an IP address of -protocol family <VAR -CLASS="PARAMETER" ->af</VAR -> — IPv4 or IPv6 — -at location <VAR -CLASS="PARAMETER" ->src</VAR -> from network format to its +<!-- $Id: lwres_inetntop.html,v 1.5.2.1.4.9 2005/10/13 02:33:57 marka Exp $ --> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> +<title>lwres_inetntop</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.69.1"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"> +<a name="id2463721"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2>Name</h2> +<p>lwres_net_ntop — lightweight resolver IP address presentation</p> +</div> +<div class="refsynopsisdiv"> +<h2>Synopsis</h2> +<div class="funcsynopsis"> +<pre class="funcsynopsisinfo">#include <lwres/net.h></pre> +<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0"> +<tr> +<td><code class="funcdef"> +const char * +<b class="fsfunc">lwres_net_ntop</b>(</code></td> +<td> </td> +<td>, </td> +</tr> +<tr> +<td> </td> +<td> </td> +<td>, </td> +</tr> +<tr> +<td> </td> +<td> </td> +<td>, </td> +</tr> +<tr> +<td> </td> +<td> </td> +<td> +<code>)</code>;</td> +</tr> +</table> +</div> +</div> +<div class="refsect1" lang="en"> +<a name="id2525854"></a><h2>DESCRIPTION</h2> +<p> +<code class="function">lwres_net_ntop()</code> converts an IP address of +protocol family <em class="parameter"><code>af</code></em> — IPv4 or IPv6 — +at location <em class="parameter"><code>src</code></em> from network format to its conventional representation as a string. For IPv4 addresses, that string would be a dotted-decimal. An IPv6 address would be -represented in colon notation as described in RFC1884.</P -><P ->The generated string is copied to <VAR -CLASS="PARAMETER" ->dst</VAR -> provided -<VAR -CLASS="PARAMETER" ->size</VAR -> indicates it is long enough to store the -ASCII representation of the address.</P -></DIV -><DIV -CLASS="REFSECT1" -><A -NAME="AEN30" -></A -><H2 ->RETURN VALUES</H2 -><P ->If successful, the function returns <VAR -CLASS="PARAMETER" ->dst</VAR ->: +represented in colon notation as described in RFC1884. +</p> +<p> +The generated string is copied to <em class="parameter"><code>dst</code></em> provided +<em class="parameter"><code>size</code></em> indicates it is long enough to store the +ASCII representation of the address. +</p> +</div> +<div class="refsect1" lang="en"> +<a name="id2525888"></a><h2>RETURN VALUES</h2> +<p> +If successful, the function returns <em class="parameter"><code>dst</code></em>: a pointer to a string containing the presentation format of the -address. <CODE -CLASS="FUNCTION" ->lwres_net_ntop()</CODE -> returns -<SPAN -CLASS="TYPE" ->NULL</SPAN -> and sets the global variable -<CODE -CLASS="CONSTANT" ->errno</CODE -> to <SPAN -CLASS="ERRORCODE" ->EAFNOSUPPORT</SPAN -> if -the protocol family given in <VAR -CLASS="PARAMETER" ->af</VAR -> is not -supported.</P -></DIV -><DIV -CLASS="REFSECT1" -><A -NAME="AEN39" -></A -><H2 ->SEE ALSO</H2 -><P -><SPAN -CLASS="CITEREFENTRY" -><SPAN -CLASS="REFENTRYTITLE" ->RFC1884</SPAN -></SPAN ->, -<SPAN -CLASS="CITEREFENTRY" -><SPAN -CLASS="REFENTRYTITLE" ->inet_ntop</SPAN ->(3)</SPAN ->, -<SPAN -CLASS="CITEREFENTRY" -><SPAN -CLASS="REFENTRYTITLE" ->errno</SPAN ->(3)</SPAN ->.</P -></DIV -></BODY -></HTML -> +address. <code class="function">lwres_net_ntop()</code> returns +<span class="type">NULL</span> and sets the global variable +<code class="constant">errno</code> to <span class="errorcode">EAFNOSUPPORT</span> if +the protocol family given in <em class="parameter"><code>af</code></em> is not +supported. +</p> +</div> +<div class="refsect1" lang="en"> +<a name="id2525918"></a><h2>SEE ALSO</h2> +<p> +<span class="citerefentry"><span class="refentrytitle">RFC1884</span></span>, +<span class="citerefentry"><span class="refentrytitle">inet_ntop</span>(3)</span>, +<span class="citerefentry"><span class="refentrytitle">errno</span>(3)</span>. +</p> +</div> +</div></body> +</html> diff --git a/contrib/bind9/lib/lwres/man/lwres_noop.3 b/contrib/bind9/lib/lwres/man/lwres_noop.3 index 36bb904..d2eba57 100644 --- a/contrib/bind9/lib/lwres/man/lwres_noop.3 +++ b/contrib/bind9/lib/lwres/man/lwres_noop.3 @@ -1,142 +1,140 @@ -.\" Copyright (C) 2004 Internet Systems Consortium, Inc. ("ISC") -.\" Copyright (C) 2000, 2001 Internet Software Consortium. -.\" +.\" Copyright (C) 2004, 2005 Internet Systems Consortium, Inc. ("ISC") +.\" Copyright (C) 2000, 2001 Internet Software Consortium. +.\" .\" Permission to use, copy, modify, and distribute this software for any .\" purpose with or without fee is hereby granted, provided that the above .\" copyright notice and this permission notice appear in all copies. -.\" +.\" .\" THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH .\" REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY -.\" AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT, +.\" AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT, .\" INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM .\" LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE .\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR .\" PERFORMANCE OF THIS SOFTWARE. .\" -.\" $Id: lwres_noop.3,v 1.14.2.1.8.1 2004/03/06 07:41:44 marka Exp $ +.\" $Id: lwres_noop.3,v 1.14.2.1.8.5 2005/10/13 02:33:54 marka Exp $ .\" -.TH "LWRES_NOOP" "3" "Jun 30, 2000" "BIND9" "" -.SH NAME -lwres_nooprequest_render, lwres_noopresponse_render, lwres_nooprequest_parse, lwres_noopresponse_parse, lwres_noopresponse_free, lwres_nooprequest_free \- lightweight resolver no-op message handling -.SH SYNOPSIS -\fB#include <lwres/lwres.h> -.sp -.na -lwres_result_t -lwres_nooprequest_render(lwres_context_t *ctx, lwres_nooprequest_t *req, lwres_lwpacket_t *pkt, lwres_buffer_t *b); -.ad -.sp -.na -lwres_result_t -lwres_noopresponse_render(lwres_context_t *ctx, lwres_noopresponse_t *req, lwres_lwpacket_t *pkt, lwres_buffer_t *b); -.ad -.sp -.na -lwres_result_t -lwres_nooprequest_parse(lwres_context_t *ctx, lwres_buffer_t *b, lwres_lwpacket_t *pkt, lwres_nooprequest_t **structp); -.ad -.sp -.na -lwres_result_t -lwres_noopresponse_parse(lwres_context_t *ctx, lwres_buffer_t *b, lwres_lwpacket_t *pkt, lwres_noopresponse_t **structp); -.ad -.sp -.na -void -lwres_noopresponse_free(lwres_context_t *ctx, lwres_noopresponse_t **structp); -.ad -.sp -.na -void -lwres_nooprequest_free(lwres_context_t *ctx, lwres_nooprequest_t **structp); -.ad -\fR +.hy 0 +.ad l +.\" ** You probably do not want to edit this file directly ** +.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1). +.\" Instead of manually editing it, you probably should edit the DocBook XML +.\" source for it and then use the DocBook XSL Stylesheets to regenerate it. +.TH "LWRES_NOOP" "3" "Jun 30, 2000" "BIND9" "BIND9" +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.SH "NAME" +lwres_nooprequest_render, lwres_noopresponse_render, lwres_nooprequest_parse, lwres_noopresponse_parse, lwres_noopresponse_free, lwres_nooprequest_free \- lightweight resolver no\-op message handling +.SH "SYNOPSIS" +.nf +#include <lwres/lwres.h> +.fi +.HP 40 +\fBlwres_result_t\ \fBlwres_nooprequest_render\fR\fR\fB(\fR\fBlwres_context_t\ *ctx\fR\fB, \fR\fBlwres_nooprequest_t\ *req\fR\fB, \fR\fBlwres_lwpacket_t\ *pkt\fR\fB, \fR\fBlwres_buffer_t\ *b\fR\fB);\fR +.HP 41 +\fBlwres_result_t\ \fBlwres_noopresponse_render\fR\fR\fB(\fR\fBlwres_context_t\ *ctx\fR\fB, \fR\fBlwres_noopresponse_t\ *req\fR\fB, \fR\fBlwres_lwpacket_t\ *pkt\fR\fB, \fR\fBlwres_buffer_t\ *b\fR\fB);\fR +.HP 39 +\fBlwres_result_t\ \fBlwres_nooprequest_parse\fR\fR\fB(\fR\fBlwres_context_t\ *ctx\fR\fB, \fR\fBlwres_buffer_t\ *b\fR\fB, \fR\fBlwres_lwpacket_t\ *pkt\fR\fB, \fR\fBlwres_nooprequest_t\ **structp\fR\fB);\fR +.HP 40 +\fBlwres_result_t\ \fBlwres_noopresponse_parse\fR\fR\fB(\fR\fBlwres_context_t\ *ctx\fR\fB, \fR\fBlwres_buffer_t\ *b\fR\fB, \fR\fBlwres_lwpacket_t\ *pkt\fR\fB, \fR\fBlwres_noopresponse_t\ **structp\fR\fB);\fR +.HP 29 +\fBvoid\ \fBlwres_noopresponse_free\fR\fR\fB(\fR\fBlwres_context_t\ *ctx\fR\fB, \fR\fBlwres_noopresponse_t\ **structp\fR\fB);\fR +.HP 28 +\fBvoid\ \fBlwres_nooprequest_free\fR\fR\fB(\fR\fBlwres_context_t\ *ctx\fR\fB, \fR\fBlwres_nooprequest_t\ **structp\fR\fB);\fR .SH "DESCRIPTION" .PP -These are low-level routines for creating and parsing -lightweight resolver no-op request and response messages. +These are low\-level routines for creating and parsing lightweight resolver no\-op request and response messages. .PP -The no-op message is analogous to a \fBping\fR packet: -a packet is sent to the resolver daemon and is simply echoed back. -The opcode is intended to allow a client to determine if the server is -operational or not. +The no\-op message is analogous to a +\fBping\fR +packet: a packet is sent to the resolver daemon and is simply echoed back. The opcode is intended to allow a client to determine if the server is operational or not. .PP -There are four main functions for the no-op opcode. -One render function converts a no-op request structure \(em -\fBlwres_nooprequest_t\fR \(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 no-op request structure. -Another render function converts the no-op response structure \(em +There are four main functions for the no\-op opcode. One render function converts a no\-op request structure \(em +\fBlwres_nooprequest_t\fR +\(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 no\-op request structure. Another render function converts the no\-op response structure \(em \fBlwres_noopresponse_t\fR -to the canonical format. -This is complemented by a parse function which converts a packet in -canonical format to a no-op response structure. +to the canonical format. This is complemented by a parse function which converts a packet in canonical format to a no\-op response structure. .PP These structures are defined in -\fIlwres/lwres.h\fR. -They are shown below. +\fIlwres/lwres.h\fR. They are shown below. .sp .nf #define LWRES_OPCODE_NOOP 0x00000000U - typedef struct { lwres_uint16_t datalength; unsigned char *data; } lwres_nooprequest_t; - typedef struct { lwres_uint16_t datalength; unsigned char *data; } lwres_noopresponse_t; -.sp .fi -Although the structures have different types, they are identical. -This is because the no-op opcode simply echos whatever data was sent: -the response is therefore identical to the request. +.sp +Although the structures have different types, they are identical. This is because the no\-op opcode simply echos whatever data was sent: the response is therefore identical to the request. .PP -\fBlwres_nooprequest_render()\fR uses resolver -context \fIctx\fR to convert no-op request structure -\fIreq\fR to canonical format. The packet header -structure \fIpkt\fR is initialised and transferred to -buffer \fIb\fR. The contents of -\fI*req\fR are then appended to the buffer in -canonical format. \fBlwres_noopresponse_render()\fR -performs the same task, except it converts a no-op response structure -\fBlwres_noopresponse_t\fR to the lightweight resolver's -canonical format. +\fBlwres_nooprequest_render()\fR +uses resolver context +\fIctx\fR +to convert no\-op request structure +\fIreq\fR +to canonical format. The packet header structure +\fIpkt\fR +is initialised and transferred to buffer +\fIb\fR. The contents of +\fI*req\fR +are then appended to the buffer in canonical format. +\fBlwres_noopresponse_render()\fR +performs the same task, except it converts a no\-op response structure +\fBlwres_noopresponse_t\fR +to the lightweight resolver's canonical format. .PP -\fBlwres_nooprequest_parse()\fR uses context -\fIctx\fR to convert the contents of packet -\fIpkt\fR to a \fBlwres_nooprequest_t\fR -structure. Buffer \fIb\fR provides space to be used -for storing this structure. When the function succeeds, the resulting -\fBlwres_nooprequest_t\fR is made available through +\fBlwres_nooprequest_parse()\fR +uses context +\fIctx\fR +to convert the contents of packet +\fIpkt\fR +to a +\fBlwres_nooprequest_t\fR +structure. Buffer +\fIb\fR +provides space to be used for storing this structure. When the function succeeds, the resulting +\fBlwres_nooprequest_t\fR +is made available through \fI*structp\fR. -\fBlwres_noopresponse_parse()\fR offers the same -semantics as \fBlwres_nooprequest_parse()\fR except it -yields a \fBlwres_noopresponse_t\fR structure. +\fBlwres_noopresponse_parse()\fR +offers the same semantics as +\fBlwres_nooprequest_parse()\fR +except it yields a +\fBlwres_noopresponse_t\fR +structure. .PP -\fBlwres_noopresponse_free()\fR and -\fBlwres_nooprequest_free()\fR release the memory in -resolver context \fIctx\fR that was allocated to the -\fBlwres_noopresponse_t\fR or \fBlwres_nooprequest_t\fR -structures referenced via \fIstructp\fR. +\fBlwres_noopresponse_free()\fR +and +\fBlwres_nooprequest_free()\fR +release the memory in resolver context +\fIctx\fR +that was allocated to the +\fBlwres_noopresponse_t\fR +or +\fBlwres_nooprequest_t\fR +structures referenced via +\fIstructp\fR. .SH "RETURN VALUES" .PP -The no-op opcode functions +The no\-op opcode functions \fBlwres_nooprequest_render()\fR, -\fBlwres_noopresponse_render()\fR -\fBlwres_nooprequest_parse()\fR +\fBlwres_noopresponse_render()\fR\fBlwres_nooprequest_parse()\fR and \fBlwres_noopresponse_parse()\fR all return -LWRES_R_SUCCESS -on success. -They return -LWRES_R_NOMEMORY +\fBLWRES_R_SUCCESS\fR +on success. They return +\fBLWRES_R_NOMEMORY\fR if memory allocation fails. -LWRES_R_UNEXPECTEDEND +\fBLWRES_R_UNEXPECTEDEND\fR is returned if the available space in the buffer \fIb\fR is too small to accommodate the packet header or the @@ -148,15 +146,14 @@ structures. and \fBlwres_noopresponse_parse()\fR will return -LWRES_R_UNEXPECTEDEND -if the buffer is not empty after decoding the received packet. -These functions will return -LWRES_R_FAILURE +\fBLWRES_R_UNEXPECTEDEND\fR +if the buffer is not empty after decoding the received packet. These functions will return +\fBLWRES_R_FAILURE\fR if -pktflags +\fBpktflags\fR in the packet header structure \fBlwres_lwpacket_t\fR indicate that the packet is not a response to an earlier query. .SH "SEE ALSO" .PP -\fBlwres_packet\fR(3) +\fBlwres_packet\fR(3 ) diff --git a/contrib/bind9/lib/lwres/man/lwres_noop.docbook b/contrib/bind9/lib/lwres/man/lwres_noop.docbook index dde2795..fcb3c59 100644 --- a/contrib/bind9/lib/lwres/man/lwres_noop.docbook +++ b/contrib/bind9/lib/lwres/man/lwres_noop.docbook @@ -1,7 +1,9 @@ -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.0//EN" + "http://www.oasis-open.org/docbook/xml/4.0/docbookx.dtd" + [<!ENTITY mdash "—">]> <!-- - - Copyright (C) 2004 Internet Systems Consortium, Inc. ("ISC") - - Copyright (C) 2001 Internet Software Consortium. + - Copyright (C) 2004, 2005 Internet Systems Consortium, Inc. ("ISC") + - Copyright (C) 2000, 2001 Internet Software Consortium. - - Permission to use, copy, modify, and distribute this software for any - purpose with or without fee is hereby granted, provided that the above @@ -16,7 +18,7 @@ - PERFORMANCE OF THIS SOFTWARE. --> -<!-- $Id: lwres_noop.docbook,v 1.4.206.1 2004/03/06 08:15:41 marka Exp $ --> +<!-- $Id: lwres_noop.docbook,v 1.4.206.3 2005/05/12 21:36:16 sra Exp $ --> <refentry> @@ -30,6 +32,19 @@ <refmiscinfo>BIND9</refmiscinfo> </refmeta> + <docinfo> + <copyright> + <year>2004</year> + <year>2005</year> + <holder>Internet Systems Consortium, Inc. ("ISC")</holder> + </copyright> + <copyright> + <year>2000</year> + <year>2001</year> + <holder>Internet Software Consortium.</holder> + </copyright> + </docinfo> + <refnamediv> <refname>lwres_nooprequest_render</refname> <refname>lwres_noopresponse_render</refname> diff --git a/contrib/bind9/lib/lwres/man/lwres_noop.html b/contrib/bind9/lib/lwres/man/lwres_noop.html index 0962883..261bac8 100644 --- a/contrib/bind9/lib/lwres/man/lwres_noop.html +++ b/contrib/bind9/lib/lwres/man/lwres_noop.html @@ -1,166 +1,202 @@ <!-- - - Copyright (C) 2004 Internet Systems Consortium, Inc. ("ISC") - - Copyright (C) 2001 Internet Software Consortium. - - + - Copyright (C) 2004, 2005 Internet Systems Consortium, Inc. ("ISC") + - Copyright (C) 2000, 2001 Internet Software Consortium. + - - Permission to use, copy, modify, and distribute this software for any - purpose with or without fee is hereby granted, provided that the above - copyright notice and this permission notice appear in all copies. - - + - - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY - - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT, + - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT, - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> - -<!-- $Id: lwres_noop.html,v 1.7.2.1.4.2 2004/08/22 23:39:05 marka Exp $ --> - -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<HTML -><HEAD -><TITLE ->lwres_noop</TITLE -><META -NAME="GENERATOR" -CONTENT="Modular DocBook HTML Stylesheet Version 1.7"></HEAD -><BODY -CLASS="REFENTRY" -BGCOLOR="#FFFFFF" -TEXT="#000000" -LINK="#0000FF" -VLINK="#840084" -ALINK="#0000FF" -><H1 -><A -NAME="AEN1" -></A ->lwres_noop</H1 -><DIV -CLASS="REFNAMEDIV" -><A -NAME="AEN8" -></A -><H2 ->Name</H2 ->lwres_nooprequest_render, lwres_noopresponse_render, lwres_nooprequest_parse, lwres_noopresponse_parse, lwres_noopresponse_free, lwres_nooprequest_free -- lightweight resolver no-op message handling</DIV -><DIV -CLASS="REFSYNOPSISDIV" -><A -NAME="AEN16" -></A -><H2 ->Synopsis</H2 -><DIV -CLASS="FUNCSYNOPSIS" -><P -></P -><A -NAME="AEN17" -></A -><PRE -CLASS="FUNCSYNOPSISINFO" ->#include <lwres/lwres.h></PRE -><P -><CODE -><CODE -CLASS="FUNCDEF" ->lwres_result_t -lwres_nooprequest_render</CODE ->(lwres_context_t *ctx, lwres_nooprequest_t *req, lwres_lwpacket_t *pkt, lwres_buffer_t *b);</CODE -></P -><P -><CODE -><CODE -CLASS="FUNCDEF" ->lwres_result_t -lwres_noopresponse_render</CODE ->(lwres_context_t *ctx, lwres_noopresponse_t *req, lwres_lwpacket_t *pkt, lwres_buffer_t *b);</CODE -></P -><P -><CODE -><CODE -CLASS="FUNCDEF" ->lwres_result_t -lwres_nooprequest_parse</CODE ->(lwres_context_t *ctx, lwres_buffer_t *b, lwres_lwpacket_t *pkt, lwres_nooprequest_t **structp);</CODE -></P -><P -><CODE -><CODE -CLASS="FUNCDEF" ->lwres_result_t -lwres_noopresponse_parse</CODE ->(lwres_context_t *ctx, lwres_buffer_t *b, lwres_lwpacket_t *pkt, lwres_noopresponse_t **structp);</CODE -></P -><P -><CODE -><CODE -CLASS="FUNCDEF" ->void -lwres_noopresponse_free</CODE ->(lwres_context_t *ctx, lwres_noopresponse_t **structp);</CODE -></P -><P -><CODE -><CODE -CLASS="FUNCDEF" ->void -lwres_nooprequest_free</CODE ->(lwres_context_t *ctx, lwres_nooprequest_t **structp);</CODE -></P -><P -></P -></DIV -></DIV -><DIV -CLASS="REFSECT1" -><A -NAME="AEN57" -></A -><H2 ->DESCRIPTION</H2 -><P ->These are low-level routines for creating and parsing -lightweight resolver no-op request and response messages.</P -><P ->The no-op message is analogous to a <B -CLASS="COMMAND" ->ping</B -> packet: +<!-- $Id: lwres_noop.html,v 1.7.2.1.4.9 2005/10/13 02:33:57 marka Exp $ --> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> +<title>lwres_noop</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.69.1"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"> +<a name="id2463721"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2>Name</h2> +<p>lwres_nooprequest_render, lwres_noopresponse_render, lwres_nooprequest_parse, lwres_noopresponse_parse, lwres_noopresponse_free, lwres_nooprequest_free — lightweight resolver no-op message handling</p> +</div> +<div class="refsynopsisdiv"> +<h2>Synopsis</h2> +<div class="funcsynopsis"> +<pre class="funcsynopsisinfo"> +#include <lwres/lwres.h></pre> +<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em"> +<tr> +<td><code class="funcdef"> +lwres_result_t +<b class="fsfunc">lwres_nooprequest_render</b>(</code></td> +<td> </td> +<td>, </td> +</tr> +<tr> +<td> </td> +<td> </td> +<td>, </td> +</tr> +<tr> +<td> </td> +<td> </td> +<td>, </td> +</tr> +<tr> +<td> </td> +<td> </td> +<td> +<code>)</code>;</td> +</tr> +</table> +<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em"> +<tr> +<td><code class="funcdef"> +lwres_result_t +<b class="fsfunc">lwres_noopresponse_render</b>(</code></td> +<td> </td> +<td>, </td> +</tr> +<tr> +<td> </td> +<td> </td> +<td>, </td> +</tr> +<tr> +<td> </td> +<td> </td> +<td>, </td> +</tr> +<tr> +<td> </td> +<td> </td> +<td> +<code>)</code>;</td> +</tr> +</table> +<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em"> +<tr> +<td><code class="funcdef"> +lwres_result_t +<b class="fsfunc">lwres_nooprequest_parse</b>(</code></td> +<td> </td> +<td>, </td> +</tr> +<tr> +<td> </td> +<td> </td> +<td>, </td> +</tr> +<tr> +<td> </td> +<td> </td> +<td>, </td> +</tr> +<tr> +<td> </td> +<td> </td> +<td> +<code>)</code>;</td> +</tr> +</table> +<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em"> +<tr> +<td><code class="funcdef"> +lwres_result_t +<b class="fsfunc">lwres_noopresponse_parse</b>(</code></td> +<td> </td> +<td>, </td> +</tr> +<tr> +<td> </td> +<td> </td> +<td>, </td> +</tr> +<tr> +<td> </td> +<td> </td> +<td>, </td> +</tr> +<tr> +<td> </td> +<td> </td> +<td> +<code>)</code>;</td> +</tr> +</table> +<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em"> +<tr> +<td><code class="funcdef"> +void +<b class="fsfunc">lwres_noopresponse_free</b>(</code></td> +<td> </td> +<td>, </td> +</tr> +<tr> +<td> </td> +<td> </td> +<td> +<code>)</code>;</td> +</tr> +</table> +<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0"> +<tr> +<td><code class="funcdef"> +void +<b class="fsfunc">lwres_nooprequest_free</b>(</code></td> +<td> </td> +<td>, </td> +</tr> +<tr> +<td> </td> +<td> </td> +<td> +<code>)</code>;</td> +</tr> +</table> +</div> +</div> +<div class="refsect1" lang="en"> +<a name="id2525963"></a><h2>DESCRIPTION</h2> +<p> +These are low-level routines for creating and parsing +lightweight resolver no-op request and response messages. +</p> +<p> +The no-op message is analogous to a <span><strong class="command">ping</strong></span> packet: a packet is sent to the resolver daemon and is simply echoed back. The opcode is intended to allow a client to determine if the server is -operational or not.</P -><P ->There are four main functions for the no-op opcode. -One render function converts a no-op request structure — -<SPAN -CLASS="TYPE" ->lwres_nooprequest_t</SPAN -> — +operational or not. +</p> +<p> +There are four main functions for the no-op opcode. +One render function converts a no-op request structure — +<span class="type">lwres_nooprequest_t</span> — to the lighweight resolver's canonical format. It is complemented by a parse function that converts a packet in this canonical format to a no-op request structure. -Another render function converts the no-op response structure — -<SPAN -CLASS="TYPE" ->lwres_noopresponse_t</SPAN -> +Another render function converts the no-op response structure — +<span class="type">lwres_noopresponse_t</span> to the canonical format. This is complemented by a parse function which converts a packet in -canonical format to a no-op response structure.</P -><P ->These structures are defined in -<TT -CLASS="FILENAME" ->lwres/lwres.h</TT ->. +canonical format to a no-op response structure. +</p> +<p> +These structures are defined in +<code class="filename">lwres/lwres.h</code>. They are shown below. -<PRE -CLASS="PROGRAMLISTING" ->#define LWRES_OPCODE_NOOP 0x00000000U +</p> +<pre class="programlisting"> +#define LWRES_OPCODE_NOOP 0x00000000U typedef struct { lwres_uint16_t datalength; @@ -170,219 +206,90 @@ typedef struct { typedef struct { lwres_uint16_t datalength; unsigned char *data; -} lwres_noopresponse_t;</PRE -> +} lwres_noopresponse_t; +</pre> +<p> Although the structures have different types, they are identical. This is because the no-op opcode simply echos whatever data was sent: -the response is therefore identical to the request.</P -><P -><CODE -CLASS="FUNCTION" ->lwres_nooprequest_render()</CODE -> uses resolver -context <VAR -CLASS="PARAMETER" ->ctx</VAR -> to convert no-op request structure -<VAR -CLASS="PARAMETER" ->req</VAR -> to canonical format. The packet header -structure <VAR -CLASS="PARAMETER" ->pkt</VAR -> is initialised and transferred to -buffer <VAR -CLASS="PARAMETER" ->b</VAR ->. The contents of -<VAR -CLASS="PARAMETER" ->*req</VAR -> are then appended to the buffer in -canonical format. <CODE -CLASS="FUNCTION" ->lwres_noopresponse_render()</CODE -> +the response is therefore identical to the request. +</p> +<p> +<code class="function">lwres_nooprequest_render()</code> uses resolver +context <em class="parameter"><code>ctx</code></em> to convert no-op request structure +<em class="parameter"><code>req</code></em> to canonical format. The packet header +structure <em class="parameter"><code>pkt</code></em> is initialised and transferred to +buffer <em class="parameter"><code>b</code></em>. The contents of +<em class="parameter"><code>*req</code></em> are then appended to the buffer in +canonical format. <code class="function">lwres_noopresponse_render()</code> performs the same task, except it converts a no-op response structure -<SPAN -CLASS="TYPE" ->lwres_noopresponse_t</SPAN -> to the lightweight resolver's -canonical format.</P -><P -><CODE -CLASS="FUNCTION" ->lwres_nooprequest_parse()</CODE -> uses context -<VAR -CLASS="PARAMETER" ->ctx</VAR -> to convert the contents of packet -<VAR -CLASS="PARAMETER" ->pkt</VAR -> to a <SPAN -CLASS="TYPE" ->lwres_nooprequest_t</SPAN -> -structure. Buffer <VAR -CLASS="PARAMETER" ->b</VAR -> provides space to be used +<span class="type">lwres_noopresponse_t</span> to the lightweight resolver's +canonical format. +</p> +<p> +<code class="function">lwres_nooprequest_parse()</code> uses context +<em class="parameter"><code>ctx</code></em> to convert the contents of packet +<em class="parameter"><code>pkt</code></em> to a <span class="type">lwres_nooprequest_t</span> +structure. Buffer <em class="parameter"><code>b</code></em> provides space to be used for storing this structure. When the function succeeds, the resulting -<SPAN -CLASS="TYPE" ->lwres_nooprequest_t</SPAN -> is made available through -<VAR -CLASS="PARAMETER" ->*structp</VAR ->. -<CODE -CLASS="FUNCTION" ->lwres_noopresponse_parse()</CODE -> offers the same -semantics as <CODE -CLASS="FUNCTION" ->lwres_nooprequest_parse()</CODE -> except it -yields a <SPAN -CLASS="TYPE" ->lwres_noopresponse_t</SPAN -> structure.</P -><P -><CODE -CLASS="FUNCTION" ->lwres_noopresponse_free()</CODE -> and -<CODE -CLASS="FUNCTION" ->lwres_nooprequest_free()</CODE -> release the memory in -resolver context <VAR -CLASS="PARAMETER" ->ctx</VAR -> that was allocated to the -<SPAN -CLASS="TYPE" ->lwres_noopresponse_t</SPAN -> or <SPAN -CLASS="TYPE" ->lwres_nooprequest_t</SPAN -> -structures referenced via <VAR -CLASS="PARAMETER" ->structp</VAR ->.</P -></DIV -><DIV -CLASS="REFSECT1" -><A -NAME="AEN95" -></A -><H2 ->RETURN VALUES</H2 -><P ->The no-op opcode functions -<CODE -CLASS="FUNCTION" ->lwres_nooprequest_render()</CODE ->, +<span class="type">lwres_nooprequest_t</span> is made available through +<em class="parameter"><code>*structp</code></em>. +<code class="function">lwres_noopresponse_parse()</code> offers the same +semantics as <code class="function">lwres_nooprequest_parse()</code> except it +yields a <span class="type">lwres_noopresponse_t</span> structure. +</p> +<p> +<code class="function">lwres_noopresponse_free()</code> and +<code class="function">lwres_nooprequest_free()</code> release the memory in +resolver context <em class="parameter"><code>ctx</code></em> that was allocated to the +<span class="type">lwres_noopresponse_t</span> or <span class="type">lwres_nooprequest_t</span> +structures referenced via <em class="parameter"><code>structp</code></em>. +</p> +</div> +<div class="refsect1" lang="en"> +<a name="id2526096"></a><h2>RETURN VALUES</h2> +<p> +The no-op opcode functions +<code class="function">lwres_nooprequest_render()</code>, -<CODE -CLASS="FUNCTION" ->lwres_noopresponse_render()</CODE -> -<CODE -CLASS="FUNCTION" ->lwres_nooprequest_parse()</CODE -> +<code class="function">lwres_noopresponse_render()</code> +<code class="function">lwres_nooprequest_parse()</code> and -<CODE -CLASS="FUNCTION" ->lwres_noopresponse_parse()</CODE -> +<code class="function">lwres_noopresponse_parse()</code> all return -<SPAN -CLASS="ERRORCODE" ->LWRES_R_SUCCESS</SPAN -> +<span class="errorcode">LWRES_R_SUCCESS</span> on success. They return -<SPAN -CLASS="ERRORCODE" ->LWRES_R_NOMEMORY</SPAN -> +<span class="errorcode">LWRES_R_NOMEMORY</span> if memory allocation fails. -<SPAN -CLASS="ERRORCODE" ->LWRES_R_UNEXPECTEDEND</SPAN -> +<span class="errorcode">LWRES_R_UNEXPECTEDEND</span> is returned if the available space in the buffer -<VAR -CLASS="PARAMETER" ->b</VAR -> +<em class="parameter"><code>b</code></em> is too small to accommodate the packet header or the -<SPAN -CLASS="TYPE" ->lwres_nooprequest_t</SPAN -> +<span class="type">lwres_nooprequest_t</span> and -<SPAN -CLASS="TYPE" ->lwres_noopresponse_t</SPAN -> +<span class="type">lwres_noopresponse_t</span> structures. -<CODE -CLASS="FUNCTION" ->lwres_nooprequest_parse()</CODE -> +<code class="function">lwres_nooprequest_parse()</code> and -<CODE -CLASS="FUNCTION" ->lwres_noopresponse_parse()</CODE -> +<code class="function">lwres_noopresponse_parse()</code> will return -<SPAN -CLASS="ERRORCODE" ->LWRES_R_UNEXPECTEDEND</SPAN -> +<span class="errorcode">LWRES_R_UNEXPECTEDEND</span> if the buffer is not empty after decoding the received packet. These functions will return -<SPAN -CLASS="ERRORCODE" ->LWRES_R_FAILURE</SPAN -> +<span class="errorcode">LWRES_R_FAILURE</span> if -<CODE -CLASS="CONSTANT" ->pktflags</CODE -> +<code class="constant">pktflags</code> in the packet header structure -<SPAN -CLASS="TYPE" ->lwres_lwpacket_t</SPAN -> -indicate that the packet is not a response to an earlier query.</P -></DIV -><DIV -CLASS="REFSECT1" -><A -NAME="AEN114" -></A -><H2 ->SEE ALSO</H2 -><P -><SPAN -CLASS="CITEREFENTRY" -><SPAN -CLASS="REFENTRYTITLE" ->lwres_packet</SPAN ->(3)</SPAN -></P -></DIV -></BODY -></HTML -> +<span class="type">lwres_lwpacket_t</span> +indicate that the packet is not a response to an earlier query. +</p> +</div> +<div class="refsect1" lang="en"> +<a name="id2526160"></a><h2>SEE ALSO</h2> +<p> +<span class="citerefentry"><span class="refentrytitle">lwres_packet</span>(3 +)</span> +</p> +</div> +</div></body> +</html> diff --git a/contrib/bind9/lib/lwres/man/lwres_packet.3 b/contrib/bind9/lib/lwres/man/lwres_packet.3 index 1fbc417..777e0c7 100644 --- a/contrib/bind9/lib/lwres/man/lwres_packet.3 +++ b/contrib/bind9/lib/lwres/man/lwres_packet.3 @@ -1,36 +1,41 @@ -.\" Copyright (C) 2004 Internet Systems Consortium, Inc. ("ISC") -.\" Copyright (C) 2000, 2001 Internet Software Consortium. -.\" +.\" Copyright (C) 2004, 2005 Internet Systems Consortium, Inc. ("ISC") +.\" Copyright (C) 2000, 2001 Internet Software Consortium. +.\" .\" Permission to use, copy, modify, and distribute this software for any .\" purpose with or without fee is hereby granted, provided that the above .\" copyright notice and this permission notice appear in all copies. -.\" +.\" .\" THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH .\" REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY -.\" AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT, +.\" AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT, .\" INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM .\" LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE .\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR .\" PERFORMANCE OF THIS SOFTWARE. .\" -.\" $Id: lwres_packet.3,v 1.15.2.1.8.1 2004/03/06 07:41:44 marka Exp $ +.\" $Id: lwres_packet.3,v 1.15.2.1.8.5 2005/10/13 02:33:54 marka Exp $ .\" -.TH "LWRES_PACKET" "3" "Jun 30, 2000" "BIND9" "" -.SH NAME +.hy 0 +.ad l +.\" ** You probably do not want to edit this file directly ** +.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1). +.\" Instead of manually editing it, you probably should edit the DocBook XML +.\" source for it and then use the DocBook XSL Stylesheets to regenerate it. +.TH "LWRES_PACKET" "3" "Jun 30, 2000" "BIND9" "BIND9" +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.SH "NAME" lwres_lwpacket_renderheader, lwres_lwpacket_parseheader \- lightweight resolver packet handling functions -.SH SYNOPSIS -\fB#include <lwres/lwpacket.h> -.sp -.na -lwres_result_t -lwres_lwpacket_renderheader(lwres_buffer_t *b, lwres_lwpacket_t *pkt); -.ad -.sp -.na -lwres_result_t -lwres_lwpacket_parseheader(lwres_buffer_t *b, lwres_lwpacket_t *pkt); -.ad -\fR +.SH "SYNOPSIS" +.nf +#include <lwres/lwpacket.h> +.fi +.HP 43 +\fBlwres_result_t\ \fBlwres_lwpacket_renderheader\fR\fR\fB(\fR\fBlwres_buffer_t\ *b\fR\fB, \fR\fBlwres_lwpacket_t\ *pkt\fR\fB);\fR +.HP 42 +\fBlwres_result_t\ \fBlwres_lwpacket_parseheader\fR\fR\fB(\fR\fBlwres_buffer_t\ *b\fR\fB, \fR\fBlwres_lwpacket_t\ *pkt\fR\fB);\fR .SH "DESCRIPTION" .PP These functions rely on a @@ -40,7 +45,6 @@ which is defined in .sp .nf typedef struct lwres_lwpacket lwres_lwpacket_t; - struct lwres_lwpacket { lwres_uint32_t length; lwres_uint16_t version; @@ -52,100 +56,74 @@ struct lwres_lwpacket { lwres_uint16_t authtype; lwres_uint16_t authlength; }; -.sp .fi +.sp .PP The elements of this structure are: .TP \fBlength\fR -the overall packet length, including the entire packet header. -This field is filled in by the lwres_gabn_*() and lwres_gnba_*() -calls. +the overall packet length, including the entire packet header. This field is filled in by the lwres_gabn_*() and lwres_gnba_*() calls. .TP \fBversion\fR the header format. There is currently only one format, -\fBLWRES_LWPACKETVERSION_0\fR. -This field is filled in by the lwres_gabn_*() and lwres_gnba_*() -calls. +\fBLWRES_LWPACKETVERSION_0\fR. This field is filled in by the lwres_gabn_*() and lwres_gnba_*() calls. .TP \fBpktflags\fR -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. +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. .TP \fBserial\fR -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. +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. .TP \fBopcode\fR -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. +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. .TP \fBresult\fR -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. +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. .TP \fBrecvlength\fR -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. +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. .TP \fBauthtype\fR -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. +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. .TP \fBauthlen\fR -gives the length of the authentication data. -Since packet authentication is currently not used, this must be zero. +gives the length of the authentication data. Since packet authentication is currently not used, this must be zero. .PP The following opcodes are currently defined: .TP \fBNOOP\fR -Success is always returned and the packet contents are echoed. -The lwres_noop_*() functions should be used for this type. +Success is always returned and the packet contents are echoed. The lwres_noop_*() functions should be used for this type. .TP \fBGETADDRSBYNAME\fR -returns all known addresses for a given name. -The lwres_gabn_*() functions should be used for this type. +returns all known addresses for a given name. The lwres_gabn_*() functions should be used for this type. .TP \fBGETNAMEBYADDR\fR -return the hostname for the given address. -The lwres_gnba_*() functions should be used for this type. +return the hostname for the given address. The lwres_gnba_*() functions should be used for this type. .PP -\fBlwres_lwpacket_renderheader()\fR transfers the -contents of lightweight resolver packet structure -\fBlwres_lwpacket_t\fR \fI*pkt\fR in network -byte order to the lightweight resolver buffer, +\fBlwres_lwpacket_renderheader()\fR +transfers the contents of lightweight resolver packet structure +\fBlwres_lwpacket_t\fR\fI*pkt\fR +in network byte order to the lightweight resolver buffer, \fI*b\fR. .PP -\fBlwres_lwpacket_parseheader()\fR performs the -converse operation. It transfers data in network byte order from -buffer \fI*b\fR to resolver packet +\fBlwres_lwpacket_parseheader()\fR +performs the converse operation. It transfers data in network byte order from buffer +\fI*b\fR +to resolver packet \fI*pkt\fR. The contents of the buffer -\fIb\fR should correspond to a +\fIb\fR +should correspond to a \fBlwres_lwpacket_t\fR. .SH "RETURN VALUES" .PP Successful calls to -\fBlwres_lwpacket_renderheader()\fR and -\fBlwres_lwpacket_parseheader()\fR return -LWRES_R_SUCCESS. If there is insufficient -space to copy data between the buffer \fI*b\fR and -lightweight resolver packet \fI*pkt\fR both functions -return LWRES_R_UNEXPECTEDEND. +\fBlwres_lwpacket_renderheader()\fR +and +\fBlwres_lwpacket_parseheader()\fR +return +\fBLWRES_R_SUCCESS\fR. If there is insufficient space to copy data between the buffer +\fI*b\fR +and lightweight resolver packet +\fI*pkt\fR +both functions return +\fBLWRES_R_UNEXPECTEDEND\fR. diff --git a/contrib/bind9/lib/lwres/man/lwres_packet.docbook b/contrib/bind9/lib/lwres/man/lwres_packet.docbook index 7795ebc..226f994 100644 --- a/contrib/bind9/lib/lwres/man/lwres_packet.docbook +++ b/contrib/bind9/lib/lwres/man/lwres_packet.docbook @@ -1,7 +1,9 @@ -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.0//EN" + "http://www.oasis-open.org/docbook/xml/4.0/docbookx.dtd" + [<!ENTITY mdash "—">]> <!-- - - Copyright (C) 2004 Internet Systems Consortium, Inc. ("ISC") - - Copyright (C) 2001 Internet Software Consortium. + - Copyright (C) 2004, 2005 Internet Systems Consortium, Inc. ("ISC") + - Copyright (C) 2000, 2001 Internet Software Consortium. - - Permission to use, copy, modify, and distribute this software for any - purpose with or without fee is hereby granted, provided that the above @@ -16,7 +18,7 @@ - PERFORMANCE OF THIS SOFTWARE. --> -<!-- $Id: lwres_packet.docbook,v 1.6.206.1 2004/03/06 08:15:42 marka Exp $ --> +<!-- $Id: lwres_packet.docbook,v 1.6.206.3 2005/05/12 21:36:16 sra Exp $ --> <refentry> @@ -30,6 +32,19 @@ <refmiscinfo>BIND9</refmiscinfo> </refmeta> + <docinfo> + <copyright> + <year>2004</year> + <year>2005</year> + <holder>Internet Systems Consortium, Inc. ("ISC")</holder> + </copyright> + <copyright> + <year>2000</year> + <year>2001</year> + <holder>Internet Software Consortium.</holder> + </copyright> + </docinfo> + <refnamediv> <refname>lwres_lwpacket_renderheader</refname> <refname>lwres_lwpacket_parseheader</refname> diff --git a/contrib/bind9/lib/lwres/man/lwres_packet.html b/contrib/bind9/lib/lwres/man/lwres_packet.html index cb61e0a..b83fbcb 100644 --- a/contrib/bind9/lib/lwres/man/lwres_packet.html +++ b/contrib/bind9/lib/lwres/man/lwres_packet.html @@ -1,109 +1,79 @@ <!-- - - Copyright (C) 2004 Internet Systems Consortium, Inc. ("ISC") - - Copyright (C) 2001 Internet Software Consortium. - - + - Copyright (C) 2004, 2005 Internet Systems Consortium, Inc. ("ISC") + - Copyright (C) 2000, 2001 Internet Software Consortium. + - - Permission to use, copy, modify, and distribute this software for any - purpose with or without fee is hereby granted, provided that the above - copyright notice and this permission notice appear in all copies. - - + - - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY - - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT, + - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT, - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> - -<!-- $Id: lwres_packet.html,v 1.8.2.1.4.2 2004/08/22 23:39:05 marka Exp $ --> - -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<HTML -><HEAD -><TITLE ->lwres_packet</TITLE -><META -NAME="GENERATOR" -CONTENT="Modular DocBook HTML Stylesheet Version 1.7"></HEAD -><BODY -CLASS="REFENTRY" -BGCOLOR="#FFFFFF" -TEXT="#000000" -LINK="#0000FF" -VLINK="#840084" -ALINK="#0000FF" -><H1 -><A -NAME="AEN1" -></A ->lwres_packet</H1 -><DIV -CLASS="REFNAMEDIV" -><A -NAME="AEN8" -></A -><H2 ->Name</H2 ->lwres_lwpacket_renderheader, lwres_lwpacket_parseheader -- lightweight resolver packet handling functions</DIV -><DIV -CLASS="REFSYNOPSISDIV" -><A -NAME="AEN12" -></A -><H2 ->Synopsis</H2 -><DIV -CLASS="FUNCSYNOPSIS" -><P -></P -><A -NAME="AEN13" -></A -><PRE -CLASS="FUNCSYNOPSISINFO" ->#include <lwres/lwpacket.h></PRE -><P -><CODE -><CODE -CLASS="FUNCDEF" ->lwres_result_t -lwres_lwpacket_renderheader</CODE ->(lwres_buffer_t *b, lwres_lwpacket_t *pkt);</CODE -></P -><P -><CODE -><CODE -CLASS="FUNCDEF" ->lwres_result_t -lwres_lwpacket_parseheader</CODE ->(lwres_buffer_t *b, lwres_lwpacket_t *pkt);</CODE -></P -><P -></P -></DIV -></DIV -><DIV -CLASS="REFSECT1" -><A -NAME="AEN25" -></A -><H2 ->DESCRIPTION</H2 -><P ->These functions rely on a -<SPAN -CLASS="TYPE" ->struct lwres_lwpacket</SPAN -> +<!-- $Id: lwres_packet.html,v 1.8.2.1.4.9 2005/10/13 02:33:57 marka Exp $ --> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> +<title>lwres_packet</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.69.1"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"> +<a name="id2463721"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2>Name</h2> +<p>lwres_lwpacket_renderheader, lwres_lwpacket_parseheader — lightweight resolver packet handling functions</p> +</div> +<div class="refsynopsisdiv"> +<h2>Synopsis</h2> +<div class="funcsynopsis"> +<pre class="funcsynopsisinfo">#include <lwres/lwpacket.h></pre> +<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em"> +<tr> +<td><code class="funcdef"> +lwres_result_t +<b class="fsfunc">lwres_lwpacket_renderheader</b>(</code></td> +<td> </td> +<td>, </td> +</tr> +<tr> +<td> </td> +<td> </td> +<td> +<code>)</code>;</td> +</tr> +</table> +<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0"> +<tr> +<td><code class="funcdef"> +lwres_result_t +<b class="fsfunc">lwres_lwpacket_parseheader</b>(</code></td> +<td> </td> +<td>, </td> +</tr> +<tr> +<td> </td> +<td> </td> +<td> +<code>)</code>;</td> +</tr> +</table> +</div> +</div> +<div class="refsect1" lang="en"> +<a name="id2525865"></a><h2>DESCRIPTION</h2> +<p> +These functions rely on a +<span class="type">struct lwres_lwpacket</span> which is defined in -<TT -CLASS="FILENAME" ->lwres/lwpacket.h</TT ->. +<code class="filename">lwres/lwpacket.h</code>. -<PRE -CLASS="PROGRAMLISTING" ->typedef struct lwres_lwpacket lwres_lwpacket_t; +</p> +<pre class="programlisting"> +typedef struct lwres_lwpacket lwres_lwpacket_t; struct lwres_lwpacket { lwres_uint32_t length; @@ -115,248 +85,132 @@ struct lwres_lwpacket { lwres_uint32_t recvlength; lwres_uint16_t authtype; lwres_uint16_t authlength; -};</PRE -></P -><P ->The elements of this structure are: -<P -></P -><DIV -CLASS="VARIABLELIST" -><DL -><DT -><CODE -CLASS="CONSTANT" ->length</CODE -></DT -><DD -><P ->the overall packet length, including the entire packet header. +}; +</pre> +<p> +</p> +<p> +The elements of this structure are: +</p> +<div class="variablelist"><dl> +<dt><span class="term"><code class="constant">length</code></span></dt> +<dd><p> +the overall packet length, including the entire packet header. This field is filled in by the lwres_gabn_*() and lwres_gnba_*() -calls.</P -></DD -><DT -><CODE -CLASS="CONSTANT" ->version</CODE -></DT -><DD -><P ->the header format. There is currently only one format, -<SPAN -CLASS="TYPE" ->LWRES_LWPACKETVERSION_0</SPAN ->. +calls. +</p></dd> +<dt><span class="term"><code class="constant">version</code></span></dt> +<dd><p> +the header format. There is currently only one format, +<span class="type">LWRES_LWPACKETVERSION_0</span>. This field is filled in by the lwres_gabn_*() and lwres_gnba_*() -calls.</P -></DD -><DT -><CODE -CLASS="CONSTANT" ->pktflags</CODE -></DT -><DD -><P ->library-defined flags for this packet: for instance whether the packet +calls. +</p></dd> +<dt><span class="term"><code class="constant">pktflags</code></span></dt> +<dd><p> +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.</P -></DD -><DT -><CODE -CLASS="CONSTANT" ->serial</CODE -></DT -><DD -><P ->is set by the requestor and is returned in all replies. If two or more +lwres_gabn_*() and lwres_gnba_*() calls. +</p></dd> +<dt><span class="term"><code class="constant">serial</code></span></dt> +<dd><p> +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.</P -></DD -><DT -><CODE -CLASS="CONSTANT" ->opcode</CODE -></DT -><DD -><P ->indicates the operation. +This field must be set by the application. +</p></dd> +<dt><span class="term"><code class="constant">opcode</code></span></dt> +<dd><p> +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.</P -></DD -><DT -><CODE -CLASS="CONSTANT" ->result</CODE -></DT -><DD -><P ->is only valid for replies. +calls. +</p></dd> +<dt><span class="term"><code class="constant">result</code></span></dt> +<dd><p> +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.</P -></DD -><DT -><CODE -CLASS="CONSTANT" ->recvlength</CODE -></DT -><DD -><P ->is the maximum buffer size that the receiver can handle on requests +calls. +</p></dd> +<dt><span class="term"><code class="constant">recvlength</code></span></dt> +<dd><p> +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.</P -></DD -><DT -><CODE -CLASS="CONSTANT" ->authtype</CODE -></DT -><DD -><P ->defines the packet level authentication that is used. +This field is supplied by the application. +</p></dd> +<dt><span class="term"><code class="constant">authtype</code></span></dt> +<dd><p> +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.</P -></DD -><DT -><CODE -CLASS="CONSTANT" ->authlen</CODE -></DT -><DD -><P ->gives the length of the authentication data. -Since packet authentication is currently not used, this must be zero.</P -></DD -></DL -></DIV -></P -><P ->The following opcodes are currently defined: -<P -></P -><DIV -CLASS="VARIABLELIST" -><DL -><DT -><CODE -CLASS="CONSTANT" ->NOOP</CODE -></DT -><DD -><P ->Success is always returned and the packet contents are echoed. -The lwres_noop_*() functions should be used for this type.</P -></DD -><DT -><CODE -CLASS="CONSTANT" ->GETADDRSBYNAME</CODE -></DT -><DD -><P ->returns all known addresses for a given name. -The lwres_gabn_*() functions should be used for this type.</P -></DD -><DT -><CODE -CLASS="CONSTANT" ->GETNAMEBYADDR</CODE -></DT -><DD -><P ->return the hostname for the given address. -The lwres_gnba_*() functions should be used for this type.</P -></DD -></DL -></DIV -></P -><P -><CODE -CLASS="FUNCTION" ->lwres_lwpacket_renderheader()</CODE -> transfers the +Currently these are not used and must be zero. +</p></dd> +<dt><span class="term"><code class="constant">authlen</code></span></dt> +<dd><p> +gives the length of the authentication data. +Since packet authentication is currently not used, this must be zero. +</p></dd> +</dl></div> +<p> +</p> +<p> +The following opcodes are currently defined: +</p> +<div class="variablelist"><dl> +<dt><span class="term"><code class="constant">NOOP</code></span></dt> +<dd><p> +Success is always returned and the packet contents are echoed. +The lwres_noop_*() functions should be used for this type. +</p></dd> +<dt><span class="term"><code class="constant">GETADDRSBYNAME</code></span></dt> +<dd><p> +returns all known addresses for a given name. +The lwres_gabn_*() functions should be used for this type. +</p></dd> +<dt><span class="term"><code class="constant">GETNAMEBYADDR</code></span></dt> +<dd><p> +return the hostname for the given address. +The lwres_gnba_*() functions should be used for this type. +</p></dd> +</dl></div> +<p> +</p> +<p> +<code class="function">lwres_lwpacket_renderheader()</code> transfers the contents of lightweight resolver packet structure -<SPAN -CLASS="TYPE" ->lwres_lwpacket_t</SPAN -> <VAR -CLASS="PARAMETER" ->*pkt</VAR -> in network +<span class="type">lwres_lwpacket_t</span> <em class="parameter"><code>*pkt</code></em> in network byte order to the lightweight resolver buffer, -<VAR -CLASS="PARAMETER" ->*b</VAR ->.</P -><P -><CODE -CLASS="FUNCTION" ->lwres_lwpacket_parseheader()</CODE -> performs the +<em class="parameter"><code>*b</code></em>. +</p> +<p> +<code class="function">lwres_lwpacket_parseheader()</code> performs the converse operation. It transfers data in network byte order from -buffer <VAR -CLASS="PARAMETER" ->*b</VAR -> to resolver packet -<VAR -CLASS="PARAMETER" ->*pkt</VAR ->. The contents of the buffer -<VAR -CLASS="PARAMETER" ->b</VAR -> should correspond to a -<SPAN -CLASS="TYPE" ->lwres_lwpacket_t</SPAN ->.</P -></DIV -><DIV -CLASS="REFSECT1" -><A -NAME="AEN107" -></A -><H2 ->RETURN VALUES</H2 -><P -> Successful calls to -<CODE -CLASS="FUNCTION" ->lwres_lwpacket_renderheader()</CODE -> and -<CODE -CLASS="FUNCTION" ->lwres_lwpacket_parseheader()</CODE -> return -<SPAN -CLASS="ERRORCODE" ->LWRES_R_SUCCESS</SPAN ->. If there is insufficient -space to copy data between the buffer <VAR -CLASS="PARAMETER" ->*b</VAR -> and -lightweight resolver packet <VAR -CLASS="PARAMETER" ->*pkt</VAR -> both functions -return <SPAN -CLASS="ERRORCODE" ->LWRES_R_UNEXPECTEDEND</SPAN ->.</P -></DIV -></BODY -></HTML -> +buffer <em class="parameter"><code>*b</code></em> to resolver packet +<em class="parameter"><code>*pkt</code></em>. The contents of the buffer +<em class="parameter"><code>b</code></em> should correspond to a +<span class="type">lwres_lwpacket_t</span>. +</p> +</div> +<div class="refsect1" lang="en"> +<a name="id2526068"></a><h2>RETURN VALUES</h2> +<p> Successful calls to +<code class="function">lwres_lwpacket_renderheader()</code> and +<code class="function">lwres_lwpacket_parseheader()</code> return +<span class="errorcode">LWRES_R_SUCCESS</span>. If there is insufficient +space to copy data between the buffer <em class="parameter"><code>*b</code></em> and +lightweight resolver packet <em class="parameter"><code>*pkt</code></em> both functions +return <span class="errorcode">LWRES_R_UNEXPECTEDEND</span>. +</p> +</div> +</div></body> +</html> diff --git a/contrib/bind9/lib/lwres/man/lwres_resutil.3 b/contrib/bind9/lib/lwres/man/lwres_resutil.3 index d73122d..5d4cfc0 100644 --- a/contrib/bind9/lib/lwres/man/lwres_resutil.3 +++ b/contrib/bind9/lib/lwres/man/lwres_resutil.3 @@ -1,68 +1,68 @@ -.\" Copyright (C) 2004 Internet Systems Consortium, Inc. ("ISC") -.\" Copyright (C) 2000, 2001 Internet Software Consortium. -.\" +.\" Copyright (C) 2004, 2005 Internet Systems Consortium, Inc. ("ISC") +.\" Copyright (C) 2000, 2001 Internet Software Consortium. +.\" .\" Permission to use, copy, modify, and distribute this software for any .\" purpose with or without fee is hereby granted, provided that the above .\" copyright notice and this permission notice appear in all copies. -.\" +.\" .\" THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH .\" REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY -.\" AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT, +.\" AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT, .\" INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM .\" LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE .\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR .\" PERFORMANCE OF THIS SOFTWARE. .\" -.\" $Id: lwres_resutil.3,v 1.14.2.1.8.1 2004/03/06 07:41:44 marka Exp $ +.\" $Id: lwres_resutil.3,v 1.14.2.1.8.5 2005/10/13 02:33:54 marka Exp $ .\" -.TH "LWRES_RESUTIL" "3" "Jun 30, 2000" "BIND9" "" -.SH NAME +.hy 0 +.ad l +.\" ** You probably do not want to edit this file directly ** +.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1). +.\" Instead of manually editing it, you probably should edit the DocBook XML +.\" source for it and then use the DocBook XSL Stylesheets to regenerate it. +.TH "LWRES_RESUTIL" "3" "Jun 30, 2000" "BIND9" "BIND9" +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.SH "NAME" lwres_string_parse, lwres_addr_parse, lwres_getaddrsbyname, lwres_getnamebyaddr \- lightweight resolver utility functions -.SH SYNOPSIS -\fB#include <lwres/lwres.h> -.sp -.na -lwres_result_t -lwres_string_parse(lwres_buffer_t *b, char **c, lwres_uint16_t *len); -.ad -.sp -.na -lwres_result_t -lwres_addr_parse(lwres_buffer_t *b, lwres_addr_t *addr); -.ad -.sp -.na -lwres_result_t -lwres_getaddrsbyname(lwres_context_t *ctx, const char *name, lwres_uint32_t addrtypes, lwres_gabnresponse_t **structp); -.ad -.sp -.na -lwres_result_t -lwres_getnamebyaddr(lwres_context_t *ctx, lwres_uint32_t addrtype, lwres_uint16_t addrlen, const unsigned char *addr, lwres_gnbaresponse_t **structp); -.ad -\fR +.SH "SYNOPSIS" +.nf +#include <lwres/lwres.h> +.fi +.HP 34 +\fBlwres_result_t\ \fBlwres_string_parse\fR\fR\fB(\fR\fBlwres_buffer_t\ *b\fR\fB, \fR\fBchar\ **c\fR\fB, \fR\fBlwres_uint16_t\ *len\fR\fB);\fR +.HP 32 +\fBlwres_result_t\ \fBlwres_addr_parse\fR\fR\fB(\fR\fBlwres_buffer_t\ *b\fR\fB, \fR\fBlwres_addr_t\ *addr\fR\fB);\fR +.HP 36 +\fBlwres_result_t\ \fBlwres_getaddrsbyname\fR\fR\fB(\fR\fBlwres_context_t\ *ctx\fR\fB, \fR\fBconst\ char\ *name\fR\fB, \fR\fBlwres_uint32_t\ addrtypes\fR\fB, \fR\fBlwres_gabnresponse_t\ **structp\fR\fB);\fR +.HP 35 +\fBlwres_result_t\ \fBlwres_getnamebyaddr\fR\fR\fB(\fR\fBlwres_context_t\ *ctx\fR\fB, \fR\fBlwres_uint32_t\ addrtype\fR\fB, \fR\fBlwres_uint16_t\ addrlen\fR\fB, \fR\fBconst\ unsigned\ char\ *addr\fR\fB, \fR\fBlwres_gnbaresponse_t\ **structp\fR\fB);\fR .SH "DESCRIPTION" .PP -\fBlwres_string_parse()\fR retrieves a DNS-encoded -string starting the current pointer of lightweight resolver buffer -\fIb\fR: i.e. b->current. -When the function returns, the address of the first byte of the -encoded string is returned via \fI*c\fR and the -length of that string is given by \fI*len\fR. The -buffer's current pointer is advanced to point at the character -following the string length, the encoded string, and the trailing -\fBNULL\fR character. +\fBlwres_string_parse()\fR +retrieves a DNS\-encoded string starting the current pointer of lightweight resolver buffer +\fIb\fR: i.e. +\fBb\->current\fR. When the function returns, the address of the first byte of the encoded string is returned via +\fI*c\fR +and the length of that string is given by +\fI*len\fR. The buffer's current pointer is advanced to point at the character following the string length, the encoded string, and the trailing +\fBNULL\fR +character. .PP -\fBlwres_addr_parse()\fR extracts an address from the -buffer \fIb\fR. The buffer's current pointer -b->current is presumed to point at an encoded -address: the address preceded by a 32-bit protocol family identifier -and a 16-bit length field. The encoded address is copied to -addr->address and -addr->length indicates the size in bytes of -the address that was copied. b->current is -advanced to point at the next byte of available data in the buffer -following the encoded address. +\fBlwres_addr_parse()\fR +extracts an address from the buffer +\fIb\fR. The buffer's current pointer +\fBb\->current\fR +is presumed to point at an encoded address: the address preceded by a 32\-bit protocol family identifier and a 16\-bit length field. The encoded address is copied to +\fBaddr\->address\fR +and +\fBaddr\->length\fR +indicates the size in bytes of the address that was copied. +\fBb\->current\fR +is advanced to point at the next byte of available data in the buffer following the encoded address. .PP \fBlwres_getaddrsbyname()\fR and @@ -84,31 +84,40 @@ typedef struct { void *base; size_t baselen; } lwres_gabnresponse_t; -.sp .fi -The contents of this structure are not manipulated directly but -they are controlled through the -\fBlwres_gabn\fR(3) +.sp +The contents of this structure are not manipulated directly but they are controlled through the +\fBlwres_gabn\fR(3 ) functions. .PP The lightweight resolver uses -\fBlwres_getaddrsbyname()\fR to perform foward lookups. -Hostname \fIname\fR is looked up using the resolver -context \fIctx\fR for memory allocation. -\fIaddrtypes\fR is a bitmask indicating which type of -addresses are to be looked up. Current values for this bitmask are -\fBLWRES_ADDRTYPE_V4\fR for IPv4 addresses and -\fBLWRES_ADDRTYPE_V6\fR for IPv6 addresses. Results of the -lookup are returned in \fI*structp\fR. +\fBlwres_getaddrsbyname()\fR +to perform foward lookups. Hostname +\fIname\fR +is looked up using the resolver context +\fIctx\fR +for memory allocation. +\fIaddrtypes\fR +is a bitmask indicating which type of addresses are to be looked up. Current values for this bitmask are +\fBLWRES_ADDRTYPE_V4\fR +for IPv4 addresses and +\fBLWRES_ADDRTYPE_V6\fR +for IPv6 addresses. Results of the lookup are returned in +\fI*structp\fR. .PP -\fBlwres_getnamebyaddr()\fR performs reverse lookups. -Resolver context \fIctx\fR is used for memory -allocation. The address type is indicated by -\fIaddrtype\fR: \fBLWRES_ADDRTYPE_V4\fR or -\fBLWRES_ADDRTYPE_V6\fR. The address to be looked up is given -by \fIaddr\fR and its length is -\fIaddrlen\fR bytes. The result of the function call -is made available through \fI*structp\fR. +\fBlwres_getnamebyaddr()\fR +performs reverse lookups. Resolver context +\fIctx\fR +is used for memory allocation. The address type is indicated by +\fIaddrtype\fR: +\fBLWRES_ADDRTYPE_V4\fR +or +\fBLWRES_ADDRTYPE_V6\fR. The address to be looked up is given by +\fIaddr\fR +and its length is +\fIaddrlen\fR +bytes. The result of the function call is made available through +\fI*structp\fR. .SH "RETURN VALUES" .PP Successful calls to @@ -116,24 +125,23 @@ Successful calls to and \fBlwres_addr_parse()\fR return -LWRES_R_SUCCESS. +\fBLWRES_R_SUCCESS.\fR Both functions return -LWRES_R_FAILURE +\fBLWRES_R_FAILURE\fR if the buffer is corrupt or -LWRES_R_UNEXPECTEDEND -if the buffer has less space than expected for the components of the -encoded string or address. +\fBLWRES_R_UNEXPECTEDEND\fR +if the buffer has less space than expected for the components of the encoded string or address. .PP \fBlwres_getaddrsbyname()\fR returns -LWRES_R_SUCCESS +\fBLWRES_R_SUCCESS\fR on success and it returns -LWRES_R_NOTFOUND +\fBLWRES_R_NOTFOUND\fR if the hostname \fIname\fR could not be found. .PP -LWRES_R_SUCCESS +\fBLWRES_R_SUCCESS\fR is returned by a successful call to \fBlwres_getnamebyaddr()\fR. .PP @@ -142,11 +150,10 @@ Both and \fBlwres_getnamebyaddr()\fR return -LWRES_R_NOMEMORY +\fBLWRES_R_NOMEMORY\fR when memory allocation requests fail and -LWRES_R_UNEXPECTEDEND -if the buffers used for sending queries and receiving replies are too -small. +\fBLWRES_R_UNEXPECTEDEND\fR +if the buffers used for sending queries and receiving replies are too small. .SH "SEE ALSO" .PP \fBlwres_buffer\fR(3), diff --git a/contrib/bind9/lib/lwres/man/lwres_resutil.docbook b/contrib/bind9/lib/lwres/man/lwres_resutil.docbook index e5f891f..7ab2146 100644 --- a/contrib/bind9/lib/lwres/man/lwres_resutil.docbook +++ b/contrib/bind9/lib/lwres/man/lwres_resutil.docbook @@ -1,7 +1,9 @@ -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.0//EN" + "http://www.oasis-open.org/docbook/xml/4.0/docbookx.dtd" + [<!ENTITY mdash "—">]> <!-- - - Copyright (C) 2004 Internet Systems Consortium, Inc. ("ISC") - - Copyright (C) 2001 Internet Software Consortium. + - Copyright (C) 2004, 2005 Internet Systems Consortium, Inc. ("ISC") + - Copyright (C) 2000, 2001 Internet Software Consortium. - - Permission to use, copy, modify, and distribute this software for any - purpose with or without fee is hereby granted, provided that the above @@ -16,7 +18,7 @@ - PERFORMANCE OF THIS SOFTWARE. --> -<!-- $Id: lwres_resutil.docbook,v 1.5.206.1 2004/03/06 08:15:42 marka Exp $ --> +<!-- $Id: lwres_resutil.docbook,v 1.5.206.3 2005/05/12 21:36:16 sra Exp $ --> <refentry> @@ -30,6 +32,19 @@ <refmiscinfo>BIND9</refmiscinfo> </refmeta> + <docinfo> + <copyright> + <year>2004</year> + <year>2005</year> + <holder>Internet Systems Consortium, Inc. ("ISC")</holder> + </copyright> + <copyright> + <year>2000</year> + <year>2001</year> + <holder>Internet Software Consortium.</holder> + </copyright> + </docinfo> + <refnamediv> <refname>lwres_string_parse</refname> <refname>lwres_addr_parse</refname> diff --git a/contrib/bind9/lib/lwres/man/lwres_resutil.html b/contrib/bind9/lib/lwres/man/lwres_resutil.html index cc45556..4cee0c7 100644 --- a/contrib/bind9/lib/lwres/man/lwres_resutil.html +++ b/contrib/bind9/lib/lwres/man/lwres_resutil.html @@ -1,186 +1,163 @@ <!-- - - Copyright (C) 2004 Internet Systems Consortium, Inc. ("ISC") - - Copyright (C) 2001 Internet Software Consortium. - - + - Copyright (C) 2004, 2005 Internet Systems Consortium, Inc. ("ISC") + - Copyright (C) 2000, 2001 Internet Software Consortium. + - - Permission to use, copy, modify, and distribute this software for any - purpose with or without fee is hereby granted, provided that the above - copyright notice and this permission notice appear in all copies. - - + - - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY - - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT, + - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT, - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> - -<!-- $Id: lwres_resutil.html,v 1.8.2.1.4.2 2004/08/22 23:39:05 marka Exp $ --> - -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<HTML -><HEAD -><TITLE ->lwres_resutil</TITLE -><META -NAME="GENERATOR" -CONTENT="Modular DocBook HTML Stylesheet Version 1.7"></HEAD -><BODY -CLASS="REFENTRY" -BGCOLOR="#FFFFFF" -TEXT="#000000" -LINK="#0000FF" -VLINK="#840084" -ALINK="#0000FF" -><H1 -><A -NAME="AEN1" -></A ->lwres_resutil</H1 -><DIV -CLASS="REFNAMEDIV" -><A -NAME="AEN8" -></A -><H2 ->Name</H2 ->lwres_string_parse, lwres_addr_parse, lwres_getaddrsbyname, lwres_getnamebyaddr -- lightweight resolver utility functions</DIV -><DIV -CLASS="REFSYNOPSISDIV" -><A -NAME="AEN14" -></A -><H2 ->Synopsis</H2 -><DIV -CLASS="FUNCSYNOPSIS" -><P -></P -><A -NAME="AEN15" -></A -><PRE -CLASS="FUNCSYNOPSISINFO" ->#include <lwres/lwres.h></PRE -><P -><CODE -><CODE -CLASS="FUNCDEF" ->lwres_result_t -lwres_string_parse</CODE ->(lwres_buffer_t *b, char **c, lwres_uint16_t *len);</CODE -></P -><P -><CODE -><CODE -CLASS="FUNCDEF" ->lwres_result_t -lwres_addr_parse</CODE ->(lwres_buffer_t *b, lwres_addr_t *addr);</CODE -></P -><P -><CODE -><CODE -CLASS="FUNCDEF" ->lwres_result_t -lwres_getaddrsbyname</CODE ->(lwres_context_t *ctx, const char *name, lwres_uint32_t addrtypes, lwres_gabnresponse_t **structp);</CODE -></P -><P -><CODE -><CODE -CLASS="FUNCDEF" ->lwres_result_t -lwres_getnamebyaddr</CODE ->(lwres_context_t *ctx, lwres_uint32_t addrtype, lwres_uint16_t addrlen, const unsigned char *addr, lwres_gnbaresponse_t **structp);</CODE -></P -><P -></P -></DIV -></DIV -><DIV -CLASS="REFSECT1" -><A -NAME="AEN43" -></A -><H2 ->DESCRIPTION</H2 -><P -><CODE -CLASS="FUNCTION" ->lwres_string_parse()</CODE -> retrieves a DNS-encoded +<!-- $Id: lwres_resutil.html,v 1.8.2.1.4.9 2005/10/13 02:33:58 marka Exp $ --> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> +<title>lwres_resutil</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.69.1"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"> +<a name="id2463721"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2>Name</h2> +<p>lwres_string_parse, lwres_addr_parse, lwres_getaddrsbyname, lwres_getnamebyaddr — lightweight resolver utility functions</p> +</div> +<div class="refsynopsisdiv"> +<h2>Synopsis</h2> +<div class="funcsynopsis"> +<pre class="funcsynopsisinfo">#include <lwres/lwres.h></pre> +<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em"> +<tr> +<td><code class="funcdef"> +lwres_result_t +<b class="fsfunc">lwres_string_parse</b>(</code></td> +<td> </td> +<td>, </td> +</tr> +<tr> +<td> </td> +<td> </td> +<td>, </td> +</tr> +<tr> +<td> </td> +<td> </td> +<td> +<code>)</code>;</td> +</tr> +</table> +<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em"> +<tr> +<td><code class="funcdef"> +lwres_result_t +<b class="fsfunc">lwres_addr_parse</b>(</code></td> +<td> </td> +<td>, </td> +</tr> +<tr> +<td> </td> +<td> </td> +<td> +<code>)</code>;</td> +</tr> +</table> +<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em"> +<tr> +<td><code class="funcdef"> +lwres_result_t +<b class="fsfunc">lwres_getaddrsbyname</b>(</code></td> +<td> </td> +<td>, </td> +</tr> +<tr> +<td> </td> +<td> </td> +<td>, </td> +</tr> +<tr> +<td> </td> +<td> </td> +<td>, </td> +</tr> +<tr> +<td> </td> +<td> </td> +<td> +<code>)</code>;</td> +</tr> +</table> +<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0"> +<tr> +<td><code class="funcdef"> +lwres_result_t +<b class="fsfunc">lwres_getnamebyaddr</b>(</code></td> +<td> </td> +<td>, </td> +</tr> +<tr> +<td> </td> +<td> </td> +<td>, </td> +</tr> +<tr> +<td> </td> +<td> </td> +<td>, </td> +</tr> +<tr> +<td> </td> +<td> </td> +<td>, </td> +</tr> +<tr> +<td> </td> +<td> </td> +<td> +<code>)</code>;</td> +</tr> +</table> +</div> +</div> +<div class="refsect1" lang="en"> +<a name="id2525921"></a><h2>DESCRIPTION</h2> +<p> +<code class="function">lwres_string_parse()</code> retrieves a DNS-encoded string starting the current pointer of lightweight resolver buffer -<VAR -CLASS="PARAMETER" ->b</VAR ->: i.e. <CODE -CLASS="CONSTANT" ->b->current</CODE ->. +<em class="parameter"><code>b</code></em>: i.e. <code class="constant">b->current</code>. When the function returns, the address of the first byte of the -encoded string is returned via <VAR -CLASS="PARAMETER" ->*c</VAR -> and the -length of that string is given by <VAR -CLASS="PARAMETER" ->*len</VAR ->. The +encoded string is returned via <em class="parameter"><code>*c</code></em> and the +length of that string is given by <em class="parameter"><code>*len</code></em>. The buffer's current pointer is advanced to point at the character following the string length, the encoded string, and the trailing -<SPAN -CLASS="TYPE" ->NULL</SPAN -> character.</P -><P -><CODE -CLASS="FUNCTION" ->lwres_addr_parse()</CODE -> extracts an address from the -buffer <VAR -CLASS="PARAMETER" ->b</VAR ->. The buffer's current pointer -<CODE -CLASS="CONSTANT" ->b->current</CODE -> is presumed to point at an encoded +<span class="type">NULL</span> character. +</p> +<p> +<code class="function">lwres_addr_parse()</code> extracts an address from the +buffer <em class="parameter"><code>b</code></em>. The buffer's current pointer +<code class="constant">b->current</code> is presumed to point at an encoded address: the address preceded by a 32-bit protocol family identifier and a 16-bit length field. The encoded address is copied to -<CODE -CLASS="CONSTANT" ->addr->address</CODE -> and -<CODE -CLASS="CONSTANT" ->addr->length</CODE -> indicates the size in bytes of -the address that was copied. <CODE -CLASS="CONSTANT" ->b->current</CODE -> is +<code class="constant">addr->address</code> and +<code class="constant">addr->length</code> indicates the size in bytes of +the address that was copied. <code class="constant">b->current</code> is advanced to point at the next byte of available data in the buffer -following the encoded address.</P -><P -><CODE -CLASS="FUNCTION" ->lwres_getaddrsbyname()</CODE -> +following the encoded address. +</p> +<p> +<code class="function">lwres_getaddrsbyname()</code> and -<CODE -CLASS="FUNCTION" ->lwres_getnamebyaddr()</CODE -> +<code class="function">lwres_getnamebyaddr()</code> use the -<SPAN -CLASS="TYPE" ->lwres_gnbaresponse_t</SPAN -> +<span class="type">lwres_gnbaresponse_t</span> structure defined below: -<PRE -CLASS="PROGRAMLISTING" ->typedef struct { +</p> +<pre class="programlisting"> +typedef struct { lwres_uint32_t flags; lwres_uint16_t naliases; lwres_uint16_t naddrs; @@ -191,197 +168,88 @@ CLASS="PROGRAMLISTING" lwres_addrlist_t addrs; void *base; size_t baselen; -} lwres_gabnresponse_t;</PRE -> +} lwres_gabnresponse_t; +</pre> +<p> The contents of this structure are not manipulated directly but they are controlled through the -<SPAN -CLASS="CITEREFENTRY" -><SPAN -CLASS="REFENTRYTITLE" ->lwres_gabn</SPAN ->(3)</SPAN -> -functions.</P -><P ->The lightweight resolver uses -<CODE -CLASS="FUNCTION" ->lwres_getaddrsbyname()</CODE -> to perform foward lookups. -Hostname <VAR -CLASS="PARAMETER" ->name</VAR -> is looked up using the resolver -context <VAR -CLASS="PARAMETER" ->ctx</VAR -> for memory allocation. -<VAR -CLASS="PARAMETER" ->addrtypes</VAR -> is a bitmask indicating which type of +<span class="citerefentry"><span class="refentrytitle">lwres_gabn</span>(3 +)</span> +functions. +</p> +<p> +The lightweight resolver uses +<code class="function">lwres_getaddrsbyname()</code> to perform foward lookups. +Hostname <em class="parameter"><code>name</code></em> is looked up using the resolver +context <em class="parameter"><code>ctx</code></em> for memory allocation. +<em class="parameter"><code>addrtypes</code></em> is a bitmask indicating which type of addresses are to be looked up. Current values for this bitmask are -<SPAN -CLASS="TYPE" ->LWRES_ADDRTYPE_V4</SPAN -> for IPv4 addresses and -<SPAN -CLASS="TYPE" ->LWRES_ADDRTYPE_V6</SPAN -> for IPv6 addresses. Results of the -lookup are returned in <VAR -CLASS="PARAMETER" ->*structp</VAR ->.</P -><P -><CODE -CLASS="FUNCTION" ->lwres_getnamebyaddr()</CODE -> performs reverse lookups. -Resolver context <VAR -CLASS="PARAMETER" ->ctx</VAR -> is used for memory +<span class="type">LWRES_ADDRTYPE_V4</span> for IPv4 addresses and +<span class="type">LWRES_ADDRTYPE_V6</span> for IPv6 addresses. Results of the +lookup are returned in <em class="parameter"><code>*structp</code></em>. +</p> +<p> +<code class="function">lwres_getnamebyaddr()</code> performs reverse lookups. +Resolver context <em class="parameter"><code>ctx</code></em> is used for memory allocation. The address type is indicated by -<VAR -CLASS="PARAMETER" ->addrtype</VAR ->: <SPAN -CLASS="TYPE" ->LWRES_ADDRTYPE_V4</SPAN -> or -<SPAN -CLASS="TYPE" ->LWRES_ADDRTYPE_V6</SPAN ->. The address to be looked up is given -by <VAR -CLASS="PARAMETER" ->addr</VAR -> and its length is -<VAR -CLASS="PARAMETER" ->addrlen</VAR -> bytes. The result of the function call -is made available through <VAR -CLASS="PARAMETER" ->*structp</VAR ->.</P -></DIV -><DIV -CLASS="REFSECT1" -><A -NAME="AEN84" -></A -><H2 ->RETURN VALUES</H2 -><P ->Successful calls to -<CODE -CLASS="FUNCTION" ->lwres_string_parse()</CODE -> +<em class="parameter"><code>addrtype</code></em>: <span class="type">LWRES_ADDRTYPE_V4</span> or +<span class="type">LWRES_ADDRTYPE_V6</span>. The address to be looked up is given +by <em class="parameter"><code>addr</code></em> and its length is +<em class="parameter"><code>addrlen</code></em> bytes. The result of the function call +is made available through <em class="parameter"><code>*structp</code></em>. +</p> +</div> +<div class="refsect1" lang="en"> +<a name="id2526060"></a><h2>RETURN VALUES</h2> +<p> +Successful calls to +<code class="function">lwres_string_parse()</code> and -<CODE -CLASS="FUNCTION" ->lwres_addr_parse()</CODE -> +<code class="function">lwres_addr_parse()</code> return -<SPAN -CLASS="ERRORCODE" ->LWRES_R_SUCCESS.</SPAN -> +<span class="errorcode">LWRES_R_SUCCESS.</span> Both functions return -<SPAN -CLASS="ERRORCODE" ->LWRES_R_FAILURE</SPAN -> +<span class="errorcode">LWRES_R_FAILURE</span> if the buffer is corrupt or -<SPAN -CLASS="ERRORCODE" ->LWRES_R_UNEXPECTEDEND</SPAN -> +<span class="errorcode">LWRES_R_UNEXPECTEDEND</span> if the buffer has less space than expected for the components of the -encoded string or address.</P -><P -><CODE -CLASS="FUNCTION" ->lwres_getaddrsbyname()</CODE -> +encoded string or address. +</p> +<p> +<code class="function">lwres_getaddrsbyname()</code> returns -<SPAN -CLASS="ERRORCODE" ->LWRES_R_SUCCESS</SPAN -> +<span class="errorcode">LWRES_R_SUCCESS</span> on success and it returns -<SPAN -CLASS="ERRORCODE" ->LWRES_R_NOTFOUND</SPAN -> +<span class="errorcode">LWRES_R_NOTFOUND</span> if the hostname -<VAR -CLASS="PARAMETER" ->name</VAR -> -could not be found.</P -><P -><SPAN -CLASS="ERRORCODE" ->LWRES_R_SUCCESS</SPAN -> +<em class="parameter"><code>name</code></em> +could not be found. +</p> +<p> +<span class="errorcode">LWRES_R_SUCCESS</span> is returned by a successful call to -<CODE -CLASS="FUNCTION" ->lwres_getnamebyaddr()</CODE ->.</P -><P ->Both -<CODE -CLASS="FUNCTION" ->lwres_getaddrsbyname()</CODE -> +<code class="function">lwres_getnamebyaddr()</code>. +</p> +<p> +Both +<code class="function">lwres_getaddrsbyname()</code> and -<CODE -CLASS="FUNCTION" ->lwres_getnamebyaddr()</CODE -> +<code class="function">lwres_getnamebyaddr()</code> return -<SPAN -CLASS="ERRORCODE" ->LWRES_R_NOMEMORY</SPAN -> +<span class="errorcode">LWRES_R_NOMEMORY</span> when memory allocation requests fail and -<SPAN -CLASS="ERRORCODE" ->LWRES_R_UNEXPECTEDEND</SPAN -> +<span class="errorcode">LWRES_R_UNEXPECTEDEND</span> if the buffers used for sending queries and receiving replies are too -small.</P -></DIV -><DIV -CLASS="REFSECT1" -><A -NAME="AEN105" -></A -><H2 ->SEE ALSO</H2 -><P -><SPAN -CLASS="CITEREFENTRY" -><SPAN -CLASS="REFENTRYTITLE" ->lwres_buffer</SPAN ->(3)</SPAN ->, +small. +</p> +</div> +<div class="refsect1" lang="en"> +<a name="id2526130"></a><h2>SEE ALSO</h2> +<p> +<span class="citerefentry"><span class="refentrytitle">lwres_buffer</span>(3)</span>, -<SPAN -CLASS="CITEREFENTRY" -><SPAN -CLASS="REFENTRYTITLE" ->lwres_gabn</SPAN ->(3)</SPAN ->.</P -></DIV -></BODY -></HTML -> +<span class="citerefentry"><span class="refentrytitle">lwres_gabn</span>(3)</span>. +</p> +</div> +</div></body> +</html> |
