0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews - Copyright (C) 2000, 2001, 2004, 2005, 2007, 2014-2016 Internet Systems Consortium, Inc. ("ISC")
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews - This Source Code Form is subject to the terms of the Mozilla Public
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews - License, v. 2.0. If a copy of the MPL was not distributed with this
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews - file, You can obtain one at http://mozilla.org/MPL/2.0/.
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt<!-- Converted by db4-upgrade version 1.0 -->
83a28ca274521e15086fc39febde507bcc4e145eMark Andrews<refentry xmlns:db="http://docbook.org/ns/docbook" version="5.0">
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <refentryinfo>
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt <corpauthor>Internet Systems Consortium, Inc.</corpauthor>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </refentryinfo>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <refentrytitle>lwres_getrrsetbyname</refentrytitle>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </copyright>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <refnamediv>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </refnamediv>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <refsynopsisdiv>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <funcsynopsis>
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson<funcsynopsisinfo>#include <lwres/netdb.h></funcsynopsisinfo>
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson<funcprototype>
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson<function>lwres_getrrsetbyname</function></funcdef>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <paramdef>const char *<parameter>hostname</parameter></paramdef>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <paramdef>unsigned int <parameter>rdclass</parameter></paramdef>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <paramdef>unsigned int <parameter>rdtype</parameter></paramdef>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <paramdef>unsigned int <parameter>flags</parameter></paramdef>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <paramdef>struct rrsetinfo **<parameter>res</parameter></paramdef>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </funcprototype>
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson<funcprototype>
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson<function>lwres_freerrset</function></funcdef>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <paramdef>struct rrsetinfo *<parameter>rrset</parameter></paramdef>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </funcprototype>
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson</funcsynopsis>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein The following structures are used:
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafssonstruct rdatainfo {
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson unsigned int rdi_length; /* length of data */
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson unsigned char *rdi_data; /* record data */
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein</programlisting>
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafssonstruct rrsetinfo {
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson unsigned int rri_flags; /* RRSET_VALIDATED... */
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson unsigned int rri_rdclass; /* class number */
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson unsigned int rri_rdtype; /* RR type number */
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson unsigned int rri_ttl; /* time to live */
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson unsigned int rri_nrdatas; /* size of rdatas array */
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson unsigned int rri_nsigs; /* size of sigs array */
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson char *rri_name; /* canonical name */
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson struct rdatainfo *rri_rdatas; /* individual records */
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson struct rdatainfo *rri_sigs; /* individual signatures */
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson</programlisting>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </refsynopsisdiv>
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt <refsection><info><title>DESCRIPTION</title></info>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <para><function>lwres_getrrsetbyname()</function>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein gets a set of resource records associated with a
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <parameter>hostname</parameter>, <parameter>class</parameter>,
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <parameter>hostname</parameter> is a pointer a to
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein null-terminated string. The <parameter>flags</parameter> field
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein is currently unused and must be zero.
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein After a successful call to
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <type>rrsetinfo</type> structure, containing a list of one or
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein more <type>rdatainfo</type> structures containing resource
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein records and potentially another list of <type>rdatainfo</type>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein structures containing SIG resource records associated with those
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein records. The members <constant>rri_rdclass</constant> and
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <constant>rri_rdtype</constant> are copied from the parameters.
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <constant>rri_ttl</constant> and <constant>rri_name</constant>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein are properties of the obtained rrset. The resource records
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein contained in <constant>rri_rdatas</constant> and
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <constant>rri_sigs</constant> are in uncompressed DNS wire
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein format. Properties of the rdataset are represented in the
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <constant>rri_flags</constant> bitfield. If the RRSET_VALIDATED
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein bit is set, the data has been DNSSEC validated and the
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein signatures verified.
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein All of the information returned by
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <function>lwres_getrrsetbyname()</function> is dynamically
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein allocated: the <constant>rrsetinfo</constant> and
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <constant>rdatainfo</constant> structures, and the canonical
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein host name strings pointed to by the
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein Memory allocated for the dynamically allocated structures
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein created by a successful call to
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <function>lwres_getrrsetbyname()</function> is released by
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <parameter>rrset</parameter> is a pointer to a <type>struct
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein rrset</type> created by a call to
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt </refsection>
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt <refsection><info><title>RETURN VALUES</title></info>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <para><function>lwres_getrrsetbyname()</function>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein returns zero on success, and one of the following error codes if
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein an error occurred:
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <variablelist>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <varlistentry>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein the name does not exist
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </varlistentry>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <varlistentry>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein the name exists, but does not have data of the desired type
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </varlistentry>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <varlistentry>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <term><constant>ERRSET_NOMEMORY</constant></term>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein memory could not be allocated
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </varlistentry>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <varlistentry>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein a parameter is invalid
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </varlistentry>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <varlistentry>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein other failure
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </varlistentry>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <varlistentry>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </varlistentry>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </variablelist>
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt </refsection>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <refentrytitle>lwres</refentrytitle><manvolnum>3</manvolnum>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </citerefentry>.
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt </refsection>