websocket

Sep 24, 2026

Changes in this version

+ var ErrMessageInFlight = errors.New("websocket: a message is already being written")

Sep 24, 2026

Changes in this version

+ var ErrStaleReader = errors.New("websocket: reader belongs to a finished message")

Sep 24, 2026

Changes in this version

+ var ErrConfig = errors.New("websocket: invalid configuration")

type Conn

+ func (c *Conn) CompressionEnabled() bool

type DialOption

+ func WithDialCompressionLevel(level int) DialOption

+ func WithDialReadLimit(bytes int64) DialOption

Sep 24, 2026

Changes in this version

+ var ErrBadClosePayload = errors.New("websocket: close payload has a reserved code or invalid reason")

+ var ErrBadControl = errors.New("websocket: not a control frame type")

+ var ErrBadWriteType = errors.New("websocket: not a data message type")

+ var ErrControlTooBig = errors.New("websocket: control frame payload too large")

+ var ErrProtocol = errors.New("websocket: protocol error")

+ var ErrReadLimit = errors.New("websocket: read limit exceeded")

+ var ErrWriteClosed = errors.New("websocket: write to closed message writer")

type CloseError

+ func (e *CloseError) Unwrap() error

Sep 23, 2026

Changes in this version

type CloseCode

+ const CloseBadGateway

type HandshakeError

+ Status int

Sep 23, 2026

Changes in this version

+ var ErrWriteLimit = errors.New("websocket: write limit exceeded")

type Conn

+ func (c *Conn) SetWriteLimit(n int64)

Sep 23, 2026

Changes in this version

+ var ErrHandshakeTooLarge = errors.New("websocket: handshake response too large")

type DialOption

+ func WithDialHandshakeLimit(bytes int64) DialOption

Jul 8, 2026

Changes in this version

+ var ErrBadHandshake = errors.New("websocket: bad handshake")

+ var ErrCloseSent = errors.New("websocket: close sent")

+ func IsCloseError(err error, codes ...CloseCode) bool

+ func IsUnexpectedCloseError(err error, expected ...CloseCode) bool

+ func IsWebSocketUpgrade(r *http.Request) bool

+ func Subprotocols(r *http.Request) []string

+ type CloseCode uint16

+ const CloseAbnormalClosure

+ const CloseGoingAway

+ const CloseInternalServerErr

+ const CloseInvalidFramePayloadData

+ const CloseMandatoryExtension

+ const CloseMessageTooBig

+ const CloseNoStatusReceived

+ const CloseNormalClosure

+ const ClosePolicyViolation

+ const CloseProtocolError

+ const CloseServiceRestart

+ const CloseTLSHandshake

+ const CloseTryAgainLater

+ const CloseUnsupportedData

+ type CloseError struct

+ Code CloseCode

+ Text string

+ func (e *CloseError) Error() string

+ type Conn struct

+ func Dial(ctx context.Context, urlStr string, opts ...DialOption) (*Conn, *http.Response, error)

+ func Upgrade(w http.ResponseWriter, r *http.Request, opts ...Option) (*Conn, error)

+ func (c *Conn) Close() error

+ func (c *Conn) CloseWithStatus(code CloseCode, reason string) error

+ func (c *Conn) LocalAddr() net.Addr

+ func (c *Conn) NetConn() net.Conn

+ func (c *Conn) NextReader() (MessageType, io.Reader, error)

+ func (c *Conn) NextWriter(mt MessageType) (io.WriteCloser, error)

+ func (c *Conn) ReadJSON(v any) error

+ func (c *Conn) ReadMessage() (MessageType, []byte, error)

+ func (c *Conn) RemoteAddr() net.Addr

+ func (c *Conn) SetCloseHandler(fn func(code CloseCode, text string) error)

+ func (c *Conn) SetPingHandler(fn func(appData string) error)

+ func (c *Conn) SetPongHandler(fn func(appData string) error)

+ func (c *Conn) SetReadDeadline(t time.Time) error

+ func (c *Conn) SetReadLimit(n int64)

+ func (c *Conn) SetWriteDeadline(t time.Time) error

+ func (c *Conn) Subprotocol() string

+ func (c *Conn) WriteControl(mt MessageType, data []byte, deadline time.Time) error

+ func (c *Conn) WriteJSON(v any) error

+ func (c *Conn) WriteMessage(mt MessageType, data []byte) error

+ type DialOption func(*dialConfig)

+ func WithDialCompression() DialOption

+ func WithDialHandshakeTimeout(d time.Duration) DialOption

+ func WithDialHeader(h http.Header) DialOption

+ func WithDialNetDialer(d *net.Dialer) DialOption

+ func WithDialSubprotocols(names ...string) DialOption

+ func WithDialTLSConfig(cfg *tls.Config) DialOption

+ type HandshakeError struct

+ func (e HandshakeError) Error() string

+ type MessageType int

+ const BinaryMessage

+ const CloseMessage

+ const PingMessage

+ const PongMessage

+ const TextMessage

+ type Option func(*Upgrader)

+ func WithCompression() Option

+ func WithCompressionLevel(level int) Option

+ func WithHandshakeTimeout(d time.Duration) Option

+ func WithOriginChecker(fn func(*http.Request) bool) Option

+ func WithReadLimit(bytes int64) Option

+ func WithSubprotocols(names ...string) Option

+ type Upgrader struct

+ func NewUpgrader(opts ...Option) *Upgrader

+ func (u *Upgrader) Upgrade(w http.ResponseWriter, r *http.Request) (*Conn, error)