diff options
Diffstat (limited to 'lib/lwres/man/lwres.docbook')
| -rw-r--r-- | lib/lwres/man/lwres.docbook | 68 |
1 files changed, 33 insertions, 35 deletions
diff --git a/lib/lwres/man/lwres.docbook b/lib/lwres/man/lwres.docbook index 26723e5f0cab..5e84ee970d23 100644 --- a/lib/lwres/man/lwres.docbook +++ b/lib/lwres/man/lwres.docbook @@ -1,8 +1,5 @@ -<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" - [<!ENTITY mdash "—">]> <!-- - - Copyright (C) 2004, 2005, 2007, 2014 Internet Systems Consortium, Inc. ("ISC") + - Copyright (C) 2004, 2005, 2007, 2014, 2015 Internet Systems Consortium, Inc. ("ISC") - Copyright (C) 2000, 2001 Internet Software Consortium. - - Permission to use, copy, modify, and/or distribute this software for any @@ -18,10 +15,14 @@ - PERFORMANCE OF THIS SOFTWARE. --> -<refentry> - +<!-- Converted by db4-upgrade version 1.0 --> +<refentry xmlns="http://docbook.org/ns/docbook" version="5.0"> + <info> + <date>2007-06-18</date> + </info> <refentryinfo> - <date>June 18, 2007</date> + <corpname>ISC</corpname> + <corpauthor>Internet Systems Consortium, Inc.</corpauthor> </refentryinfo> <refmeta> @@ -40,6 +41,7 @@ <year>2005</year> <year>2007</year> <year>2014</year> + <year>2015</year> <holder>Internet Systems Consortium, Inc. ("ISC")</holder> </copyright> <copyright> @@ -55,8 +57,8 @@ </funcsynopsis> </refsynopsisdiv> - <refsect1> - <title>DESCRIPTION</title> + <refsection><info><title>DESCRIPTION</title></info> + <para> The BIND 9 lightweight resolver library is a simple, name service independent stub resolver library. It provides hostname-to-address @@ -69,10 +71,10 @@ The library and resolver daemon communicate using a simple UDP-based protocol. </para> - </refsect1> + </refsection> + + <refsection><info><title>OVERVIEW</title></info> - <refsect1> - <title>OVERVIEW</title> <para> The lwresd library implements multiple name service APIs. The standard @@ -124,9 +126,9 @@ resolver daemon. The use of this low-level API in clients and servers is outlined in the following sections. </para> - </refsect1> - <refsect1> - <title>CLIENT-SIDE LOW-LEVEL API CALL FLOW</title> + </refsection> + <refsection><info><title>CLIENT-SIDE LOW-LEVEL API CALL FLOW</title></info> + <para> When a client program wishes to make an lwres request using the native low-level API, it typically performs the following @@ -137,23 +139,23 @@ called <varname>pkt</varname> below. </para> <para> - (2) Set <structfield>pkt.recvlength</structfield> to the maximum length + (2) Set <varname remap="structfield">pkt.recvlength</varname> 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 <filename>lwres.h</filename>: <constant>LWRES_RECVLENGTH = 4096</constant>. </para> <para> - (3) Set <structfield>pkt.serial</structfield> + (3) Set <varname remap="structfield">pkt.serial</varname> to a unique serial number. This value is echoed back to the application by the remote server. </para> <para> - (4) Set <structfield>pkt.pktflags</structfield>. Usually this is set to + (4) Set <varname remap="structfield">pkt.pktflags</varname>. Usually this is set to 0. </para> <para> - (5) Set <structfield>pkt.result</structfield> to 0. + (5) Set <varname remap="structfield">pkt.result</varname> to 0. </para> <para> (6) Call <function>lwres_*request_render()</function>, @@ -172,9 +174,9 @@ (9) Verify that the opcode and serial match a request, and process the packet specific information contained in the body. </para> - </refsect1> - <refsect1> - <title>SERVER-SIDE LOW-LEVEL API CALL FLOW</title> + </refsection> + <refsection><info><title>SERVER-SIDE LOW-LEVEL API CALL FLOW</title></info> + <para> When implementing the server side of the lightweight resolver protocol using the lwres library, a sequence of actions like the @@ -197,12 +199,12 @@ (2) Process the request in the data specific type. </para> <para> - (3) Set the <structfield>pkt.result</structfield>, - <structfield>pkt.recvlength</structfield> as above. All other fields + (3) Set the <varname remap="structfield">pkt.result</varname>, + <varname remap="structfield">pkt.recvlength</varname> as above. All other fields can be left untouched since they were filled in by the <function>*_parse()</function> call above. If using <function>lwres_*response_render()</function>, - <structfield>pkt.pktflags</structfield> will be set up + <varname remap="structfield">pkt.pktflags</varname> will be set up properly. Otherwise, the <constant>LWRES_LWPACKETFLAG_RESPONSE</constant> bit should be set. </para> @@ -213,10 +215,10 @@ <para> (5) Send the resulting packet to the client. </para> - <para></para> - </refsect1> - <refsect1> - <title>SEE ALSO</title> + <para/> + </refsection> + <refsection><info><title>SEE ALSO</title></info> + <para><citerefentry> <refentrytitle>lwres_gethostent</refentrytitle><manvolnum>3</manvolnum> </citerefentry>, @@ -258,9 +260,5 @@ </citerefentry>. </para> - </refsect1> -</refentry><!-- - - Local variables: - - mode: sgml - - End: ---> + </refsection> +</refentry> |