aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBrad Fitzpatrick <bradfitz@golang.org>2017-07-21 18:52:38 +0000
committerBrad Fitzpatrick <bradfitz@golang.org>2017-07-21 18:55:41 +0000
commitc522b2bec9e6186a8efb7ddd221295390638a18e (patch)
tree631ccd06338e17ff1f94c0a696dd6559d9dd33cb
parentace7ce1025402a9a47f70e72ac60a5932b22199f (diff)
downloadgo-c522b2bec9e6186a8efb7ddd221295390638a18e.tar.gz
go-c522b2bec9e6186a8efb7ddd221295390638a18e.zip
net/http: document that after Hijack, Request.Body is invalid
We can make it panic with a more explicit and readable error message during Go 1.10, but document it for now. This has always been the case; it's not a new rule. Updates #20933 Change-Id: I53c1fefb47a8f4aae0bb32fa742afa3a2ed20e8a Reviewed-on: https://go-review.googlesource.com/50634 Reviewed-by: Ian Lance Taylor <iant@golang.org> Reviewed-by: Emmanuel Odeke <emm.odeke@gmail.com>
-rw-r--r--src/net/http/server.go3
1 files changed, 3 insertions, 0 deletions
diff --git a/src/net/http/server.go b/src/net/http/server.go
index a2c3acef50..2fa8ab23d8 100644
--- a/src/net/http/server.go
+++ b/src/net/http/server.go
@@ -178,6 +178,9 @@ type Hijacker interface {
//
// The returned bufio.Reader may contain unprocessed buffered
// data from the client.
+ //
+ // After a call to Hijack, the original Request.Body should
+ // not be used.
Hijack() (net.Conn, *bufio.ReadWriter, error)
}