From db1c080f909b55a87f9fd5f21802f700aa5e0ae2 Mon Sep 17 00:00:00 2001 From: Gary Burd Date: Sun, 20 Apr 2014 21:48:25 -0700 Subject: [PATCH] Improve readme. --- README.md | 20 +++++++++++++------- 1 file changed, 13 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 8654027..2a5ab3a 100644 --- a/README.md +++ b/README.md @@ -35,18 +35,24 @@ subdirectory](https://github.com/gorilla/websocket/tree/master/examples/autobahn RFC 6455 Features -Passes Autobahn Test SuiteYesNo +Passes Autobahn Test SuiteYesNo Receive fragmented messageYesNo Send close messageYesNo Send pings and receive pongsYesNo +Get the type of a received data messageYesYes, see note 2 Other Features Limit size of received messageYesNo -Read message using io.ReaderYesNo, see note -Write message using io.WriteCloserYesNo, see note +Read message using io.ReaderYesNo, see note 1 +Write message using io.WriteCloserYesNo, see note 1 Encode, decode JSON messageYesYes -Note: The go.net io.Reader and io.Writer operate across WebSocket frame -boundaries. Read returns when the input buffer is full or a frame boundary is -encountered, Each call to Write sends a single frame message. The Gorilla -io.Reader and io.WriteCloser operate on a single WebSocket message. +Notes: + +1. The go.net io.Reader and io.Writer operate across WebSocket frame boundaries. + Read returns when the input buffer is full or a frame boundary is + encountered, Each call to Write sends a single frame message. The Gorilla + io.Reader and io.WriteCloser operate on a single WebSocket message. +2. The application can get the type of a received data message by implementing + a [Codec marshal](http://godoc.org/code.google.com/p/go.net/websocket#Codec.Marshal) + function.