lwres_packet.html revision 5347c0fcb04eaea19d9f39795646239f487c6207
040abec2534dadc53ebc8fa378ef03f4feecb7dbvboxsync<!--
040abec2534dadc53ebc8fa378ef03f4feecb7dbvboxsync - Copyright (C) 2000, 2001, 2004, 2005, 2007, 2014-2016 Internet Systems Consortium, Inc. ("ISC")
040abec2534dadc53ebc8fa378ef03f4feecb7dbvboxsync -
040abec2534dadc53ebc8fa378ef03f4feecb7dbvboxsync - This Source Code Form is subject to the terms of the Mozilla Public
040abec2534dadc53ebc8fa378ef03f4feecb7dbvboxsync - License, v. 2.0. If a copy of the MPL was not distributed with this
040abec2534dadc53ebc8fa378ef03f4feecb7dbvboxsync - file, You can obtain one at http://mozilla.org/MPL/2.0/.
040abec2534dadc53ebc8fa378ef03f4feecb7dbvboxsync-->
040abec2534dadc53ebc8fa378ef03f4feecb7dbvboxsync<html>
040abec2534dadc53ebc8fa378ef03f4feecb7dbvboxsync<head>
040abec2534dadc53ebc8fa378ef03f4feecb7dbvboxsync<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
040abec2534dadc53ebc8fa378ef03f4feecb7dbvboxsync<title>lwres_packet</title>
040abec2534dadc53ebc8fa378ef03f4feecb7dbvboxsync<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
040abec2534dadc53ebc8fa378ef03f4feecb7dbvboxsync</head>
040abec2534dadc53ebc8fa378ef03f4feecb7dbvboxsync<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry">
040abec2534dadc53ebc8fa378ef03f4feecb7dbvboxsync<a name="id-1"></a><div class="titlepage"></div>
040abec2534dadc53ebc8fa378ef03f4feecb7dbvboxsync<div class="refnamediv">
040abec2534dadc53ebc8fa378ef03f4feecb7dbvboxsync<h2>Name</h2>
040abec2534dadc53ebc8fa378ef03f4feecb7dbvboxsync<p>lwres_lwpacket_renderheader, lwres_lwpacket_parseheader &#8212; lightweight resolver packet handling functions</p>
040abec2534dadc53ebc8fa378ef03f4feecb7dbvboxsync</div>
040abec2534dadc53ebc8fa378ef03f4feecb7dbvboxsync<div class="refsynopsisdiv">
040abec2534dadc53ebc8fa378ef03f4feecb7dbvboxsync<h2>Synopsis</h2>
040abec2534dadc53ebc8fa378ef03f4feecb7dbvboxsync<div class="funcsynopsis">
040abec2534dadc53ebc8fa378ef03f4feecb7dbvboxsync<pre class="funcsynopsisinfo">#include &lt;lwres/lwpacket.h&gt;</pre>
040abec2534dadc53ebc8fa378ef03f4feecb7dbvboxsync<table border="0" class="funcprototype-table" summary="Function synopsis" style="cellspacing: 0; cellpadding: 0;">
040abec2534dadc53ebc8fa378ef03f4feecb7dbvboxsync<tr>
040abec2534dadc53ebc8fa378ef03f4feecb7dbvboxsync<td><code class="funcdef">
040abec2534dadc53ebc8fa378ef03f4feecb7dbvboxsynclwres_result_t
040abec2534dadc53ebc8fa378ef03f4feecb7dbvboxsync<b class="fsfunc">lwres_lwpacket_renderheader</b>(</code></td>
040abec2534dadc53ebc8fa378ef03f4feecb7dbvboxsync<td>lwres_buffer_t *<var class="pdparam">b</var>, </td>
040abec2534dadc53ebc8fa378ef03f4feecb7dbvboxsync</tr>
040abec2534dadc53ebc8fa378ef03f4feecb7dbvboxsync<tr>
040abec2534dadc53ebc8fa378ef03f4feecb7dbvboxsync<td>�</td>
040abec2534dadc53ebc8fa378ef03f4feecb7dbvboxsync<td>lwres_lwpacket_t *<var class="pdparam">pkt</var><code>)</code>;</td>
040abec2534dadc53ebc8fa378ef03f4feecb7dbvboxsync</tr>
040abec2534dadc53ebc8fa378ef03f4feecb7dbvboxsync</table>
040abec2534dadc53ebc8fa378ef03f4feecb7dbvboxsync<div class="funcprototype-spacer">�</div>
040abec2534dadc53ebc8fa378ef03f4feecb7dbvboxsync<table border="0" class="funcprototype-table" summary="Function synopsis" style="cellspacing: 0; cellpadding: 0;">
040abec2534dadc53ebc8fa378ef03f4feecb7dbvboxsync<tr>
040abec2534dadc53ebc8fa378ef03f4feecb7dbvboxsync<td><code class="funcdef">
040abec2534dadc53ebc8fa378ef03f4feecb7dbvboxsynclwres_result_t
040abec2534dadc53ebc8fa378ef03f4feecb7dbvboxsync<b class="fsfunc">lwres_lwpacket_parseheader</b>(</code></td>
040abec2534dadc53ebc8fa378ef03f4feecb7dbvboxsync<td>lwres_buffer_t *<var class="pdparam">b</var>, </td>
040abec2534dadc53ebc8fa378ef03f4feecb7dbvboxsync</tr>
040abec2534dadc53ebc8fa378ef03f4feecb7dbvboxsync<tr>
040abec2534dadc53ebc8fa378ef03f4feecb7dbvboxsync<td>�</td>
040abec2534dadc53ebc8fa378ef03f4feecb7dbvboxsync<td>lwres_lwpacket_t *<var class="pdparam">pkt</var><code>)</code>;</td>
040abec2534dadc53ebc8fa378ef03f4feecb7dbvboxsync</tr>
040abec2534dadc53ebc8fa378ef03f4feecb7dbvboxsync</table>
040abec2534dadc53ebc8fa378ef03f4feecb7dbvboxsync<div class="funcprototype-spacer">�</div>
040abec2534dadc53ebc8fa378ef03f4feecb7dbvboxsync</div>
040abec2534dadc53ebc8fa378ef03f4feecb7dbvboxsync</div>
040abec2534dadc53ebc8fa378ef03f4feecb7dbvboxsync<div class="refsection">
040abec2534dadc53ebc8fa378ef03f4feecb7dbvboxsync<a name="id-1.7"></a><h2>DESCRIPTION</h2>
040abec2534dadc53ebc8fa378ef03f4feecb7dbvboxsync<p>
040abec2534dadc53ebc8fa378ef03f4feecb7dbvboxsync These functions rely on a
040abec2534dadc53ebc8fa378ef03f4feecb7dbvboxsync <span class="type">struct lwres_lwpacket</span>
040abec2534dadc53ebc8fa378ef03f4feecb7dbvboxsync which is defined in
040abec2534dadc53ebc8fa378ef03f4feecb7dbvboxsync <code class="filename">lwres/lwpacket.h</code>.
040abec2534dadc53ebc8fa378ef03f4feecb7dbvboxsync </p>
040abec2534dadc53ebc8fa378ef03f4feecb7dbvboxsync<pre class="programlisting">
040abec2534dadc53ebc8fa378ef03f4feecb7dbvboxsynctypedef struct lwres_lwpacket lwres_lwpacket_t;
040abec2534dadc53ebc8fa378ef03f4feecb7dbvboxsync </pre>
040abec2534dadc53ebc8fa378ef03f4feecb7dbvboxsync<p>
040abec2534dadc53ebc8fa378ef03f4feecb7dbvboxsync </p>
040abec2534dadc53ebc8fa378ef03f4feecb7dbvboxsync<pre class="programlisting">
040abec2534dadc53ebc8fa378ef03f4feecb7dbvboxsyncstruct lwres_lwpacket {
040abec2534dadc53ebc8fa378ef03f4feecb7dbvboxsync lwres_uint32_t length;
040abec2534dadc53ebc8fa378ef03f4feecb7dbvboxsync lwres_uint16_t version;
040abec2534dadc53ebc8fa378ef03f4feecb7dbvboxsync lwres_uint16_t pktflags;
040abec2534dadc53ebc8fa378ef03f4feecb7dbvboxsync lwres_uint32_t serial;
040abec2534dadc53ebc8fa378ef03f4feecb7dbvboxsync lwres_uint32_t opcode;
040abec2534dadc53ebc8fa378ef03f4feecb7dbvboxsync lwres_uint32_t result;
040abec2534dadc53ebc8fa378ef03f4feecb7dbvboxsync lwres_uint32_t recvlength;
040abec2534dadc53ebc8fa378ef03f4feecb7dbvboxsync lwres_uint16_t authtype;
040abec2534dadc53ebc8fa378ef03f4feecb7dbvboxsync lwres_uint16_t authlength;
};
</pre>
<p>
</p>
<p>
The elements of this structure are:
</p>
<div class="variablelist"><dl class="variablelist">
<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><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><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><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><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><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><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><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><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 class="variablelist">
<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> <em class="parameter"><code>*pkt</code></em> in
network byte order to the lightweight resolver buffer,
<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 <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="refsection">
<a name="id-1.8"></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>