websocket

Documentation

Index

• type Conn
  • func Dial(ctx context.Context, urlStr string) (conn Conn, err error)
  • func UpgradeHTTP(w http.ResponseWriter, r *http.Request) (conn Conn, err error)
• type Reader
• type Writer

Types

type Conn

type Conn interface {
	Reader
	Writer
}

func Dial

func Dial(ctx context.Context, urlStr string) (conn Conn, err error)

func UpgradeHTTP

func UpgradeHTTP(w http.ResponseWriter, r *http.Request) (conn Conn, err error)

type Reader

type Reader interface {
	Close() error
	State() ws.State

	Read() ([]byte, error)
	ReadString() (string, error)
	ReadJSON(v any) error
}

type Writer

type Writer interface {
	Close() error
	State() ws.State

	Write(p []byte) error
	WriteString(p string) error
	WriteJSON(v any) error
}