diff options
Diffstat (limited to 'usr.sbin/bind/lib/lwres/man/lwres_gabn.html')
| -rw-r--r-- | usr.sbin/bind/lib/lwres/man/lwres_gabn.html | 361 |
1 files changed, 164 insertions, 197 deletions
diff --git a/usr.sbin/bind/lib/lwres/man/lwres_gabn.html b/usr.sbin/bind/lib/lwres/man/lwres_gabn.html index 41ab93f9130..a6f2ffcd427 100644 --- a/usr.sbin/bind/lib/lwres/man/lwres_gabn.html +++ b/usr.sbin/bind/lib/lwres/man/lwres_gabn.html @@ -1,5 +1,5 @@ <!-- - - Copyright (C) 2004, 2005 Internet Systems Consortium, Inc. ("ISC") + - Copyright (C) 2004, 2005, 2007 Internet Systems Consortium, Inc. ("ISC") - Copyright (C) 2000, 2001 Internet Software Consortium. - - Permission to use, copy, modify, and distribute this software for any @@ -14,15 +14,15 @@ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - PERFORMANCE OF THIS SOFTWARE. --> -<!-- $ISC: lwres_gabn.html,v 1.6.2.1.4.11 2006/06/29 13:02:31 marka Exp $ --> +<!-- $ISC: lwres_gabn.html,v 1.7.18.17 2007/01/30 00:23:45 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.70.1"> +<meta name="generator" content="DocBook XSL Stylesheets V1.71.1"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"> -<a name="id2482688"></a><div class="titlepage"></div> +<a name="id2476275"></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> @@ -36,29 +36,27 @@ <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> +<td>lwres_context_t * </td> +<td> +<var class="pdparam">ctx</var>, </td> </tr> <tr> <td> </td> -<td> </td> -<td>, </td> +<td>lwres_gabnrequest_t * </td> +<td> +<var class="pdparam">req</var>, </td> </tr> <tr> <td> </td> -<td> </td> -<td>, </td> +<td>lwres_lwpacket_t * </td> +<td> +<var class="pdparam">pkt</var>, </td> </tr> <tr> <td> </td> -<td> </td> +<td>lwres_buffer_t * </td> <td> -<code>)</code>;</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"> @@ -66,29 +64,27 @@ lwres_result_t <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> +<td>lwres_context_t * </td> +<td> +<var class="pdparam">ctx</var>, </td> </tr> <tr> <td> </td> -<td> </td> -<td>, </td> +<td>lwres_gabnresponse_t * </td> +<td> +<var class="pdparam">req</var>, </td> </tr> <tr> <td> </td> -<td> </td> -<td>, </td> +<td>lwres_lwpacket_t * </td> +<td> +<var class="pdparam">pkt</var>, </td> </tr> <tr> <td> </td> -<td> </td> +<td>lwres_buffer_t * </td> <td> -<code>)</code>;</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"> @@ -96,29 +92,27 @@ lwres_result_t <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> +<td>lwres_context_t * </td> +<td> +<var class="pdparam">ctx</var>, </td> </tr> <tr> <td> </td> -<td> </td> -<td>, </td> +<td>lwres_buffer_t * </td> +<td> +<var class="pdparam">b</var>, </td> </tr> <tr> <td> </td> -<td> </td> -<td>, </td> +<td>lwres_lwpacket_t * </td> +<td> +<var class="pdparam">pkt</var>, </td> </tr> <tr> <td> </td> -<td> </td> +<td>lwres_gabnrequest_t ** </td> <td> -<code>)</code>;</td> +<var class="pdparam">structp</var><code>)</code>;</td> </tr> </table> <table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em"> @@ -126,29 +120,27 @@ lwres_result_t <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> +<td>lwres_context_t * </td> +<td> +<var class="pdparam">ctx</var>, </td> </tr> <tr> <td> </td> -<td> </td> -<td>, </td> +<td>lwres_buffer_t * </td> +<td> +<var class="pdparam">b</var>, </td> </tr> <tr> <td> </td> -<td> </td> -<td>, </td> +<td>lwres_lwpacket_t * </td> +<td> +<var class="pdparam">pkt</var>, </td> </tr> <tr> <td> </td> -<td> </td> +<td>lwres_gabnresponse_t ** </td> <td> -<code>)</code>;</td> +<var class="pdparam">structp</var><code>)</code>;</td> </tr> </table> <table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em"> @@ -156,19 +148,15 @@ lwres_result_t <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>, </td> +<td>lwres_context_t * </td> +<td> +<var class="pdparam">ctx</var>, </td> </tr> <tr> <td> </td> -<td> </td> +<td>lwres_gabnresponse_t ** </td> <td> -<code>)</code>;</td> +<var class="pdparam">structp</var><code>)</code>;</td> </tr> </table> <table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0"> @@ -176,61 +164,66 @@ void <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>, </td> +<td>lwres_context_t * </td> +<td> +<var class="pdparam">ctx</var>, </td> </tr> <tr> <td> </td> -<td> </td> +<td>lwres_gabnrequest_t ** </td> <td> -<code>)</code>;</td> +<var class="pdparam">structp</var><code>)</code>;</td> </tr> </table> </div> </div> <div class="refsect1" lang="en"> -<a name="id2549528"></a><h2>DESCRIPTION</h2> +<a name="id2543522"></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> + 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> — -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> — -to the canonical format. -This is complemented by a parse function which converts a packet in -canonical format to a getaddrbyname response structure. -</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> — + 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 -<code class="filename"><lwres/lwres.h></code>. -They are shown below. -</p> + These structures are defined in + <code class="filename"><lwres/lwres.h></code>. + They are shown below. + </p> <pre class="programlisting"> #define LWRES_OPCODE_GETADDRSBYNAME 0x00010001U - +</pre> +<p> + </p> +<pre class="programlisting"> typedef struct lwres_addr lwres_addr_t; typedef LWRES_LIST(lwres_addr_t) lwres_addrlist_t; - +</pre> +<p> + </p> +<pre class="programlisting"> typedef struct { lwres_uint32_t flags; lwres_uint32_t addrtypes; lwres_uint16_t namelen; char *name; } lwres_gabnrequest_t; - +</pre> +<p> + </p> +<pre class="programlisting"> typedef struct { lwres_uint32_t flags; lwres_uint16_t naliases; @@ -245,113 +238,87 @@ typedef struct { } lwres_gabnresponse_t; </pre> <p> -</p> -<p> -<code class="function">lwres_gabnrequest_render()</code> -uses resolver context -<em class="parameter"><code>ctx</code></em> -to convert getaddrbyname 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>. + </p> +<p><code class="function">lwres_gabnrequest_render()</code> + uses resolver context <em class="parameter"><code>ctx</code></em> to convert + getaddrbyname 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_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> -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_gabnrequest_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_gabnrequest_t</span> -is made available through -<em class="parameter"><code>*structp</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_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> + 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_gabnrequest_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_gabnrequest_t</span> is made available through + <em class="parameter"><code>*structp</code></em>. -<code class="function">lwres_gabnresponse_parse()</code> -offers the same semantics as -<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> -and -<code class="function">lwres_gabnrequest_free()</code> -release the memory in resolver context -<em class="parameter"><code>ctx</code></em> -that was allocated to the -<span class="type">lwres_gabnresponse_t</span> -or -<span class="type">lwres_gabnrequest_t</span> -structures referenced via -<em class="parameter"><code>structp</code></em>. + <code class="function">lwres_gabnresponse_parse()</code> offers the same + semantics as <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> + and <code class="function">lwres_gabnrequest_free()</code> release the + memory in resolver context <em class="parameter"><code>ctx</code></em> that was + allocated to the <span class="type">lwres_gabnresponse_t</span> or + <span class="type">lwres_gabnrequest_t</span> structures referenced via + <em class="parameter"><code>structp</code></em>. -Any memory associated with ancillary buffers and strings for those -structures is also discarded. -</p> + Any memory associated with ancillary buffers and strings for + those structures is also discarded. + </p> </div> <div class="refsect1" lang="en"> -<a name="id2549720"></a><h2>RETURN VALUES</h2> +<a name="id2543667"></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> -all return -<span class="errorcode">LWRES_R_SUCCESS</span> -on success. -They return -<span class="errorcode">LWRES_R_NOMEMORY</span> -if memory allocation fails. -<span class="errorcode">LWRES_R_UNEXPECTEDEND</span> -is returned if the available space in the buffer -<em class="parameter"><code>b</code></em> -is too small to accommodate the packet header or the -<span class="type">lwres_gabnrequest_t</span> -and -<span class="type">lwres_gabnresponse_t</span> -structures. -<code class="function">lwres_gabnrequest_parse()</code> -and -<code class="function">lwres_gabnresponse_parse()</code> -will return -<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> -if -<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> + 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> + all return + <span class="errorcode">LWRES_R_SUCCESS</span> + on success. + They return + <span class="errorcode">LWRES_R_NOMEMORY</span> + if memory allocation fails. + <span class="errorcode">LWRES_R_UNEXPECTEDEND</span> + is returned if the available space in the buffer + <em class="parameter"><code>b</code></em> + is too small to accommodate the packet header or the + <span class="type">lwres_gabnrequest_t</span> + and + <span class="type">lwres_gabnresponse_t</span> + structures. + <code class="function">lwres_gabnrequest_parse()</code> + and + <code class="function">lwres_gabnresponse_parse()</code> + will return + <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> + if + <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" lang="en"> -<a name="id2549853"></a><h2>SEE ALSO</h2> -<p> -<span class="citerefentry"><span class="refentrytitle">lwres_packet</span>(3 -)</span> -</p> +<a name="id2543733"></a><h2>SEE ALSO</h2> +<p><span class="citerefentry"><span class="refentrytitle">lwres_packet</span>(3)</span> + </p> </div> </div></body> </html> |