lwres_resutil.html revision 8de7014e56565605a51898a2a33a8b08fd3f1e57
d4ef65050feac78554addf6e16a06c6e2e0bd331Brian Wellington - Copyright (C) 2000, 2001 Internet Software Consortium.
d4ef65050feac78554addf6e16a06c6e2e0bd331Brian Wellington - Permission to use, copy, modify, and distribute this software for any
d4ef65050feac78554addf6e16a06c6e2e0bd331Brian Wellington - purpose with or without fee is hereby granted, provided that the above
d4ef65050feac78554addf6e16a06c6e2e0bd331Brian Wellington - copyright notice and this permission notice appear in all copies.
d4ef65050feac78554addf6e16a06c6e2e0bd331Brian Wellington - THE SOFTWARE IS PROVIDED "AS IS" AND INTERNET SOFTWARE CONSORTIUM
d4ef65050feac78554addf6e16a06c6e2e0bd331Brian Wellington - DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL
dafcb997e390efa4423883dafd100c975c4095d6Mark Andrews - IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL
dafcb997e390efa4423883dafd100c975c4095d6Mark Andrews - INTERNET SOFTWARE CONSORTIUM BE LIABLE FOR ANY SPECIAL, DIRECT,
dafcb997e390efa4423883dafd100c975c4095d6Mark Andrews - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING
dafcb997e390efa4423883dafd100c975c4095d6Mark Andrews - FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
dafcb997e390efa4423883dafd100c975c4095d6Mark Andrews - NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION
dafcb997e390efa4423883dafd100c975c4095d6Mark Andrews - WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
94bd918b63001277f1b28ae4581645f8a835688fBob Halley>lwres_resutil</TITLE
94bd918b63001277f1b28ae4581645f8a835688fBob HalleyNAME="GENERATOR"
94bd918b63001277f1b28ae4581645f8a835688fBob HalleyCONTENT="Modular DocBook HTML Stylesheet Version 1.61
94bd918b63001277f1b28ae4581645f8a835688fBob HalleyCLASS="REFENTRY"
94bd918b63001277f1b28ae4581645f8a835688fBob HalleyBGCOLOR="#FFFFFF"
94bd918b63001277f1b28ae4581645f8a835688fBob HalleyTEXT="#000000"
94bd918b63001277f1b28ae4581645f8a835688fBob HalleyLINK="#0000FF"
94bd918b63001277f1b28ae4581645f8a835688fBob HalleyVLINK="#840084"
94bd918b63001277f1b28ae4581645f8a835688fBob HalleyALINK="#0000FF"
94bd918b63001277f1b28ae4581645f8a835688fBob Halley>lwres_resutil</A
94bd918b63001277f1b28ae4581645f8a835688fBob HalleyCLASS="REFNAMEDIV"
94bd918b63001277f1b28ae4581645f8a835688fBob Halley>lwres_string_parse, lwres_addr_parse, lwres_getaddrsbyname, lwres_getnamebyaddr -- lightweight resolver utility functions</DIV
94bd918b63001277f1b28ae4581645f8a835688fBob HalleyCLASS="REFSYNOPSISDIV"
94bd918b63001277f1b28ae4581645f8a835688fBob Halley>Synopsis</H2
94bd918b63001277f1b28ae4581645f8a835688fBob HalleyCLASS="FUNCSYNOPSIS"
94bd918b63001277f1b28ae4581645f8a835688fBob HalleyCLASS="FUNCSYNOPSISINFO"
94bd918b63001277f1b28ae4581645f8a835688fBob HalleyCLASS="FUNCDEF"
94bd918b63001277f1b28ae4581645f8a835688fBob Halley>lwres_result_t
94bd918b63001277f1b28ae4581645f8a835688fBob Halleylwres_string_parse</CODE
94bd918b63001277f1b28ae4581645f8a835688fBob Halley>(lwres_buffer_t *b, char **c, lwres_uint16_t *len);</CODE
94bd918b63001277f1b28ae4581645f8a835688fBob HalleyCLASS="FUNCDEF"
94bd918b63001277f1b28ae4581645f8a835688fBob Halley>lwres_result_t
94bd918b63001277f1b28ae4581645f8a835688fBob Halleylwres_addr_parse</CODE
94bd918b63001277f1b28ae4581645f8a835688fBob Halley>(lwres_buffer_t *b, lwres_addr_t *addr);</CODE
94bd918b63001277f1b28ae4581645f8a835688fBob HalleyCLASS="FUNCDEF"
94bd918b63001277f1b28ae4581645f8a835688fBob Halley>lwres_result_t
94bd918b63001277f1b28ae4581645f8a835688fBob Halleylwres_getaddrsbyname</CODE
94bd918b63001277f1b28ae4581645f8a835688fBob Halley>(lwres_context_t *ctx, const char *name, lwres_uint32_t addrtypes, lwres_gabnresponse_t **structp);</CODE
7389e8330d62a059b8923fb8ca6f933caeb559d9Mark AndrewsCLASS="FUNCDEF"
7389e8330d62a059b8923fb8ca6f933caeb559d9Mark Andrews>lwres_result_t
7389e8330d62a059b8923fb8ca6f933caeb559d9Mark Andrewslwres_getnamebyaddr</CODE
7389e8330d62a059b8923fb8ca6f933caeb559d9Mark Andrews>(lwres_context_t *ctx, lwres_uint32_t addrtype, lwres_uint16_t addrlen, const unsigned char *addr, lwres_gnbaresponse_t **structp);</CODE
94bd918b63001277f1b28ae4581645f8a835688fBob HalleyCLASS="REFSECT1"
94bd918b63001277f1b28ae4581645f8a835688fBob Halley>DESCRIPTION</H2
94bd918b63001277f1b28ae4581645f8a835688fBob HalleyCLASS="FUNCTION"
94bd918b63001277f1b28ae4581645f8a835688fBob Halley>lwres_string_parse()</TT
f8644da8d948dbc973f6dd4c94a79774e16ec07bDavid Lawrenceretrieves a DNS-encoded string starting the current pointer of
94bd918b63001277f1b28ae4581645f8a835688fBob Halleylightweight resolver buffer
94bd918b63001277f1b28ae4581645f8a835688fBob HalleyCLASS="PARAMETER"
94bd918b63001277f1b28ae4581645f8a835688fBob HalleyCLASS="CONSTANT"
94bd918b63001277f1b28ae4581645f8a835688fBob Halley>b->current</TT
94bd918b63001277f1b28ae4581645f8a835688fBob HalleyWhen the function returns, the address of the first byte of the
94bd918b63001277f1b28ae4581645f8a835688fBob Halleyencoded string is returned via
94bd918b63001277f1b28ae4581645f8a835688fBob HalleyCLASS="PARAMETER"
7389e8330d62a059b8923fb8ca6f933caeb559d9Mark Andrewsand the length of that string is given by
7389e8330d62a059b8923fb8ca6f933caeb559d9Mark AndrewsCLASS="PARAMETER"
94bd918b63001277f1b28ae4581645f8a835688fBob HalleyThe buffer's current pointer is advanced to point at the character
7389e8330d62a059b8923fb8ca6f933caeb559d9Mark Andrewsfollowing the string length, the encoded string, and the trailing
94bd918b63001277f1b28ae4581645f8a835688fBob HalleyCLASS="FUNCTION"
94bd918b63001277f1b28ae4581645f8a835688fBob Halley>lwres_string_parse()</TT
94bd918b63001277f1b28ae4581645f8a835688fBob Halleyhas an assertion check that
94bd918b63001277f1b28ae4581645f8a835688fBob HalleyCLASS="PARAMETER"
f8644da8d948dbc973f6dd4c94a79774e16ec07bDavid LawrenceCLASS="FUNCTION"
94bd918b63001277f1b28ae4581645f8a835688fBob Halley>lwres_addr_parse()</TT
f8644da8d948dbc973f6dd4c94a79774e16ec07bDavid Lawrenceextracts an address from the buffer
f8644da8d948dbc973f6dd4c94a79774e16ec07bDavid LawrenceCLASS="PARAMETER"
94bd918b63001277f1b28ae4581645f8a835688fBob HalleyIt checks that
f8644da8d948dbc973f6dd4c94a79774e16ec07bDavid LawrenceCLASS="PARAMETER"
94bd918b63001277f1b28ae4581645f8a835688fBob HalleyThe buffer's current pointer
94bd918b63001277f1b28ae4581645f8a835688fBob HalleyCLASS="CONSTANT"
94bd918b63001277f1b28ae4581645f8a835688fBob Halley>b->current</TT
94bd918b63001277f1b28ae4581645f8a835688fBob Halleyis presumed to point at an encoded address: the address preceded by a
94bd918b63001277f1b28ae4581645f8a835688fBob Halley32-bit protocol family identifier and a 16-bit length field.
94bd918b63001277f1b28ae4581645f8a835688fBob HalleyThe encoded address is copied to
94bd918b63001277f1b28ae4581645f8a835688fBob HalleyCLASS="CONSTANT"
94bd918b63001277f1b28ae4581645f8a835688fBob Halley>addr->address</TT
94bd918b63001277f1b28ae4581645f8a835688fBob HalleyCLASS="CONSTANT"
94bd918b63001277f1b28ae4581645f8a835688fBob Halley>addr->length</TT
f8644da8d948dbc973f6dd4c94a79774e16ec07bDavid Lawrenceindicates the size in bytes of the address that was copied.
94bd918b63001277f1b28ae4581645f8a835688fBob HalleyCLASS="CONSTANT"
94bd918b63001277f1b28ae4581645f8a835688fBob Halley>b->current</TT
94bd918b63001277f1b28ae4581645f8a835688fBob Halleyis advanced to point at the next byte of available data in the buffer
94bd918b63001277f1b28ae4581645f8a835688fBob Halleyfollowing the encoded address.</P
94bd918b63001277f1b28ae4581645f8a835688fBob HalleyCLASS="FUNCTION"
94bd918b63001277f1b28ae4581645f8a835688fBob Halley>lwres_getaddrsbyname()</TT
17cb8353e999e3294e6619613f401af3f7b1540cMark AndrewsCLASS="FUNCTION"
94bd918b63001277f1b28ae4581645f8a835688fBob Halley>lwres_getnamebyaddr()</TT
94bd918b63001277f1b28ae4581645f8a835688fBob Halley>lwres_gnbaresponse_t</SPAN
94bd918b63001277f1b28ae4581645f8a835688fBob Halleystructure defined below:
94bd918b63001277f1b28ae4581645f8a835688fBob HalleyCLASS="PROGRAMLISTING"
94bd918b63001277f1b28ae4581645f8a835688fBob Halley>typedef struct {