core: minor tweaks to description and api.
* Update the description for NewAddrsSetting to explicitly say
it returns all available addresses.
* Rename ChooseAddress to ChooseAddresses since it actually
choose multiple addresses.
MultiPart: 3/4
Change-Id: Ib80ec253ff12d77d5ef4ebdaa0fedae36bf486a9
diff --git a/netstate/.api b/netstate/.api
index fb1262b..7783257 100644
--- a/netstate/.api
+++ b/netstate/.api
@@ -32,7 +32,7 @@
pkg netstate, method (AddrList) Filter(AddressPredicate) AddrList
pkg netstate, method (AddrList) Map(Mapper) AddrList
pkg netstate, method (AddrList) String() string
-pkg netstate, method (AddressChooserFunc) ChooseAddress(string, []net.Addr) ([]net.Addr, error)
+pkg netstate, method (AddressChooserFunc) ChooseAddresses(string, []net.Addr) ([]net.Addr, error)
pkg netstate, method (IPRouteList) Filter(RoutePredicate) IPRouteList
pkg netstate, method (IPRouteList) String() string
pkg netstate, method (InterfaceList) String() string
@@ -42,8 +42,8 @@
pkg netstate, type Address interface, Interface() NetworkInterface
pkg netstate, type Address interface, Network() string
pkg netstate, type Address interface, String() string
-pkg netstate, type AddressChooser interface { ChooseAddress }
-pkg netstate, type AddressChooser interface, ChooseAddress(string, []net.Addr) ([]net.Addr, error)
+pkg netstate, type AddressChooser interface { ChooseAddresses }
+pkg netstate, type AddressChooser interface, ChooseAddresses(string, []net.Addr) ([]net.Addr, error)
pkg netstate, type AddressChooserFunc func(protocol string, candidates []net.Addr) ([]net.Addr, error)
pkg netstate, type AddressPredicate func(a Address) bool
pkg netstate, type IPNetworkInterface interface { Addrs, Flags, HardwareAddr, IPRoutes, Index, MTU, Name, Networks, String }
diff --git a/netstate/chooser.go b/netstate/chooser.go
index 5a08690..7942fa6 100644
--- a/netstate/chooser.go
+++ b/netstate/chooser.go
@@ -16,17 +16,17 @@
ErrNotAnIPProtocol = errors.New("requested protocol is not from the IP family")
)
-// AddressChooser determines the preferred address to publish with the mount
+// AddressChooser determines the preferred addresses to publish with the mount
// table when one is not otherwise specified.
type AddressChooser interface {
- ChooseAddress(protocol string, candidates []net.Addr) ([]net.Addr, error)
+ ChooseAddresses(protocol string, candidates []net.Addr) ([]net.Addr, error)
}
// AddressChooserFunc is a convenience for implementations that wish to supply
// a function literal implementation of AddressChooser.
type AddressChooserFunc func(protocol string, candidates []net.Addr) ([]net.Addr, error)
-func (f AddressChooserFunc) ChooseAddress(protocol string, candidates []net.Addr) ([]net.Addr, error) {
+func (f AddressChooserFunc) ChooseAddresses(protocol string, candidates []net.Addr) ([]net.Addr, error) {
return f(protocol, candidates)
}
@@ -81,7 +81,7 @@
if chooser == nil {
chooser = LoopbackIPv4AddressChooser
}
- chosen, err := chooser.ChooseAddress(protocol, candidates)
+ chosen, err := chooser.ChooseAddresses(protocol, candidates)
if err != nil {
return nil, unspecified, err
}