ares_parse_soa_reply(3)

ares_parse_soa_reply3

Parse a reply to a dns query of type soa

Usage

#include <ares.h>
int ares_parse_soa_reply(const unsigned char* abuf, int alen,
                         struct ares_soa_reply** soa_out);

Overview

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(3).

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.

Releases

8 releases since Debian 7 (Wheezy); the text changed 1 time.

  1. 7–12
  2. 13–Arch

Availability

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

From c-ares 1.34.9-1 in Arch Linux 2026-11-01. Parsed by carta from the page's man source.