lwres/man/lwres_resutil.html

	lwres_resutil.html revision ddccd5811feff696ba460dabfb666ce61040f545
0N/A<!--
157N/A - Copyright (C) 2000, 2001  Internet Software Consortium.
0N/A -
0N/A - Permission to use, copy, modify, and distribute this software for any
0N/A - purpose with or without fee is hereby granted, provided that the above
0N/A - copyright notice and this permission notice appear in all copies.
157N/A -
0N/A - THE SOFTWARE IS PROVIDED "AS IS" AND INTERNET SOFTWARE CONSORTIUM
157N/A - DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL
0N/A - IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL
0N/A - INTERNET SOFTWARE CONSORTIUM BE LIABLE FOR ANY SPECIAL, DIRECT,
0N/A - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING
0N/A - FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
0N/A - NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION
0N/A - WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
0N/A-->
0N/A<HTML
0N/A><HEAD
0N/A><TITLE
0N/A>lwres_resutil</TITLE
157N/A><META
157N/ANAME="GENERATOR"
157N/ACONTENT="Modular DocBook HTML Stylesheet Version 1.61
0N/A"></HEAD
0N/A><BODY
0N/ACLASS="REFENTRY"
0N/ABGCOLOR="#FFFFFF"
0N/ATEXT="#000000"
0N/ALINK="#0000FF"
0N/AVLINK="#840084"
0N/AALINK="#0000FF"
0N/A><H1
0N/A><A
0N/ANAME="AEN1"
0N/A>lwres_resutil</A
0N/A></H1
0N/A><DIV
0N/ACLASS="REFNAMEDIV"
0N/A><A
0N/ANAME="AEN8"
0N/A></A
0N/A><H2
0N/A>Name</H2
0N/A>lwres_string_parse, lwres_addr_parse, lwres_getaddrsbyname, lwres_getnamebyaddr&nbsp;--&nbsp;lightweight resolver utility functions</DIV
0N/A><DIV
0N/ACLASS="REFSYNOPSISDIV"
0N/A><A
0N/ANAME="AEN14"
0N/A></A
0N/A><H2
0N/A>Synopsis</H2
0N/A><DIV
0N/ACLASS="FUNCSYNOPSIS"
0N/A><A
0N/ANAME="AEN15"
0N/A></A
0N/A><P
0N/A></P
0N/A><PRE
0N/ACLASS="FUNCSYNOPSISINFO"
0N/A>#include &lt;lwres/lwres.h&gt;</PRE
0N/A><P
0N/A><CODE
0N/A><CODE
0N/ACLASS="FUNCDEF"
0N/A>lwres_result_t
0N/Alwres_string_parse</CODE
0N/A>(lwres_buffer_t *b, char **c, lwres_uint16_t *len);</CODE
0N/A></P
0N/A><P
0N/A><CODE
0N/A><CODE
0N/ACLASS="FUNCDEF"
0N/A>lwres_result_t
0N/Alwres_addr_parse</CODE
0N/A>(lwres_buffer_t *b, lwres_addr_t *addr);</CODE
0N/A></P
0N/A><P
0N/A><CODE
0N/A><CODE
0N/ACLASS="FUNCDEF"
0N/A>lwres_result_t
0N/Alwres_getaddrsbyname</CODE
0N/A>(lwres_context_t *ctx, const char *name, lwres_uint32_t addrtypes, lwres_gabnresponse_t **structp);</CODE
0N/A></P
0N/A><P
0N/A><CODE
0N/A><CODE
0N/ACLASS="FUNCDEF"
0N/A>lwres_result_t
0N/Alwres_getnamebyaddr</CODE
0N/A>(lwres_context_t *ctx, lwres_uint32_t addrtype, lwres_uint16_t addrlen, const unsigned char *addr, lwres_gnbaresponse_t **structp);</CODE
0N/A></P
0N/A><P
0N/A></P
0N/A></DIV
0N/A></DIV
0N/A><DIV
0N/ACLASS="REFSECT1"
0N/A><A
0N/ANAME="AEN43"
0N/A></A
0N/A><H2
0N/A>DESCRIPTION</H2
0N/A><P
0N/A><TT
0N/ACLASS="FUNCTION"
0N/A>lwres_string_parse()</TT
0N/A>
0N/Aretrieves a DNS-encoded string starting the current pointer of
0N/Alightweight resolver buffer
0N/A<TT
0N/ACLASS="PARAMETER"
0N/A><I
0N/A>b</I
0N/A></TT
0N/A>:
0N/A
0N/Ai.e.
0N/A<TT
0N/ACLASS="CONSTANT"
0N/A>b-&gt;current</TT
0N/A>.
0N/A
0N/AWhen the function returns, the address of the first byte of the
0N/Aencoded string is returned via
0N/A<TT
0N/ACLASS="PARAMETER"
0N/A><I
0N/A>*c</I
0N/A></TT
0N/A>
0N/Aand the length of that string is given by
0N/A<TT
0N/ACLASS="PARAMETER"
0N/A><I
0N/A>*len</I
0N/A></TT
0N/A>.
0N/A
0N/AThe buffer's current pointer is advanced to point at the character
0N/Afollowing the string length, the encoded string, and the trailing
0N/A<SPAN
0N/ACLASS="TYPE"
0N/A>NULL</SPAN
0N/A>
0N/Acharacter.
0N/A<TT
0N/ACLASS="FUNCTION"
0N/A>lwres_string_parse()</TT
0N/A>
0N/Ahas an assertion check that
0N/A<TT
0N/ACLASS="PARAMETER"
0N/A><I
0N/A>b</I
0N/A></TT
0N/A>
0N/Ais not
0N/A<SPAN
0N/ACLASS="TYPE"
0N/A>NULL</SPAN
0N/A>.&#13;</P
0N/A><P
0N/A><TT
0N/ACLASS="FUNCTION"
0N/A>lwres_addr_parse()</TT
0N/A>
0N/Aextracts an address from the buffer
0N/A<TT
CLASS="PARAMETER"
><I
>b</I
></TT
>.

It checks that
<TT
CLASS="PARAMETER"
><I
>addr</I
></TT
>
is not null.
The buffer's current pointer
<TT
CLASS="CONSTANT"
>b-&gt;current</TT
>
is presumed to point at an encoded address: the address preceded by a
32-bit protocol family identifier and a 16-bit length field.
The encoded address is copied to
<TT
CLASS="CONSTANT"
>addr-&gt;address</TT
>
and
<TT
CLASS="CONSTANT"
>addr-&gt;length</TT
>
indicates the size in bytes of the address that was copied.
<TT
CLASS="CONSTANT"
>b-&gt;current</TT
>
is advanced to point at the next byte of available data in the buffer
following the encoded address.</P
><P
><TT
CLASS="FUNCTION"
>lwres_getaddrsbyname()</TT
>
and
<TT
CLASS="FUNCTION"
>lwres_getnamebyaddr()</TT
>
use the
<SPAN
CLASS="TYPE"
>lwres_gnbaresponse_t</SPAN
>
structure defined below:
<PRE
CLASS="PROGRAMLISTING"
>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
>
The contents of this structure are not manipulated directly but
they are controlled through the
<SPAN
CLASS="CITEREFENTRY"
><SPAN
CLASS="REFENTRYTITLE"
>lwres_gabn</SPAN
>(3)</SPAN
>
functions.</P
><P
>The lightweight resolver uses
<TT
CLASS="FUNCTION"
>lwres_getaddrsbyname()</TT
>
to perform foward lookups.
Hostname
<TT
CLASS="PARAMETER"
><I
>name</I
></TT
>
is looked up using the resolver context
<TT
CLASS="PARAMETER"
><I
>ctx</I
></TT
>
for memory allocation.
<TT
CLASS="PARAMETER"
><I
>addrtypes</I
></TT
>
is a bitmask indicating which type of addresses are to be looked up.
Current values for this bitmask are
<SPAN
CLASS="TYPE"
>LWRES_ADDRTYPE_V4</SPAN
>
for IPv4 addresses and
<SPAN
CLASS="TYPE"
>LWRES_ADDRTYPE_V6</SPAN
>
for IPv6 addresses.
Results of the lookup are returned in
<TT
CLASS="PARAMETER"
><I
>*structp</I
></TT
>.

<TT
CLASS="FUNCTION"
>lwres_getaddrsbyname()</TT
>
checks that its pointer arguments are not
<SPAN
CLASS="TYPE"
>NULL</SPAN
>
and that
<TT
CLASS="PARAMETER"
><I
>addrtypes</I
></TT
>
is non-zero.</P
><P
><TT
CLASS="FUNCTION"
>lwres_getnamebyaddr()</TT
>
performs reverse lookups.
Resolver context
<TT
CLASS="PARAMETER"
><I
>ctx</I
></TT
>
is used for memory allocation.
The address type is indicated by
<TT
CLASS="PARAMETER"
><I
>addrtype</I
></TT
>:

<SPAN
CLASS="TYPE"
>LWRES_ADDRTYPE_V4</SPAN
>
or
<SPAN
CLASS="TYPE"
>LWRES_ADDRTYPE_V6</SPAN
>.

The address to be looked up is given by
<TT
CLASS="PARAMETER"
><I
>addr</I
></TT
>
and its length is
<TT
CLASS="PARAMETER"
><I
>addrlen</I
></TT
>
bytes.
The result of the function call is made available through
<TT
CLASS="PARAMETER"
><I
>*structp</I
></TT
>.

Like
<TT
CLASS="FUNCTION"
>lwres_getaddrsbyname()</TT
>,

<TT
CLASS="FUNCTION"
>lwres_getnamebyaddr()</TT
>
uses assertion checking to ensure its pointer arguments are not
<SPAN
CLASS="TYPE"
>NULL</SPAN
>
and
<TT
CLASS="PARAMETER"
><I
>addrtype</I
></TT
>
is not zero.
<TT
CLASS="FUNCTION"
>lwres_getaddrsbyname()</TT
>
also checks that
<TT
CLASS="PARAMETER"
><I
>addrlen</I
></TT
>
is non-zero.</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN97"
></A
><H2
>RETURN VALUES</H2
><P
>Successful calls to
<TT
CLASS="FUNCTION"
>lwres_string_parse()</TT
>
and
<TT
CLASS="FUNCTION"
>lwres_addr_parse()</TT
>
return
<SPAN
CLASS="ERRORCODE"
>LWRES_R_SUCCESS.</SPAN
>
Both functions return
<SPAN
CLASS="ERRORCODE"
>LWRES_R_FAILURE</SPAN
>
if the buffer is corrupt or
<SPAN
CLASS="ERRORCODE"
>LWRES_R_UNEXPECTEDEND</SPAN
>
if the buffer has less space than expected for the components of the
encoded string or address.</P
><P
><TT
CLASS="FUNCTION"
>lwres_getaddrsbyname()</TT
>
returns
<SPAN
CLASS="ERRORCODE"
>LWRES_R_SUCCESS</SPAN
>
on success and it returns
<SPAN
CLASS="ERRORCODE"
>LWRES_R_NOTFOUND</SPAN
>
if the hostname
<TT
CLASS="PARAMETER"
><I
>name</I
></TT
>
could not be found.</P
><P
><SPAN
CLASS="ERRORCODE"
>LWRES_R_SUCCESS</SPAN
>
is returned by a successful call to
<TT
CLASS="FUNCTION"
>lwres_getnamebyaddr()</TT
>.&#13;</P
><P
>Both
<TT
CLASS="FUNCTION"
>lwres_getaddrsbyname()</TT
>
and
<TT
CLASS="FUNCTION"
>lwres_getnamebyaddr()</TT
>
return
<SPAN
CLASS="ERRORCODE"
>LWRES_R_NOMEMORY</SPAN
>
when memory allocation requests fail and
<SPAN
CLASS="ERRORCODE"
>LWRES_R_UNEXPECTEDEND</SPAN
>
if the buffers used for sending queries and receiving replies are too
small.</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN118"
></A
><H2
>SEE ALSO</H2
><P
><SPAN
CLASS="CITEREFENTRY"
><SPAN
CLASS="REFENTRYTITLE"
>lwres_buffer</SPAN
>(3)</SPAN
>,

<SPAN
CLASS="CITEREFENTRY"
><SPAN
CLASS="REFENTRYTITLE"
>lwres_gabn</SPAN
>(3)</SPAN
>.</P
></DIV
></BODY
></HTML
>