Skip to content

docs(wsjson): document that Read closes the connection on bad JSON #590

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mraj602 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs(wsjson): document that Read closes the connection on bad JSON #590

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions wsjson/wsjson.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,11 @@ import (

// Read reads a JSON message from c into v.
// It will reuse buffers in between calls to avoid allocations.
//
// If the message cannot be unmarshalled into v, Read closes the connection
// with websocket.StatusInvalidFramePayloadData and returns an error wrapping
// the unmarshal error. To keep the connection open on bad JSON, read the
// message with c.Read and call json.Unmarshal yourself.
func Read(ctx context.Context, c *websocket.Conn, v any) error {
return read(ctx, c, v)
}
Expand Down
Loading