Name

ares_set_sortlist - Initialize an ares_channel_t *sortlist configuration

Synopsis

#include <ares.h>
 
int ares_set_sortlist(ares_channel_t *channel, const char *sortstr)

Description

The ares_set_sortlist function initializes an address sortlist configuration for the channel data identified by channel, so that addresses returned by ares_gethostbyname are sorted according to the sortlist. The provided sortstr string that holds a space separated list of IP-address-netmask pairs. The netmask is optional but follows the address after a slash if present. For example, "130.155.160.0/255.255.240.0 130.155.0.0" will sort IPs in ascending order of appearance in the sortlist subnets, with those IPs that do not match any subnets coming last. There is no particular order amongst IPs that tie in this sorting scheme.

This function replaces any potentially previously configured address sortlist with the ones given in the configuration string. It also overrides the sortlist set in resolv.conf(5). Note that this function does not affect the order of results from ares_getaddrinfo.

Return values

ares_set_sortlist may return any of the following values:

ARES_SUCCESS The sortlist configuration was successfully initialized.

ARES_ENOMEM The process's available memory was exhausted.

ARES_ENODATA The channel data identified by channel was invalid.

ARES_ENOTINITIALIZED c-ares library initialization not yet performed.

See also

ares_init_options(3), ares_dup(3)

Availability

ares_set_sortlist(3) was added in c-ares 1.11.0

This HTML page was made with roffit.