diff options
Diffstat (limited to 'contrib/bind9/lib/lwres/man/lwres_gabn.html')
-rw-r--r-- | contrib/bind9/lib/lwres/man/lwres_gabn.html | 580 |
1 files changed, 244 insertions, 336 deletions
diff --git a/contrib/bind9/lib/lwres/man/lwres_gabn.html b/contrib/bind9/lib/lwres/man/lwres_gabn.html index 6cb6614cbd553..771394508a281 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> |