Document for pickOneAddress().

RenxuanW · RenxuanW · commit ad39960f2e82 · 2022-08-01T10:09:01.000-07:00
diff --git a/flow/include/flow/network.h b/flow/include/flow/network.h
@@ -736,6 +736,8 @@ class INetworkConnections {
 		return static_cast<INetworkConnections*>((void*)g_network->global(INetwork::enNetworkConnections));
 	}
 
+	// If a DNS name can be resolved to both and IPv4 and IPv6 addresses, we want IPv6 addresses when running the clusters on IPv6.
+	// This function takes a vector of addresses and return a random one, preferring IPv6 over IPv4.
 	static NetworkAddress pickOneAddress(const std::vector<NetworkAddress>& addresses) {
 		std::vector<NetworkAddress> ipV6Addresses;
 		for (const NetworkAddress& addr : addresses) {

Original file line number	Diff line number	Diff line change
`@@ -736,6 +736,8 @@ class INetworkConnections {`
`736`	`736`	`return static_cast<INetworkConnections>((void)g_network->global(INetwork::enNetworkConnections));`
`737`	`737`	`}`
`738`	`738`
	`739`	`+ // If a DNS name can be resolved to both and IPv4 and IPv6 addresses, we want IPv6 addresses when running the clusters on IPv6.`
	`740`	`+ // This function takes a vector of addresses and return a random one, preferring IPv6 over IPv4.`
`739`	`741`	`static NetworkAddress pickOneAddress(const std::vector<NetworkAddress>& addresses) {`
`740`	`742`	`std::vector<NetworkAddress> ipV6Addresses;`
`741`	`743`	`for (const NetworkAddress& addr : addresses) {`