From c01c1d4215ea8b19014017673a5adc8b1a9cad0a Mon Sep 17 00:00:00 2001 From: Russ Cox Date: Wed, 26 Oct 2016 20:05:20 -0400 Subject: [PATCH] net: add examples to Addr definition Fixes #16014. Change-Id: I68b096df7924a3258e940c4d94ec5d06f5bdfcbb Reviewed-on: https://go-review.googlesource.com/32097 Reviewed-by: Brad Fitzpatrick --- src/net/net.go | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/src/net/net.go b/src/net/net.go index 6198d94a14d..b9a78266b56 100644 --- a/src/net/net.go +++ b/src/net/net.go @@ -102,9 +102,13 @@ func init() { } // Addr represents a network end point address. +// +// The two methods Network and String conventionally return strings +// that can be passed as the arguments to Dial, but the exact form +// and meaning of the strings is up to the implementation. type Addr interface { - Network() string // name of the network - String() string // string form of address + Network() string // name of the network (for example, "tcp", "udp") + String() string // string form of address (for example, "127.0.0.1:25", "[2001:db8::1]:80") } // Conn is a generic stream-oriented network connection.