lwres_gabn.html revision 1969ab5360417d374547a8b51c78acfa1e9202ba
155N/A<!--
155N/A - Copyright (C) 2001 Internet Software Consortium.
155N/A -
155N/A - Permission to use, copy, modify, and distribute this software for any
155N/A - purpose with or without fee is hereby granted, provided that the above
155N/A - copyright notice and this permission notice appear in all copies.
155N/A -
155N/A - THE SOFTWARE IS PROVIDED "AS IS" AND INTERNET SOFTWARE CONSORTIUM
155N/A - DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL
155N/A - IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL
155N/A - INTERNET SOFTWARE CONSORTIUM BE LIABLE FOR ANY SPECIAL, DIRECT,
155N/A - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING
155N/A - FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
155N/A - NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION
155N/A - WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
155N/A-->
155N/A
155N/A<!-- $Id: lwres_gabn.html,v 1.4 2001/05/30 20:27:28 bwelling Exp $ -->
155N/A
155N/A<HTML
155N/A><HEAD
155N/A><TITLE
155N/A>lwres_gabn</TITLE
155N/A><META
485N/ANAME="GENERATOR"
485N/ACONTENT="Modular DocBook HTML Stylesheet Version 1.61
277N/A"></HEAD
277N/A><BODY
277N/ACLASS="REFENTRY"
277N/ABGCOLOR="#FFFFFF"
155N/ATEXT="#000000"
155N/ALINK="#0000FF"
155N/AVLINK="#840084"
618N/AALINK="#0000FF"
155N/A><H1
155N/A><A
155N/ANAME="AEN1"
155N/A>lwres_gabn</A
155N/A></H1
155N/A><DIV
155N/ACLASS="REFNAMEDIV"
155N/A><A
155N/ANAME="AEN8"
155N/A></A
215N/A><H2
215N/A>Name</H2
215N/A>lwres_gabnrequest_render, lwres_gabnresponse_render, lwres_gabnrequest_parse, lwres_gabnresponse_parse, lwres_gabnresponse_free, lwres_gabnrequest_free&nbsp;--&nbsp;lightweight resolver getaddrbyname message handling</DIV
215N/A><DIV
215N/ACLASS="REFSYNOPSISDIV"
215N/A><A
215N/ANAME="AEN16"
215N/A></A
215N/A><H2
215N/A>Synopsis</H2
215N/A><DIV
215N/ACLASS="FUNCSYNOPSIS"
215N/A><A
215N/ANAME="AEN17"
215N/A></A
155N/A><P
155N/A></P
155N/A><PRE
155N/ACLASS="FUNCSYNOPSISINFO"
155N/A>#include &lt;lwres/lwres.h&gt;</PRE
155N/A><P
155N/A><CODE
155N/A><CODE
155N/ACLASS="FUNCDEF"
155N/A>lwres_result_t
155N/Alwres_gabnrequest_render</CODE
155N/A>(lwres_context_t *ctx, lwres_gabnrequest_t *req, lwres_lwpacket_t *pkt, lwres_buffer_t *b);</CODE
156N/A></P
156N/A><P
155N/A><CODE
155N/A><CODE
155N/ACLASS="FUNCDEF"
155N/A>lwres_result_t
155N/Alwres_gabnresponse_render</CODE
155N/A>(lwres_context_t *ctx, lwres_gabnresponse_t *req, lwres_lwpacket_t *pkt, lwres_buffer_t *b);</CODE
155N/A></P
155N/A><P
155N/A><CODE
155N/A><CODE
566N/ACLASS="FUNCDEF"
155N/A>lwres_result_t
155N/Alwres_gabnrequest_parse</CODE
155N/A>(lwres_context_t *ctx, lwres_buffer_t *b, lwres_lwpacket_t *pkt, lwres_gabnrequest_t **structp);</CODE
155N/A></P
155N/A><P
155N/A><CODE
155N/A><CODE
155N/ACLASS="FUNCDEF"
155N/A>lwres_result_t
155N/Alwres_gabnresponse_parse</CODE
155N/A>(lwres_context_t *ctx, lwres_buffer_t *b, lwres_lwpacket_t *pkt, lwres_gabnresponse_t **structp);</CODE
155N/A></P
155N/A><P
155N/A><CODE
155N/A><CODE
155N/ACLASS="FUNCDEF"
155N/A>void
155N/Alwres_gabnresponse_free</CODE
155N/A>(lwres_context_t *ctx, lwres_gabnresponse_t **structp);</CODE
155N/A></P
155N/A><P
155N/A><CODE
155N/A><CODE
155N/ACLASS="FUNCDEF"
155N/A>void
155N/Alwres_gabnrequest_free</CODE
155N/A>(lwres_context_t *ctx, lwres_gabnrequest_t **structp);</CODE
155N/A></P
155N/A><P
155N/A></P
155N/A></DIV
181N/A></DIV
155N/A><DIV
155N/ACLASS="REFSECT1"
155N/A><A
155N/ANAME="AEN57"
607N/A></A
607N/A><H2
607N/A>DESCRIPTION</H2
607N/A><P
181N/A>These are low-level routines for creating and parsing
181N/Alightweight resolver name-to-address lookup request and
155N/Aresponse messages.</P
155N/A><P
>There are four main functions for the getaddrbyname opcode.
One render function converts a getaddrbyname request structure &mdash;
<SPAN
CLASS="TYPE"
>lwres_gabnrequest_t</SPAN
> &mdash;
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 &mdash;
<SPAN
CLASS="TYPE"
>lwres_gabnresponse_t</SPAN
> &mdash;
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"
>&lt;lwres/lwres.h&gt;</TT
>.
They are shown below.
<PRE
CLASS="PROGRAMLISTING"
>#define LWRES_OPCODE_GETADDRSBYNAME 0x00010001U
typedef struct lwres_addr lwres_addr_t;
typedef LWRES_LIST(lwres_addr_t) lwres_addrlist_t;
typedef struct {
lwres_uint32_t flags;
lwres_uint32_t addrtypes;
lwres_uint16_t namelen;
char *name;
} lwres_gabnrequest_t;
typedef struct {
lwres_uint32_t flags;
lwres_uint16_t naliases;
lwres_uint16_t naddrs;
char *realname;
char **aliases;
lwres_uint16_t realnamelen;
lwres_uint16_t *aliaslen;
lwres_addrlist_t addrs;
void *base;
size_t baselen;
} lwres_gabnresponse_t;</PRE
></P
><P
><TT
CLASS="FUNCTION"
>lwres_gabnrequest_render()</TT
>
uses resolver context
<TT
CLASS="PARAMETER"
><I
>ctx</I
></TT
>
to convert getaddrbyname request structure
<TT
CLASS="PARAMETER"
><I
>req</I
></TT
>
to canonical format.
The packet header structure
<TT
CLASS="PARAMETER"
><I
>pkt</I
></TT
>
is initialised and transferred to
buffer
<TT
CLASS="PARAMETER"
><I
>b</I
></TT
>.
The contents of
<TT
CLASS="PARAMETER"
><I
>*req</I
></TT
>
are then appended to the buffer in canonical format.
<TT
CLASS="FUNCTION"
>lwres_gabnresponse_render()</TT
>
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
><TT
CLASS="FUNCTION"
>lwres_gabnrequest_parse()</TT
>
uses context
<TT
CLASS="PARAMETER"
><I
>ctx</I
></TT
>
to convert the contents of packet
<TT
CLASS="PARAMETER"
><I
>pkt</I
></TT
>
to a
<SPAN
CLASS="TYPE"
>lwres_gabnrequest_t</SPAN
>
structure.
Buffer
<TT
CLASS="PARAMETER"
><I
>b</I
></TT
>
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
<TT
CLASS="PARAMETER"
><I
>*structp</I
></TT
>.
<TT
CLASS="FUNCTION"
>lwres_gabnresponse_parse()</TT
>
offers the same semantics as
<TT
CLASS="FUNCTION"
>lwres_gabnrequest_parse()</TT
>
except it yields a
<SPAN
CLASS="TYPE"
>lwres_gabnresponse_t</SPAN
>
structure.</P
><P
><TT
CLASS="FUNCTION"
>lwres_gabnresponse_free()</TT
>
and
<TT
CLASS="FUNCTION"
>lwres_gabnrequest_free()</TT
>
release the memory in resolver context
<TT
CLASS="PARAMETER"
><I
>ctx</I
></TT
>
that was allocated to the
<SPAN
CLASS="TYPE"
>lwres_gabnresponse_t</SPAN
>
or
<SPAN
CLASS="TYPE"
>lwres_gabnrequest_t</SPAN
>
structures referenced via
<TT
CLASS="PARAMETER"
><I
>structp</I
></TT
>.
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
<TT
CLASS="FUNCTION"
>lwres_gabnrequest_render()</TT
>,
<TT
CLASS="FUNCTION"
>lwres_gabnresponse_render()</TT
>
<TT
CLASS="FUNCTION"
>lwres_gabnrequest_parse()</TT
>
and
<TT
CLASS="FUNCTION"
>lwres_gabnresponse_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="PARAMETER"
><I
>b</I
></TT
>
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.
<TT
CLASS="FUNCTION"
>lwres_gabnrequest_parse()</TT
>
and
<TT
CLASS="FUNCTION"
>lwres_gabnresponse_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="AEN112"
></A
><H2
>SEE ALSO</H2
><P
><SPAN
CLASS="CITEREFENTRY"
><SPAN
CLASS="REFENTRYTITLE"
>lwres_packet</SPAN
>(3)</SPAN
></P
></DIV
></BODY
></HTML
>