Skip to content

Commit

Permalink
Improve DNS timeout socket attribute documentation
Browse files Browse the repository at this point in the history
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 <[email protected]>
  • Loading branch information
m-ronnblom committed Feb 7, 2023
1 parent 93f4776 commit f72779c
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion include/xcm.h
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit f72779c

Please sign in to comment.