From 423912737d2c26382ab4b2647d796811d4efa00b Mon Sep 17 00:00:00 2001 From: Gary Burd Date: Mon, 19 Oct 2015 15:05:01 -0700 Subject: [PATCH] Improve documentation --- doc.go | 11 +++++++---- examples/command/README.md | 4 ++-- 2 files changed, 9 insertions(+), 6 deletions(-) diff --git a/doc.go b/doc.go index f52925d..7228627 100644 --- a/doc.go +++ b/doc.go @@ -97,10 +97,13 @@ // // Concurrency // -// Connections do not support concurrent calls to the write methods -// (NextWriter, SetWriteDeadline, WriteMessage) or concurrent calls to the read -// methods methods (NextReader, SetReadDeadline, ReadMessage). Connections do -// support a concurrent reader and writer. +// Connections support one concurrent reader and one concurrent writer. +// +// Applications are responsible for ensuring that no more than one goroutine +// calls the write methods (NextWriter, SetWriteDeadline, WriteMessage, +// WriteJSON) concurrently and that no more than one goroutine calls the read +// methods (NextReader, SetReadDeadline, ReadMessage, ReadJSON, SetPongHandler, +// SetPingHandler) concurrently. // // The Close and WriteControl methods can be called concurrently with all other // methods. diff --git a/examples/command/README.md b/examples/command/README.md index 786e8cd..c30d397 100644 --- a/examples/command/README.md +++ b/examples/command/README.md @@ -1,7 +1,7 @@ # Command example This example connects a websocket connection to stdin and stdout of a command. -Received messages are written to stdin followed by a `\\n`. Each line read from +Received messages are written to stdin followed by a `\n`. Each line read from from standard out is sent as a message to the client. $ go get github.com/gorilla/websocket @@ -14,6 +14,6 @@ Try the following commands. # Echo sent messages to the output area. $ go run main.go cat - # Run a shell.Try sending `ls` and `cat main.go`. + # Run a shell.Try sending "ls" and "cat main.go". $ go run main.go sh