summaryrefslogtreecommitdiffhomepage
path: root/ios/RelaySelector
diff options
context:
space:
mode:
authorAndrej Mihajlov <and@mullvad.net>2023-04-19 12:33:07 +0200
committerAndrej Mihajlov <and@mullvad.net>2023-04-19 15:43:09 +0200
commit803bbed55000f915d84d8ead0bc24a238c8bc8ae (patch)
treeda315d5210539e9da66e414e5a4e199bed5b64dd /ios/RelaySelector
parent2646d2823252d62c8a068557aa9b2875f8897052 (diff)
downloadmullvadvpn-803bbed55000f915d84d8ead0bc24a238c8bc8ae.tar.xz
mullvadvpn-803bbed55000f915d84d8ead0bc24a238c8bc8ae.zip
RelaySelector: document what evaluate() does
Diffstat (limited to 'ios/RelaySelector')
-rw-r--r--ios/RelaySelector/RelaySelector.swift4
1 files changed, 4 insertions, 0 deletions
diff --git a/ios/RelaySelector/RelaySelector.swift b/ios/RelaySelector/RelaySelector.swift
index 6a22acef66..392aee7334 100644
--- a/ios/RelaySelector/RelaySelector.swift
+++ b/ios/RelaySelector/RelaySelector.swift
@@ -18,6 +18,10 @@ public enum RelaySelector {
return relays.bridge.shadowsocks.filter { $0.protocol == "tcp" }.randomElement()
}
+ /**
+ Filters relay list using given constraints and selects random relay.
+ Throws an error if there are no relays satisfying the given constraints.
+ */
public static func evaluate(
relays: REST.ServerRelaysResponse,
constraints: RelayConstraints