]> Cypherpunks repositories - gostls13.git/commitdiff
net: document that DNSError.Timeout and Temporary are unreliable
authorIan Lance Taylor <iant@golang.org>
Sat, 11 Apr 2015 17:30:13 +0000 (10:30 -0700)
committerIan Lance Taylor <iant@golang.org>
Mon, 13 Apr 2015 20:41:50 +0000 (20:41 +0000)
Update #10417.

Change-Id: Ibfbdd05358f696a37217eef160f71b14a468ff86
Reviewed-on: https://go-review.googlesource.com/8788
Reviewed-by: Rob Pike <r@golang.org>
src/net/dnsclient.go

index 099ea45ebaf2c169cf074b656b9ae0251bf97791..121cd9d21dc5f52b14612f117b26d39663df119b 100644 (file)
@@ -14,7 +14,7 @@ type DNSError struct {
        Err       string // description of the error
        Name      string // name looked for
        Server    string // server used
-       IsTimeout bool
+       IsTimeout bool   // if true, timed out; not all timeouts set this
 }
 
 func (e *DNSError) Error() string {
@@ -29,7 +29,14 @@ func (e *DNSError) Error() string {
        return s
 }
 
-func (e *DNSError) Timeout() bool   { return e.IsTimeout }
+// Timeout reports whether the DNS lookup is known to have timed out.
+// This is not always known; a DNS lookup may fail due to a timeout
+// and return a DNSError for which Timeout returns false.
+func (e *DNSError) Timeout() bool { return e.IsTimeout }
+
+// Temporary reports whether the DNS error is known to be temporary.
+// This is not always known; a DNS lookup may fail due to a temporary
+// error and return a DNSError for which Temporary returns false.
 func (e *DNSError) Temporary() bool { return e.IsTimeout }
 
 const noSuchHost = "no such host"