From: Mikio Hara <mikioh.mikioh@gmail.com>
Date: Mon, 29 Jul 2013 14:25:39 +0000 (+0900)
Subject: net: document sockaddr interface
X-Git-Tag: go1.2rc2~917
X-Git-Url: http://www.git.cypherpunks.su/?a=commitdiff_plain;h=442e614caba7aee4f291e801b1d7ed4e8b2d9707;p=gostls13.git

net: document sockaddr interface

This is in preparation for runtime-integrated network pollster for BSD
variants.

Update #5199

R=golang-dev, fvbommel, dave
CC=golang-dev
https://golang.org/cl/11984043
---

diff --git a/src/pkg/net/sock_posix.go b/src/pkg/net/sock_posix.go
index 1d238c9684..845428aa48 100644
--- a/src/pkg/net/sock_posix.go
+++ b/src/pkg/net/sock_posix.go
@@ -15,9 +15,24 @@ import (
 // address that can be converted into a syscall.Sockaddr.
 type sockaddr interface {
 	Addr
+
+	// family returns the platform-dependent address family
+	// identifier.
 	family() int
+
+	// isWildcard reports whether the address is a wildcard
+	// address.
 	isWildcard() bool
+
+	// sockaddr returns the address converted into a syscall
+	// sockaddr type that implements syscall.Sockaddr
+	// interface. It returns a nil interface when the address is
+	// nil.
 	sockaddr(family int) (syscall.Sockaddr, error)
+
+	// toAddr returns the address represented in sockaddr
+	// interface. It returns a nil interface when the address is
+	// nil.
 	toAddr() sockaddr
 }