websocket: add documentation to IsServerConn and IsClientConn
Those function names are ambiguous. These functions don't check if a
client/server is connected but if the connection is client or server
side. Adding some documentation should avoid any mistake.
Change-Id: I0522e176d58c558fd880d49b980b0152b96823bc
Reviewed-on: https://go-review.googlesource.com/120146
Reviewed-by: Brad Fitzpatrick <bradfitz@golang.org>
diff --git a/websocket/websocket.go b/websocket/websocket.go
index e242c89..1f4f7be 100644
--- a/websocket/websocket.go
+++ b/websocket/websocket.go
@@ -241,7 +241,10 @@
return err1
}
+// IsClientConn reports whether ws is a client-side connection.
func (ws *Conn) IsClientConn() bool { return ws.request == nil }
+
+// IsServerConn reports whether ws is a server-side connection.
func (ws *Conn) IsServerConn() bool { return ws.request != nil }
// LocalAddr returns the WebSocket Origin for the connection for client, or
