websocket: explain why Unpack return multiple frames

When receiving packet from client, the underlying protocol or operating
system may buffered the packet.  Client may send a single frame one at
time, but server may receive one or more frame in one packet; and vice
versa.  That's the reason why the Unpack return multiple frame instead of
single frame.

1 files changed, 6 insertions, 0 deletions

diff --git a/lib/websocket/frames.go b/lib/websocket/frames.go
index 2f9dd239..c1ebc4b5 100644
--- a/lib/websocket/frames.go
+++ b/lib/websocket/frames.go
@@ -19,6 +19,12 @@ type Frames struct {
 //
 // Unpack websocket data protocol from raw bytes to one or more frames.
 //
+// When receiving packet from client, the underlying protocol or operating
+// system may buffered the packet.  Client may send a single frame one at
+// time, but server may receive one or more frame in one packet; and vice
+// versa.  That's the reason why the Unpack return multiple frame instead of
+// single frame.
+//
 // On success it will return one or more frames.
 // On fail it will return zero frame.
 //