type Decoder[Tany] struct {// contains filtered or unexported fields}

funcNewDecoder¶

func NewDecoder[Tany](conn *websocket.Conn, typwebsocket.MessageType, loggerslog.Logger) *Decoder[T]

NewDecoder creates a JSON-over-websocket decoder for type T, which must be deserializable fromJSON.

func (*Decoder[T])Chan¶

func (d *Decoder[T]) Chan() <-chan T

Chan returns a `chan` that you can read incoming messages from. The returned`chan` will be closed when the WebSocket connection is closed. If there is anerror reading from the WebSocket or decoding a value the WebSocket will beclosed.

Safety: Chan must only be called once. Successive calls will panic.

func (*Decoder[T])Close¶

func (d *Decoder[T]) Close()error

nolint: revive // complains that Encoder has the same function name

type Encoder[Tany] struct {// contains filtered or unexported fields}

funcNewEncoder¶

func NewEncoder[Tany](conn *websocket.Conn, typwebsocket.MessageType) *Encoder[T]

NewEncoder creates a JSON-over websocket encoder for the type T, which must be JSON-serializable.You may then call Encode() to send objects over the websocket. Creating an Encoder closes thewebsocket for reading, turning it into a unidirectional write stream of JSON-encoded objects.

func (*Encoder[T])Close¶

func (e *Encoder[T]) Close(cwebsocket.StatusCode)error

nolint: revive // complains that Decoder has the same function name

func (*Encoder[T])Encode¶

func (e *Encoder[T]) Encode(v T)error

type Stream[Rany, Wany] struct {// contains filtered or unexported fields}

funcNewStream¶added inv2.22.0

func NewStream[Rany, Wany](conn *websocket.Conn, readType, writeTypewebsocket.MessageType, loggerslog.Logger) *Stream[R, W]

func (*Stream[R, W])Chan¶added inv2.22.0

func (s *Stream[R, W]) Chan() <-chan R

Chan returns a `chan` that you can read incoming messages from. The returned`chan` will be closed when the WebSocket connection is closed. If there is anerror reading from the WebSocket or decoding a value the WebSocket will beclosed.

Safety: Chan must only be called once. Successive calls will panic.

func (*Stream[R, W])Close¶added inv2.22.0

func (s *Stream[R, W]) Close(cwebsocket.StatusCode)error

func (*Stream[R, W])Drop¶added inv2.22.0

func (s *Stream[R, W]) Drop()

func (*Stream[R, W])Send¶added inv2.22.0

func (s *Stream[R, W]) Send(v W)error