mirror
/
websocket
mirror of https://github.com/gorilla/websocket.git
1
0
Fork 1
Code Issues Packages Projects Releases Wiki Activity

Improve documentation.

This commit is contained in:
Gary Burd 2013-10-27 08:34:33 -07:00
parent 80c1e5a741
commit 1627eef2a3
2 changed files with 16 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
conn.go
View File

@ -34,7 +34,7 @@ const (
// The message types are defined in RFC 6455, section 11.8. // The message types are defined in RFC 6455, section 11.8.
const ( const (
// TextMessage denotes a text message. The text message payload is // TextMessage denotes a text data message. The text message payload is
// interpreted as UTF-8 encoded text data. // interpreted as UTF-8 encoded text data.
TextMessage = 1 TextMessage = 1

23
server.go
View File

@ -14,17 +14,13 @@ import (
// HandshakeError describes an error with the handshake from the peer. // HandshakeError describes an error with the handshake from the peer.
type HandshakeError struct { type HandshakeError struct {
Err string message string
} }
func (e HandshakeError) Error() string { return e.Err } func (e HandshakeError) Error() string { return e.message }
// Upgrade upgrades the HTTP server connection to the WebSocket protocol. // Upgrade upgrades the HTTP server connection to the WebSocket protocol.
// //
// Upgrade returns a HandshakeError if the request is not a WebSocket
// handshake. Applications should handle errors of this type by replying to the
// client with an HTTP response.
//
// The application is responsible for checking the request origin before // The application is responsible for checking the request origin before
// calling Upgrade. An example implementation of the same origin policy is: // calling Upgrade. An example implementation of the same origin policy is:
// //
@ -33,8 +29,19 @@ func (e HandshakeError) Error() string { return e.Err }
// return // return
// } // }
// //
// Use the responseHeader to specify cookies (Set-Cookie) and the subprotocol // If the endpoint supports WebSocket subprotocols, then the application is
// (Sec-WebSocket-Protocol). // responsible for selecting a subprotocol that is acceptable to the client and
// echoing that value back to the client. Use the Subprotocols function to get
// the list of protocols specified by the client. Use the
// Sec-Websocket-Protocol response header to echo the selected protocol back
// to the client.
//
// Appilcations can set cookies by adding a Set-Cookie header to the
// response header.
//
// If the request is not a valid WebSocket handshake, then Upgrade returns an
// error of type HandshakeError. Applications should handle this error by
// replying to the client with an HTTP error response.
func Upgrade(w http.ResponseWriter, r *http.Request, responseHeader http.Header, readBufSize, writeBufSize int) (*Conn, error) { func Upgrade(w http.ResponseWriter, r *http.Request, responseHeader http.Header, readBufSize, writeBufSize int) (*Conn, error) {
if values := r.Header["Sec-Websocket-Version"]; len(values) == 0 || values[0] != "13" { if values := r.Header["Sec-Websocket-Version"]; len(values) == 0 || values[0] != "13" {