浏览代码

Improve Upgrader.Upgrade doc

Gary Burd 9 年之前
父节点
当前提交
5c91b59efa
共有 1 个文件被更改,包括 3 次插入0 次删除
  1. 3 0
      server.go

+ 3 - 0
server.go

@@ -92,6 +92,9 @@ func (u *Upgrader) selectSubprotocol(r *http.Request, responseHeader http.Header
 // The responseHeader is included in the response to the client's upgrade
 // request. Use the responseHeader to specify cookies (Set-Cookie) and the
 // application negotiated subprotocol (Sec-Websocket-Protocol).
+//
+// If the upgrade fails, then Upgrade replies to the client with an HTTP error
+// response.
 func (u *Upgrader) Upgrade(w http.ResponseWriter, r *http.Request, responseHeader http.Header) (*Conn, error) {
 	if r.Method != "GET" {
 		return u.returnError(w, r, http.StatusMethodNotAllowed, "websocket: method not GET")