lwres_gnba.html revision 7911e6f9de303bca5a3d8b34f4330c8f7cecffae
9bff67898d55cddfcec9ce30cc2b1bb6211ec691David Lawrence<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
9bff67898d55cddfcec9ce30cc2b1bb6211ec691David Lawrence<!--
9bff67898d55cddfcec9ce30cc2b1bb6211ec691David Lawrence - Copyright (C) 2000, 2001, 2004, 2005, 2007, 2014-2016 Internet Systems Consortium, Inc. ("ISC")
c43deb8aacb70124a8016f408c64b80d4c019b68David Lawrence -
cf608835a3b057be837bf68bda8abf9550f92294Michael Graff - This Source Code Form is subject to the terms of the Mozilla Public
cf608835a3b057be837bf68bda8abf9550f92294Michael Graff - License, v. 2.0. If a copy of the MPL was not distributed with this
cf608835a3b057be837bf68bda8abf9550f92294Michael Graff - file, You can obtain one at http://mozilla.org/MPL/2.0/.
cf608835a3b057be837bf68bda8abf9550f92294Michael Graff-->
cf608835a3b057be837bf68bda8abf9550f92294Michael Graff<html lang="en">
cf608835a3b057be837bf68bda8abf9550f92294Michael Graff<head>
cf608835a3b057be837bf68bda8abf9550f92294Michael Graff<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
cf608835a3b057be837bf68bda8abf9550f92294Michael Graff<title>lwres_gnba</title>
cf608835a3b057be837bf68bda8abf9550f92294Michael Graff<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
cf608835a3b057be837bf68bda8abf9550f92294Michael Graff</head>
cf608835a3b057be837bf68bda8abf9550f92294Michael Graff<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry">
cf608835a3b057be837bf68bda8abf9550f92294Michael Graff<a name="id-1"></a><div class="titlepage"></div>
cf608835a3b057be837bf68bda8abf9550f92294Michael Graff
cf608835a3b057be837bf68bda8abf9550f92294Michael Graff
cf608835a3b057be837bf68bda8abf9550f92294Michael Graff
cf608835a3b057be837bf68bda8abf9550f92294Michael Graff
cf608835a3b057be837bf68bda8abf9550f92294Michael Graff
cf608835a3b057be837bf68bda8abf9550f92294Michael Graff
cf608835a3b057be837bf68bda8abf9550f92294Michael Graff
cf608835a3b057be837bf68bda8abf9550f92294Michael Graff <div class="refnamediv">
cf608835a3b057be837bf68bda8abf9550f92294Michael Graff<h2>Name</h2>
cf608835a3b057be837bf68bda8abf9550f92294Michael Graff<p>
cf608835a3b057be837bf68bda8abf9550f92294Michael Graff lwres_gnbarequest_render,
cf608835a3b057be837bf68bda8abf9550f92294Michael Graff lwres_gnbaresponse_render,
cf608835a3b057be837bf68bda8abf9550f92294Michael Graff lwres_gnbarequest_parse,
cf608835a3b057be837bf68bda8abf9550f92294Michael Graff lwres_gnbaresponse_parse,
cf608835a3b057be837bf68bda8abf9550f92294Michael Graff lwres_gnbaresponse_free,
cf608835a3b057be837bf68bda8abf9550f92294Michael Graff lwres_gnbarequest_free
cf608835a3b057be837bf68bda8abf9550f92294Michael Graff &#8212; lightweight resolver getnamebyaddress message handling
cf608835a3b057be837bf68bda8abf9550f92294Michael Graff </p>
cf608835a3b057be837bf68bda8abf9550f92294Michael Graff</div>
cf608835a3b057be837bf68bda8abf9550f92294Michael Graff
cf608835a3b057be837bf68bda8abf9550f92294Michael Graff <div class="refsynopsisdiv">
cf608835a3b057be837bf68bda8abf9550f92294Michael Graff<h2>Synopsis</h2>
c43deb8aacb70124a8016f408c64b80d4c019b68David Lawrence
cf608835a3b057be837bf68bda8abf9550f92294Michael Graff <div class="funcsynopsis">
cf608835a3b057be837bf68bda8abf9550f92294Michael Graff<pre class="funcsynopsisinfo">
cf608835a3b057be837bf68bda8abf9550f92294Michael Graff#include &lt;lwres/lwres.h&gt;
cf608835a3b057be837bf68bda8abf9550f92294Michael Graff</pre>
cf608835a3b057be837bf68bda8abf9550f92294Michael Graff
cf608835a3b057be837bf68bda8abf9550f92294Michael Graff<table border="0" class="funcprototype-table" summary="Function synopsis" style="cellspacing: 0; cellpadding: 0;">
cf608835a3b057be837bf68bda8abf9550f92294Michael Graff<tr>
cf608835a3b057be837bf68bda8abf9550f92294Michael Graff<td><code class="funcdef">
cf608835a3b057be837bf68bda8abf9550f92294Michael Grafflwres_result_t
cf608835a3b057be837bf68bda8abf9550f92294Michael Graff<b class="fsfunc">lwres_gnbarequest_render</b>
cf608835a3b057be837bf68bda8abf9550f92294Michael Graff(</code></td>
cf608835a3b057be837bf68bda8abf9550f92294Michael Graff<td>lwres_context_t *<var class="pdparam">ctx</var>, </td>
cf608835a3b057be837bf68bda8abf9550f92294Michael Graff</tr>
cf608835a3b057be837bf68bda8abf9550f92294Michael Graff<tr>
cf608835a3b057be837bf68bda8abf9550f92294Michael Graff<td>�</td>
cf608835a3b057be837bf68bda8abf9550f92294Michael Graff<td>lwres_gnbarequest_t *<var class="pdparam">req</var>, </td>
cf608835a3b057be837bf68bda8abf9550f92294Michael Graff</tr>
cf608835a3b057be837bf68bda8abf9550f92294Michael Graff<tr>
cf608835a3b057be837bf68bda8abf9550f92294Michael Graff<td>�</td>
cf608835a3b057be837bf68bda8abf9550f92294Michael Graff<td>lwres_lwpacket_t *<var class="pdparam">pkt</var>, </td>
cf608835a3b057be837bf68bda8abf9550f92294Michael Graff</tr>
cf608835a3b057be837bf68bda8abf9550f92294Michael Graff<tr>
cf608835a3b057be837bf68bda8abf9550f92294Michael Graff<td>�</td>
cf608835a3b057be837bf68bda8abf9550f92294Michael Graff<td>lwres_buffer_t *<var class="pdparam">b</var><code>)</code>;</td>
cf608835a3b057be837bf68bda8abf9550f92294Michael Graff</tr>
cf608835a3b057be837bf68bda8abf9550f92294Michael Graff</table>
cf608835a3b057be837bf68bda8abf9550f92294Michael Graff<div class="funcprototype-spacer">�</div>
cf608835a3b057be837bf68bda8abf9550f92294Michael Graff
cf608835a3b057be837bf68bda8abf9550f92294Michael Graff<table border="0" class="funcprototype-table" summary="Function synopsis" style="cellspacing: 0; cellpadding: 0;">
cf608835a3b057be837bf68bda8abf9550f92294Michael Graff<tr>
cf608835a3b057be837bf68bda8abf9550f92294Michael Graff<td><code class="funcdef">
cf608835a3b057be837bf68bda8abf9550f92294Michael Grafflwres_result_t
cf608835a3b057be837bf68bda8abf9550f92294Michael Graff<b class="fsfunc">lwres_gnbaresponse_render</b>
cf608835a3b057be837bf68bda8abf9550f92294Michael Graff(</code></td>
cf608835a3b057be837bf68bda8abf9550f92294Michael Graff<td>lwres_context_t *<var class="pdparam">ctx</var>, </td>
cf608835a3b057be837bf68bda8abf9550f92294Michael Graff</tr>
cf608835a3b057be837bf68bda8abf9550f92294Michael Graff<tr>
cf608835a3b057be837bf68bda8abf9550f92294Michael Graff<td>�</td>
cf608835a3b057be837bf68bda8abf9550f92294Michael Graff<td>lwres_gnbaresponse_t *<var class="pdparam">req</var>, </td>
cf608835a3b057be837bf68bda8abf9550f92294Michael Graff</tr>
cf608835a3b057be837bf68bda8abf9550f92294Michael Graff<tr>
cf608835a3b057be837bf68bda8abf9550f92294Michael Graff<td>�</td>
cf608835a3b057be837bf68bda8abf9550f92294Michael Graff<td>lwres_lwpacket_t *<var class="pdparam">pkt</var>, </td>
cf608835a3b057be837bf68bda8abf9550f92294Michael Graff</tr>
cf608835a3b057be837bf68bda8abf9550f92294Michael Graff<tr>
cf608835a3b057be837bf68bda8abf9550f92294Michael Graff<td>�</td>
cf608835a3b057be837bf68bda8abf9550f92294Michael Graff<td>lwres_buffer_t *<var class="pdparam">b</var><code>)</code>;</td>
cf608835a3b057be837bf68bda8abf9550f92294Michael Graff</tr>
cf608835a3b057be837bf68bda8abf9550f92294Michael Graff</table>
cf608835a3b057be837bf68bda8abf9550f92294Michael Graff<div class="funcprototype-spacer">�</div>
cf608835a3b057be837bf68bda8abf9550f92294Michael Graff<table border="0" class="funcprototype-table" summary="Function synopsis" style="cellspacing: 0; cellpadding: 0;">
cf608835a3b057be837bf68bda8abf9550f92294Michael Graff<tr>
cf608835a3b057be837bf68bda8abf9550f92294Michael Graff<td><code class="funcdef">
cf608835a3b057be837bf68bda8abf9550f92294Michael Grafflwres_result_t
cf608835a3b057be837bf68bda8abf9550f92294Michael Graff<b class="fsfunc">lwres_gnbarequest_parse</b>(</code></td>
cf608835a3b057be837bf68bda8abf9550f92294Michael Graff<td>lwres_context_t *<var class="pdparam">ctx</var>, </td>
cf608835a3b057be837bf68bda8abf9550f92294Michael Graff</tr>
cf608835a3b057be837bf68bda8abf9550f92294Michael Graff<tr>
cf608835a3b057be837bf68bda8abf9550f92294Michael Graff<td>�</td>
cf608835a3b057be837bf68bda8abf9550f92294Michael Graff<td>lwres_buffer_t *<var class="pdparam">b</var>, </td>
cf608835a3b057be837bf68bda8abf9550f92294Michael Graff</tr>
cf608835a3b057be837bf68bda8abf9550f92294Michael Graff<tr>
cf608835a3b057be837bf68bda8abf9550f92294Michael Graff<td>�</td>
cf608835a3b057be837bf68bda8abf9550f92294Michael Graff<td>lwres_lwpacket_t *<var class="pdparam">pkt</var>, </td>
cf608835a3b057be837bf68bda8abf9550f92294Michael Graff</tr>
cf608835a3b057be837bf68bda8abf9550f92294Michael Graff<tr>
cf608835a3b057be837bf68bda8abf9550f92294Michael Graff<td>�</td>
cf608835a3b057be837bf68bda8abf9550f92294Michael Graff<td>lwres_gnbarequest_t **<var class="pdparam">structp</var><code>)</code>;</td>
cf608835a3b057be837bf68bda8abf9550f92294Michael Graff</tr>
cf608835a3b057be837bf68bda8abf9550f92294Michael Graff</table>
cf608835a3b057be837bf68bda8abf9550f92294Michael Graff<div class="funcprototype-spacer">�</div>
cf608835a3b057be837bf68bda8abf9550f92294Michael Graff<table border="0" class="funcprototype-table" summary="Function synopsis" style="cellspacing: 0; cellpadding: 0;">
cf608835a3b057be837bf68bda8abf9550f92294Michael Graff<tr>
cf608835a3b057be837bf68bda8abf9550f92294Michael Graff<td><code class="funcdef">
cf608835a3b057be837bf68bda8abf9550f92294Michael Grafflwres_result_t
cf608835a3b057be837bf68bda8abf9550f92294Michael Graff<b class="fsfunc">lwres_gnbaresponse_parse</b>(</code></td>
cf608835a3b057be837bf68bda8abf9550f92294Michael Graff<td>lwres_context_t *<var class="pdparam">ctx</var>, </td>
cf608835a3b057be837bf68bda8abf9550f92294Michael Graff</tr>
cf608835a3b057be837bf68bda8abf9550f92294Michael Graff<tr>
cf608835a3b057be837bf68bda8abf9550f92294Michael Graff<td>�</td>
cf608835a3b057be837bf68bda8abf9550f92294Michael Graff<td>lwres_buffer_t *<var class="pdparam">b</var>, </td>
cf608835a3b057be837bf68bda8abf9550f92294Michael Graff</tr>
cf608835a3b057be837bf68bda8abf9550f92294Michael Graff<tr>
cf608835a3b057be837bf68bda8abf9550f92294Michael Graff<td>�</td>
cf608835a3b057be837bf68bda8abf9550f92294Michael Graff<td>lwres_lwpacket_t *<var class="pdparam">pkt</var>, </td>
cf608835a3b057be837bf68bda8abf9550f92294Michael Graff</tr>
cf608835a3b057be837bf68bda8abf9550f92294Michael Graff<tr>
cf608835a3b057be837bf68bda8abf9550f92294Michael Graff<td>�</td>
cf608835a3b057be837bf68bda8abf9550f92294Michael Graff<td>lwres_gnbaresponse_t **<var class="pdparam">structp</var><code>)</code>;</td>
cf608835a3b057be837bf68bda8abf9550f92294Michael Graff</tr>
cf608835a3b057be837bf68bda8abf9550f92294Michael Graff</table>
<div class="funcprototype-spacer">�</div>
<table border="0" class="funcprototype-table" summary="Function synopsis" style="cellspacing: 0; cellpadding: 0;">
<tr>
<td><code class="funcdef">
void
<b class="fsfunc">lwres_gnbaresponse_free</b>
(</code></td>
<td>lwres_context_t *<var class="pdparam">ctx</var>, </td>
</tr>
<tr>
<td>�</td>
<td>lwres_gnbaresponse_t **<var class="pdparam">structp</var><code>)</code>;</td>
</tr>
</table>
<div class="funcprototype-spacer">�</div>
<table border="0" class="funcprototype-table" summary="Function synopsis" style="cellspacing: 0; cellpadding: 0;">
<tr>
<td><code class="funcdef">
void
<b class="fsfunc">lwres_gnbarequest_free</b>(</code></td>
<td>lwres_context_t *<var class="pdparam">ctx</var>, </td>
</tr>
<tr>
<td>�</td>
<td>lwres_gnbarequest_t **<var class="pdparam">structp</var><code>)</code>;</td>
</tr>
</table>
<div class="funcprototype-spacer">�</div>
</div>
</div>
<div class="refsection">
<a name="id-1.7"></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 &#8212;
<span class="type">lwres_gnbarequest_t</span> &#8212;
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
&#8212;
<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
<code class="filename">lwres/lwres.h</code>.
They are shown below.
</p>
<pre class="programlisting">
#define LWRES_OPCODE_GETNAMEBYADDR 0x00010002U
</pre>
<p>
</p>
<pre class="programlisting">
typedef struct {
lwres_uint32_t flags;
lwres_addr_t addr;
} lwres_gnbarequest_t;
</pre>
<p>
</p>
<pre class="programlisting">
typedef struct {
lwres_uint32_t flags;
lwres_uint16_t naliases;
char *realname;
char **aliases;
lwres_uint16_t realnamelen;
lwres_uint16_t *aliaslen;
void *base;
size_t baselen;
} lwres_gnbaresponse_t;
</pre>
<p>
</p>
<p><code class="function">lwres_gnbarequest_render()</code>
uses resolver context <code class="varname">ctx</code> to convert
getnamebyaddr request structure <code class="varname">req</code> to
canonical format. The packet header structure
<code class="varname">pkt</code> is initialised and transferred to buffer
<code class="varname">b</code>. The contents of <code class="varname">*req</code>
are then appended to the buffer in canonical format.
<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>
uses context <code class="varname">ctx</code> to convert the contents of
packet <code class="varname">pkt</code> to a
<span class="type">lwres_gnbarequest_t</span> structure. Buffer
<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> is made available through
<code class="varname">*structp</code>.
<code class="function">lwres_gnbaresponse_parse()</code> offers the same
semantics as <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>
and <code class="function">lwres_gnbarequest_free()</code> release the
memory in resolver context <code class="varname">ctx</code> that was
allocated to the <span class="type">lwres_gnbaresponse_t</span> or
<span class="type">lwres_gnbarequest_t</span> structures referenced via
<code class="varname">structp</code>. Any memory associated with
ancillary buffers and strings for those structures is also
discarded.
</p>
</div>
<div class="refsection">
<a name="id-1.8"></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>
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
<code class="varname">b</code>
is too small to accommodate the packet header or the
<span class="type">lwres_gnbarequest_t</span>
and
<span class="type">lwres_gnbaresponse_t</span>
structures.
<code class="function">lwres_gnbarequest_parse()</code>
and
<code class="function">lwres_gnbaresponse_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
<code class="varname">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="refsection">
<a name="id-1.9"></a><h2>SEE ALSO</h2>
<p><span class="citerefentry">
<span class="refentrytitle">lwres_packet</span>(3)
</span>.
</p>
</div>
</div></body>
</html>