ws

Documentation

Index

• type Frame
  • func (fr *Frame) ReadFrom(r io.Reader) (n int64, err error)
  • func (fr *Frame) WriteTo(w io.Writer) (n int64, err error)
• type FrameHeader
  • 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
• type WebsocketConn
  • func Conn(conn *websocket.Conn) WebsocketConn
  • func ConnWithClientAddr(conn *websocket.Conn, clientAddr net.Addr) WebsocketConn

Types

type Frame

type Frame struct {
	Header FrameHeader
	Data   io.Reader
}

func (*Frame) ReadFrom

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

func (*Frame) WriteTo

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

type FrameHeader

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 (FrameHeader) Length

func (h FrameHeader) Length() int

func (*FrameHeader) ReadFrom

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

ReadFrom reads a header from the reader. See https://tools.ietf.org/html/rfc6455#section-5.2.

func (*FrameHeader) WriteTo

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

type OpCode

type OpCode int

OpCode represents a WebSocket opcode.

const (
	OpContinuation OpCode = iota
	OpText
	OpBinary

	OpClose
	OpPing
	OpPong
)

https://tools.ietf.org/html/rfc6455#section-11.8.

type WebsocketConn

type WebsocketConn interface {
	net.Conn
	WriteMessage(int, []byte) error
	ReadMessage() (int, []byte, error)
	xnet.ClientAddr
}

func Conn

func Conn(conn *websocket.Conn) WebsocketConn

func ConnWithClientAddr

func ConnWithClientAddr(conn *websocket.Conn, clientAddr net.Addr) WebsocketConn