From eb886f120599b2a184db20b527db6dfdfcb7852e Mon Sep 17 00:00:00 2001 From: Yu Jiung Date: Wed, 9 Nov 2016 11:18:45 +0900 Subject: Imported Upstream version 1.11.0 Change-Id: I238c24b75a10aa902d9bc4076ed68b76b5e2a750 --- ares_set_servers.3 | 28 ++++++++++++++++++---------- 1 file changed, 18 insertions(+), 10 deletions(-) (limited to 'ares_set_servers.3') diff --git a/ares_set_servers.3 b/ares_set_servers.3 index 6f25c29..4948f4e 100644 --- a/ares_set_servers.3 +++ b/ares_set_servers.3 @@ -15,12 +15,13 @@ .\" .TH ARES_SET_SERVERS 3 "5 March 2010" .SH NAME -ares_set_servers \- Initialize an ares_channel name servers configuration +ares_set_servers, ares_set_servers_ports \- Initialize an ares_channel name servers configuration .SH SYNOPSIS .nf .B #include .PP .B int ares_set_servers(ares_channel \fIchannel\fP, struct ares_addr_node *\fIservers\fP) +.B int ares_set_servers_ports(ares_channel \fIchannel\fP, struct ares_addr_port_node *\fIservers\fP) .fi .SH DESCRIPTION The \fBares_set_servers(3)\fP function initializes name servers configuration @@ -30,19 +31,25 @@ from a .IR servers pointer to a linked list of ares_addr_node structs holding name servers address data. - +.PP The name server linked list pointer argument may be the result of a previous -call to \fBares_get_servers(3)\fP or a linked list of ares_addr_node structs -setup by other means. - +call to \fBares_get_servers(3)\fP or a linked list of \fBares_addr_node\fP structs +set up by other means. +.PP +The \fBares_set_servers(3)\fP function also allows the specification of UDP and +TCP ports to be used for communication on a per-server basis. The provided +linked list argument may be the result of a previous call to +\fBares_get_servers_ports(3)\fP or a linked list of \fBares_addr_port_node\fP structs +set up by other means. +.PP This function replaces any potentially previously configured name servers with the ones given in the linked list. So, in order to configure a channel -with more than one name server all the desired ones must be specified in a +with more than one name server all the desired ones must be specified in a single list. - -\fBares_set_servers(3)\fP does not take ownership of the linked list argument. +.PP +The function does not take ownership of the linked list argument. The caller is responsible for freeing the linked list when no longer needed. - +.PP This function is capable of handling IPv4 and IPv6 name server addresses simultaneously, rendering \fBares_init_options(3)\fP with optmask \fBARES_OPT_SERVERS\fP functionally obsolete except for @@ -71,7 +78,8 @@ c-ares library initialization not yet performed. .BR ares_init_options (3), .BR ares_dup(3) .SH AVAILABILITY -ares_set_servers(3) was added in c-ares 1.7.1 +\fBares_set_servers(3)\fP was added in c-ares 1.7.1; +\fBares_set_servers_ports(3)\fP was added in c-ares 1.11.0. .SH AUTHOR Implementation of this function and associated library internals are based on code, comments and feedback provided in November and December of 2008 by -- cgit v1.2.3