lwres_gnba.html revision 8eea877894ea5bcf5cdd9ca124a8601ad421d753
469N/A<!--
469N/A - Copyright (C) 2000, 2001 Internet Software Consortium.
469N/A -
469N/A - Permission to use, copy, modify, and distribute this software for any
911N/A - purpose with or without fee is hereby granted, provided that the above
761N/A - copyright notice and this permission notice appear in all copies.
469N/A -
469N/A - THE SOFTWARE IS PROVIDED "AS IS" AND INTERNET SOFTWARE CONSORTIUM
469N/A - DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL
469N/A - IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL
469N/A - INTERNET SOFTWARE CONSORTIUM BE LIABLE FOR ANY SPECIAL, DIRECT,
469N/A - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING
469N/A - FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
469N/A - NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION
469N/A - WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
469N/A-->
469N/A<HTML
469N/A><HEAD
469N/A><TITLE
469N/A>lwres_gnba</TITLE
469N/A><META
469N/ANAME="GENERATOR"
469N/ACONTENT="Modular DocBook HTML Stylesheet Version 1.61
469N/A"></HEAD
469N/A><BODY
469N/ACLASS="REFENTRY"
469N/ABGCOLOR="#FFFFFF"
469N/ATEXT="#000000"
469N/ALINK="#0000FF"
469N/AVLINK="#840084"
469N/AALINK="#0000FF"
469N/A><H1
469N/A><A
469N/ANAME="AEN1"
469N/A>lwres_gnba</A
493N/A></H1
469N/A><DIV
469N/ACLASS="REFNAMEDIV"
761N/A><A
469N/ANAME="AEN8"
911N/A></A
911N/A><H2
911N/A>Name</H2
911N/A>lwres_gnbarequest_render, lwres_gnbaresponse_render, lwres_gnbarequest_parse, lwres_gnbaresponse_parse, lwres_gnbaresponse_free, lwres_gnbarequest_free&nbsp;--&nbsp;lightweight resolver getnamebyaddress message handling</DIV
469N/A><DIV
469N/ACLASS="REFSYNOPSISDIV"
469N/A><A
493N/ANAME="AEN16"
469N/A></A
469N/A><H2
469N/A>Synopsis</H2
469N/A><DIV
493N/ACLASS="FUNCSYNOPSIS"
493N/A><A
469N/ANAME="AEN17"
469N/A></A
493N/A><P
469N/A></P
469N/A><PRE
469N/ACLASS="FUNCSYNOPSISINFO"
493N/A>#include &lt;lwres/lwres.h&gt;</PRE
493N/A><P
><CODE
><CODE
CLASS="FUNCDEF"
>lwres_result_t
lwres_gnbarequest_render</CODE
>(lwres_context_t *ctx, lwres_gnbarequest_t *req, lwres_lwpacket_t *pkt, lwres_buffer_t *b);</CODE
></P
><P
><CODE
><CODE
CLASS="FUNCDEF"
>lwres_result_t
lwres_gnbaresponse_render</CODE
>(lwres_context_t *ctx, lwres_gnbaresponse_t *req, lwres_lwpacket_t *pkt, lwres_buffer_t *b);</CODE
></P
><P
><CODE
><CODE
CLASS="FUNCDEF"
>lwres_result_t
lwres_gnbarequest_parse</CODE
>(lwres_context_t *ctx, lwres_buffer_t *b, lwres_lwpacket_t *pkt, lwres_gnbarequest_t **structp);</CODE
></P
><P
><CODE
><CODE
CLASS="FUNCDEF"
>lwres_result_t
lwres_gnbaresponse_parse</CODE
>(lwres_context_t *ctx, lwres_buffer_t *b, lwres_lwpacket_t *pkt, lwres_gnbaresponse_t **structp);</CODE
></P
><P
><CODE
><CODE
CLASS="FUNCDEF"
>void
lwres_gnbaresponse_free</CODE
>(lwres_context_t *ctx, lwres_gnbaresponse_t **structp);</CODE
></P
><P
><CODE
><CODE
CLASS="FUNCDEF"
>void
lwres_gnbarequest_free</CODE
>(lwres_context_t *ctx, lwres_gnbarequest_t **structp);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN61"
></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 &mdash;
<SPAN
CLASS="TYPE"
>lwres_gnbarequest_t</SPAN
> &mdash;
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 &mdash;
<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
<TT
CLASS="FILENAME"
>lwres/lwres.h</TT
>.
They are shown below.
<PRE
CLASS="PROGRAMLISTING"
>#define LWRES_OPCODE_GETNAMEBYADDR 0x00010002U
typedef struct {
lwres_uint32_t flags;
lwres_addr_t addr;
} lwres_gnbarequest_t;
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
><TT
CLASS="FUNCTION"
>lwres_gnbarequest_render()</TT
>
uses resolver context
<TT
CLASS="VARNAME"
>ctx</TT
>
to convert getnamebyaddr request structure
<TT
CLASS="VARNAME"
>req</TT
>
to canonical format.
The packet header structure
<TT
CLASS="VARNAME"
>pkt</TT
>
is initialised and transferred to
buffer
<TT
CLASS="VARNAME"
>b</TT
>.
The contents of
<TT
CLASS="VARNAME"
>*req</TT
>
are then appended to the buffer in canonical format.
<TT
CLASS="FUNCTION"
>lwres_gnbaresponse_render()</TT
>
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
><TT
CLASS="FUNCTION"
>lwres_gnbarequest_parse()</TT
>
uses context
<TT
CLASS="VARNAME"
>ctx</TT
>
to convert the contents of packet
<TT
CLASS="VARNAME"
>pkt</TT
>
to a
<SPAN
CLASS="TYPE"
>lwres_gnbarequest_t</SPAN
>
structure.
Buffer
<TT
CLASS="VARNAME"
>b</TT
>
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
<TT
CLASS="VARNAME"
>*structp</TT
>.
<TT
CLASS="FUNCTION"
>lwres_gnbaresponse_parse()</TT
>
offers the same semantics as
<TT
CLASS="FUNCTION"
>lwres_gnbarequest_parse()</TT
>
except it yields a
<SPAN
CLASS="TYPE"
>lwres_gnbaresponse_t</SPAN
>
structure.</P
><P
><TT
CLASS="FUNCTION"
>lwres_gnbaresponse_free()</TT
>
and
<TT
CLASS="FUNCTION"
>lwres_gnbarequest_free()</TT
>
release the memory in resolver context
<TT
CLASS="VARNAME"
>ctx</TT
>
that was allocated to the
<SPAN
CLASS="TYPE"
>lwres_gnbaresponse_t</SPAN
>
or
<SPAN
CLASS="TYPE"
>lwres_gnbarequest_t</SPAN
>
structures referenced via
<TT
CLASS="VARNAME"
>structp</TT
>.
Any memory associated with ancillary buffers and strings for those
structures is also discarded.</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN97"
></A
><H2
>RETURN VALUES</H2
><P
>The getnamebyaddr opcode functions
<TT
CLASS="FUNCTION"
>lwres_gnbarequest_render()</TT
>,
<TT
CLASS="FUNCTION"
>lwres_gnbaresponse_render()</TT
>
<TT
CLASS="FUNCTION"
>lwres_gnbarequest_parse()</TT
>
and
<TT
CLASS="FUNCTION"
>lwres_gnbaresponse_parse()</TT
>
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
<TT
CLASS="VARNAME"
>b</TT
>
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.
<TT
CLASS="FUNCTION"
>lwres_gnbarequest_parse()</TT
>
and
<TT
CLASS="FUNCTION"
>lwres_gnbaresponse_parse()</TT
>
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
<TT
CLASS="STRUCTFIELD"
><I
>pktflags</I
></TT
>
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="AEN116"
></A
><H2
>SEE ALSO</H2
><P
><SPAN
CLASS="CITEREFENTRY"
><SPAN
CLASS="REFENTRYTITLE"
>lwres_packet</SPAN
>(3)</SPAN
>.</P
></DIV
></BODY
></HTML
>