From f72779cc7af04498e2f670fa485bcfec81d7dc60 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mattias=20R=C3=B6nnblom?= Date: Tue, 7 Feb 2023 17:05:21 +0100 Subject: [PATCH] Improve DNS timeout socket attribute documentation MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Note in the API documentation that "dns.timeout" may only be set/written-to at the time of the xcm_connect_a() call (i.e., passed as one of the attributes in the map) to establish a new connection. Signed-off-by: Mattias Rönnblom --- include/xcm.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/include/xcm.h b/include/xcm.h index e934785b3..5f5f7233b 100644 --- a/include/xcm.h +++ b/include/xcm.h @@ -930,7 +930,7 @@ extern "C" { * tcp.keepalive_count | Connection | Integer | RW | The number of keepalive probes sent before the connection is dropped. The default value is 3. * tcp.user_timeout | Connection | Integer | RW | The time (in s) before a connection is dropped due to unacknowledged data. The default value is 3 s. * ipv6.scope | All | Integer | RW | The IPv6 scope id used. Only available on IPv6 sockets. Writable only at socket creation. If left unset, it will take on the value of 0 (the global scope). Any other value denotes the network interface index to be used, for IPv6 link local addresses. See the if_nametoindex(3) manual page for how to map interface names to indices. - * dns.timeout | Connection | Double | RW | The number of seconds until DNS times out. The timeout covers the complete DNS resolution process (as opposed to a particular query/response transaction to a particular transaction). Only available when the library is built with the c-ares DNS resolver. + * dns.timeout | Connection | Double | RW | The number of seconds until DNS times out. Writable only at the time of the xcm_connect_a() call. The timeout covers the complete DNS resolution process (as opposed to a particular query/response transaction to a particular transaction). Only available when the library is built with the c-ares DNS resolver. * * @warning @c tcp.segs_in and @c tcp.segs_out are only present when * running XCM on Linux kernel 4.2 or later.