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 2014-10-31 14:51:45 -07:00
parent 87f6f6a22e
commit 02eec998da
1 changed files with 8 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
doc.go
View File

@ -97,10 +97,13 @@
// //
// Concurrency // Concurrency
// //
// A Conn supports a single concurrent caller to the write methods (NextWriter, // Connections do not support concurrent calls to the write methods
// SetWriteDeadline, WriteMessage) and a single concurrent caller to the read // (NextWriter, SetWriteDeadline, WriteMessage) or concurrent calls to the read
// methods (NextReader, SetReadDeadline, ReadMessage). The Close and // methods methods (NextReader, SetReadDeadline, ReadMessage). Connections do
// WriteControl methods can be called concurrently with all other methods. // support a concurrent reader and writer.
//
// The Close and WriteControl methods can be called concurrently with all other
// methods.
// //
// Read is Required // Read is Required
// //
@ -139,7 +142,7 @@
// CheckOrigin: func(r *http.Request) bool { return true }, // CheckOrigin: func(r *http.Request) bool { return true },
// } // }
// //
// The deprecated Upgrade function does enforce an origin policy. It's the // The deprecated Upgrade function does not enforce an origin policy. It's the
// application's responsibility to check the Origin header before calling // application's responsibility to check the Origin header before calling
// Upgrade. // Upgrade.
package websocket package websocket