diff options
Diffstat (limited to 'docs/ares_init_options.3')
| -rw-r--r-- | docs/ares_init_options.3 | 61 |
1 files changed, 40 insertions, 21 deletions
diff --git a/docs/ares_init_options.3 b/docs/ares_init_options.3 index b9d52a8..46a45e9 100644 --- a/docs/ares_init_options.3 +++ b/docs/ares_init_options.3 @@ -14,6 +14,8 @@ .\" this software for any purpose. It is provided "as is" .\" without express or implied warranty. .\" +.\" SPDX-License-Identifier: MIT +.\" .TH ARES_INIT 3 "5 March 2010" .SH NAME ares_init_options \- Initialize a resolver channel @@ -41,6 +43,8 @@ struct ares_options { int nsort; int ednspsz; char *resolvconf_path; + char *hosts_path; + int udp_max_queries; }; int ares_init_options(ares_channel *\fIchannelptr\fP, @@ -70,7 +74,7 @@ description of possible flag values. The number of seconds each name server is given to respond to a query on the first try. (After the first try, the timeout algorithm becomes more complicated, but scales linearly with the value of \fItimeout\fP.) The -default is five seconds. This option is being deprecated by +default is two seconds. This option is being deprecated by \fIARES_OPT_TIMEOUTMS\fP starting in c-ares 1.5.2. .TP 18 .B ARES_OPT_TIMEOUTMS @@ -79,7 +83,7 @@ default is five seconds. This option is being deprecated by The number of milliseconds each name server is given to respond to a query on the first try. (After the first try, the timeout algorithm becomes more complicated, but scales linearly with the value of \fItimeout\fP.) The -default is five seconds. Note that this option is specified with the same +default is two seconds. Note that this option is specified with the same struct field as the former \fIARES_OPT_TIMEOUT\fP, it is but the option bits that tell c-ares how to interpret the number. This option was added in c-ares 1.5.2. @@ -88,7 +92,7 @@ that tell c-ares how to interpret the number. This option was added in c-ares .B int \fItries\fP; .br The number of tries the resolver will try contacting each name server -before giving up. The default is four tries. +before giving up. The default is three tries. .TP 18 .B ARES_OPT_NDOTS .B int \fIndots\fP; @@ -101,16 +105,14 @@ resolv.conf or the RES_OPTIONS environment variable. .B ARES_OPT_UDP_PORT .B unsigned short \fIudp_port\fP; .br -The port to use for queries over UDP, in network byte order. -The default value is 53 (in network byte order), the standard name -service port. +The port to use for queries over UDP, in host byte order. +The default value is 53, the standard name service port. .TP 18 .B ARES_OPT_TCP_PORT .B unsigned short \fItcp_port\fP; .br -The port to use for queries over TCP, in network byte order. -The default value is 53 (in network byte order), the standard name -service port. +The port to use for queries over TCP, in host byte order. +The default value is 53, the standard name service port. .TP 18 .B ARES_OPT_SERVERS .B struct in_addr *\fIservers\fP; @@ -118,10 +120,9 @@ service port. .B int \fInservers\fP; .br The list of IPv4 servers to contact, instead of the servers specified in -resolv.conf or the local named. In order to allow specification of either -IPv4 or IPv6 name servers, the -.BR ares_set_servers(3) -function must be used instead. +resolv.conf or the local named. In order to allow specification of either IPv4 +or IPv6 name servers, the \Bares_set_servers(3)\fP function must be used +instead. .TP 18 .B ARES_OPT_DOMAINS .B char **\fIdomains\fP; @@ -195,6 +196,24 @@ should be set to a path string, and will be honoured on *nix like systems. The default is .B /etc/resolv.conf .br +.TP 18 +.B ARES_OPT_HOSTS_FILE +.B char *\fIhosts_path\fP; +.br +The path to use for reading the hosts file. The +.I hosts_path +should be set to a path string, and will be honoured on *nix like systems. The +default is +.B /etc/hosts +.br +.TP 18 +.B ARES_OPT_UDP_MAX_QUERIES +.B int \fIudp_max_queries\fP; +.br +The maximum number of udp queries that can be sent on a single ephemeral port +to a given DNS server before a new ephemeral port is assigned. Any value of 0 +or less will be considered unlimited, and is the default. +.br .PP The \fIoptmask\fP parameter also includes options without a corresponding field in the @@ -274,19 +293,19 @@ When initializing from path location) \fBares_init_options(3)\fP reads the \fIdomain\fP and \fIsearch\fP directives to allow lookups of short names relative to the domains specified. The -\fIdomain\fP and \fIsearch\fP directives override one another. If more that +\fIdomain\fP and \fIsearch\fP directives override one another. If more than one instance of either \fIdomain\fP or \fIsearch\fP directives is specified, the last occurrence wins. For more information, please see the .BR resolv.conf (5) manual page. .SH SEE ALSO -.BR ares_init(3), -.BR ares_destroy(3), -.BR ares_dup(3), -.BR ares_library_init(3), -.BR ares_save_options(3), -.BR ares_set_servers(3), -.BR ares_set_sortlist(3) +.BR ares_init (3), +.BR ares_destroy (3), +.BR ares_dup (3), +.BR ares_library_init (3), +.BR ares_save_options (3), +.BR ares_set_servers (3), +.BR ares_set_sortlist (3) .SH AUTHOR Greg Hudson, MIT Information Systems .br |