Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

ares_parse_soa_reply (3)

Name

ares_parse_soa_reply - Parse a reply to a DNS query of type SOA

Synopsis

#include <ares.h>

int ares_parse_soa_reply(const unsigned char* abuf, int alen,
struct ares_soa_reply** soa_out);

Description

ARES_PARSE_SOA_REPLY(3)    Library Functions Manual    ARES_PARSE_SOA_REPLY(3)



NAME
       ares_parse_soa_reply - Parse a reply to a DNS query of type SOA

SYNOPSIS
       #include <ares.h>

       int ares_parse_soa_reply(const unsigned char* abuf, int alen,
                      struct ares_soa_reply** soa_out);

DESCRIPTION
       The  ares_parse_soa_reply  function  parses  the response to a query of
       type SOA into a struct ares_soa_reply.  The parameters  abuf  and  alen
       give  the  contents of the response.  The result is stored in allocated
       memory and a pointer to it stored  into  the  variable  pointed  to  by
       soa_out.   It  is  the  caller's  responsibility  to free the resulting
       soa_out structure when it  is  no  longer  needed  using  the  function
       ares_free_data

       The structure ares_soa_reply contains the following fields:

           struct ares_soa_reply {
                char *nsname;
                char *hostmaster;
                unsigned int serial;
                unsigned int refresh;
                unsigned int retry;
                unsigned int expire;
                unsigned int minttl;
           };

RETURN VALUES
       ares_parse_soa_reply can return any of the following values:

       ARES_SUCCESS   The response was successfully parsed.

       ARES_EBADRESP  The response was malformatted.

       ARES_ENODATA   The response did not contain an answer to the query.

       ARES_ENOMEM    Memory was exhausted.

AVAILABILITY
       This function was first introduced in c-ares version 1.9.0.


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+------------------+
       |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
       +---------------+------------------+
       |Availability   | library/libcares |
       +---------------+------------------+
       |Stability      | Volatile         |
       +---------------+------------------+

SEE ALSO
       ares_query(3) ares_free_data(3)



NOTES
       Source  code  for open source software components in Oracle Solaris can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       This     software     was    built    from    source    available    at
       https://github.com/oracle/solaris-userland.   The  original   community
       source    was   downloaded   from    https://c-ares.haxx.se/download/c-
       ares-1.17.2.tar.gz.

       Further information about this software can be found on the open source
       community website at https://c-ares.haxx.se/.



                                  29 May 2012          ARES_PARSE_SOA_REPLY(3)