ws

Documentation

Index

• Constants
• Variables
• func WriteTextFrame(conn WSConn, text string) (int, error)
• type DialOptions
• type RemoteAddresser
• type Transport
  • func MakeTransport(conn WSConn) Transport
• type WSConn
  • func Dial(uriStr string) (WSConn, error)
  • func DialWithOptions(uriStr string, options *DialOptions) (WSConn, error)
  • func WebSocketHandshake(req *http.Request, w http.ResponseWriter) (WSConn, error)
• type WSFrame
  • func NewBinaryFrame(dat []byte) *WSFrame
  • func NewTextFrame(text string) *WSFrame

Constants

const BUF_SIZE_EXTEND = 1024 * 8

const MAX_BUF_SIZE = 1024 * 1024 * 512

Variables

var UserAgent = "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/130.0.0.0 Safari/537.36"

Functions

func WriteTextFrame

func WriteTextFrame(conn WSConn, text string) (int, error)

Types

type DialOptions

type DialOptions struct {
	Header http.Header
	TLS    *tls.Config
}

type RemoteAddresser

type RemoteAddresser interface {
	RemoteAddr() net.Addr
}

type Transport

type Transport interface {
	io.ReadWriteCloser
	RemoteAddresser
}

func MakeTransport

func MakeTransport(conn WSConn) Transport

type WSConn

type WSConn interface {
	ReadFrame() (*WSFrame, error)
	WriteFrame(*WSFrame) (int, error)
	WriteFrames([]*WSFrame) (int, error)
	io.Closer
	RemoteAddresser
}

func Dial

func Dial(uriStr string) (WSConn, error)

func DialWithOptions

func DialWithOptions(uriStr string, options *DialOptions) (WSConn, error)

func WebSocketHandshake

func WebSocketHandshake(req *http.Request, w http.ResponseWriter) (WSConn, error)

type WSFrame

type WSFrame struct {
	Fin  bool
	Op   uint8
	Data []byte
}

func NewBinaryFrame

func NewBinaryFrame(dat []byte) *WSFrame

func NewTextFrame

func NewTextFrame(text string) *WSFrame