]> Cypherpunks repositories - gostls13.git/commitdiff
net: document OpError
authorBrad Fitzpatrick <bradfitz@golang.org>
Thu, 14 Feb 2013 17:29:34 +0000 (09:29 -0800)
committerBrad Fitzpatrick <bradfitz@golang.org>
Thu, 14 Feb 2013 17:29:34 +0000 (09:29 -0800)
Fixes #4797

R=adg, rsc
CC=golang-dev
https://golang.org/cl/7300099

src/pkg/net/net.go

index a3d17598205387e622e97b4c2b349705374c10e5..72b2b646c48f8214c67b2a9f4cab7abe5743e44b 100644 (file)
@@ -276,11 +276,23 @@ type Listener interface {
 
 var errMissingAddress = errors.New("missing address")
 
+// OpError is the error type usually returned by functions in the net
+// package. It describes the operation, network type, and address of
+// an error.
 type OpError struct {
-       Op   string
-       Net  string
+       // Op is the operation which caused the error, such as
+       // "read" or "write".
+       Op string
+
+       // Net is the network type on which this error occurred,
+       // such as "tcp" or "udp6".
+       Net string
+
+       // Addr is the network address on which this error occurred.
        Addr Addr
-       Err  error
+
+       // Err is the error that occurred during the operation.
+       Err error
 }
 
 func (e *OpError) Error() string {