From 79c036238d83c8fceb49aa4bab4d6dade1c321f6 Mon Sep 17 00:00:00 2001 From: Mikio Hara Date: Tue, 18 Oct 2016 19:43:04 +0900 Subject: [PATCH] net: update docs on network interface API This change documents that the InterfaceAddrs function is less usable on multi-homed IP nodes because of the lack of network interface identification information. Also updates documentation on exposed network interface API. Fixes #14518. Change-Id: I5e86606f8019ab475eb5d385bd797b052cba395d Reviewed-on: https://go-review.googlesource.com/31371 Reviewed-by: Brad Fitzpatrick --- src/net/interface.go | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/src/net/interface.go b/src/net/interface.go index d1fe2a0009..301a5cfd22 100644 --- a/src/net/interface.go +++ b/src/net/interface.go @@ -69,7 +69,8 @@ func (f Flags) String() string { return s } -// Addrs returns interface addresses for a specific interface. +// Addrs returns a list of unicast interface addresses for a specific +// interface. func (ifi *Interface) Addrs() ([]Addr, error) { if ifi == nil { return nil, &OpError{Op: "route", Net: "ip+net", Source: nil, Addr: nil, Err: errInvalidInterface} @@ -81,8 +82,8 @@ func (ifi *Interface) Addrs() ([]Addr, error) { return ifat, err } -// MulticastAddrs returns multicast, joined group addresses for -// a specific interface. +// MulticastAddrs returns a list of multicast, joined group addresses +// for a specific interface. func (ifi *Interface) MulticastAddrs() ([]Addr, error) { if ifi == nil { return nil, &OpError{Op: "route", Net: "ip+net", Source: nil, Addr: nil, Err: errInvalidInterface} @@ -106,8 +107,11 @@ func Interfaces() ([]Interface, error) { return ift, nil } -// InterfaceAddrs returns a list of the system's network interface +// InterfaceAddrs returns a list of the system's unicast interface // addresses. +// +// The returned list does not identify the associated interface; use +// Interfaces and Interface.Addrs for more detail. func InterfaceAddrs() ([]Addr, error) { ifat, err := interfaceAddrTable(nil) if err != nil { -- 2.48.1