ws

package

v0.7.5 Latest Latest Go to latest Published: Aug 14, 2025 License: MIT Imports: 11 Imported by: 0

Details

This section is empty.

This section is empty.

This section is empty.

type Frame struct {
	Header FrameHeader
	Data   io.Reader
}

func (fr *Frame) ReadFrom(r io.Reader) (n int64, err error)

func (fr *Frame) WriteTo(w io.Writer) (n int64, err error)

type FrameHeader struct {
	Fin    bool
	Rsv1   bool
	Rsv2   bool
	Rsv3   bool
	OpCode OpCode

	PayloadLength int64

	Masked  bool
	MaskKey uint32
}

FrameHeader represents a WebSocket frame header. See https://tools.ietf.org/html/rfc6455#section-5.2.

func (h FrameHeader) Length() int

func (h *FrameHeader) ReadFrom(r io.Reader) (n int64, err error)

func (h *FrameHeader) WriteTo(w io.Writer) (n int64, err error)

type OpCode int

OpCode represents a WebSocket opcode.

const (
	OpContinuation OpCode = iota
	OpText
	OpBinary

	OpClose
	OpPing
	OpPong
)

type WebsocketConn interface {
	net.Conn
	WriteMessage(int, []byte) error
	ReadMessage() (int, []byte, error)
	xio.CloseRead
	xio.CloseWrite
}

func Conn(conn *websocket.Conn) WebsocketConn

func ContextConn(ctx context.Context, conn *websocket.Conn) WebsocketConn