x/net/websocket: unclear whether Conn.Read documentation refers to frame or message

[fortuna]

Go version

any

Output of go env in your module/workspace:

N/A

What did you do?

The behavior of websocket.Conn is not clear.

What did you see happen?

In https://pkg.go.dev/golang.org/x/net/websocket#Conn.Read, we have:

Read implements the io.Reader interface: it reads data of a frame from the WebSocket connection. if msg is not large enough for the frame data, it fills the msg and next Read will read the rest of the frame data. it reads Text frame or Binary frame.

Does Read read a frame or a message? The text keeps saying "frame", but it actually sounds like a message, or else we don't have a way to get messages. The variable says "msg".

There's more confusion in the documentation. In one of the examples we have:

// receive text frame
var message string
websocket.Message.Receive(ws, &message)

Is it a frame or a message?

What did you expect to see?

In Websockets frames and messages are two different things with well defined meaning in the RFC. This needs to be clarified.

[gabyhelp]

Related Issues

• x/net/websocket: Read() doesn't read the whole frame #27967
• x/net/websocket: messages not exposed in package API #7632

_{(Emoji vote if this was helpful or unhelpful; more detailed feedback welcome in this discussion.)}