websocket

Aug 23, 2026

Changes in this version

type DialOptions

+ HTTPClient *http.Client

Aug 23, 2026

Changes in this version

+ var ErrMaskingViolation = errors.New("invalid frame masking")

+ var ErrNonCanonicalLength = errors.New("non-canonical payload length")

type Conn

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

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

+ func (c *Conn) Read(ctx context.Context) (messageType int, p []byte, err error)

+ func (c *Conn) Subprotocol() string

+ func (c *Conn) Write(ctx context.Context, messageType int, data []byte) error

+ type DialOptions struct

+ HTTPHeader http.Header

+ MaxMessageSize int64

+ NetDialer *net.Dialer

+ Subprotocols []string

+ TLSConfig *tls.Config

May 24, 2026

Changes in this version

+ var ErrSubprotocolRequired = errors.New("websocket subprotocol required")

type HandshakeOptions

+ RequireProtocol bool

+ ResponseHeader http.Header

May 19, 2026

Changes in this version

+ var ErrMalformedKey = errors.New("malformed Sec-WebSocket-Key")

May 17, 2026

Changes in this version

+ const OpcodeBinary

+ const OpcodeClose

+ const OpcodeContinuation

+ const OpcodePing

+ const OpcodePong

+ const OpcodeText

+ var ErrControlFrameTooBig = errors.New("control frame too big")

+ var ErrFragmentedControl = errors.New("fragmented control frame")

+ var ErrInvalidCloseCode = errors.New("invalid close code")

+ var ErrInvalidFrame = errors.New("invalid frame")

+ var ErrInvalidUTF8 = errors.New("invalid UTF-8 in text frame")

+ var ErrMessageTooBig = errors.New("message too big")

+ var ErrMissingKey = errors.New("missing Sec-WebSocket-Key")

+ var ErrUnexpectedContinuation = errors.New("unexpected continuation frame")

+ var ErrUnsupportedVersion = errors.New("unsupported websocket version")

+ func PerformHandshake(w http.ResponseWriter, r *http.Request, opts *HandshakeOptions) (net.Conn, *bufio.ReadWriter, error)

+ func ValidateHandshake(r *http.Request) error

+ type Frame struct

+ Fin bool

+ MaskKey [4]byte

+ Masked bool

+ Opcode int

+ Payload []byte

+ RSV1 bool

+ RSV2 bool

+ RSV3 bool

+ func (f *Frame) IsControl() bool

+ func (f *Frame) IsData() bool

+ type FrameReader struct

+ func NewFrameReader(r *bufio.Reader, maxMessageSize int64) *FrameReader

+ func (fr *FrameReader) ReadFrame() (*Frame, error)

+ type FrameWriter struct

+ func NewFrameWriter(w *bufio.Writer, isServer bool) *FrameWriter

+ func (fw *FrameWriter) WriteFrame(frame *Frame) error

+ type HandshakeOptions struct

+ BeforeUpgrade func(w http.ResponseWriter, r *http.Request) error

+ CheckOrigin func(r *http.Request) bool

+ Extensions []string

+ Subprotocols []string

Sep 29, 2025

Changes in this version

+ const BinaryMessage

+ const CloseAbnormalClosure

+ const CloseGoingAway

+ const CloseInternalServerError

+ const CloseInvalidFramePayloadData

+ const CloseMandatoryExtension

+ const CloseMessage

+ const CloseMessageTooBig

+ const CloseNoStatusReceived

+ const CloseNormalClosure

+ const ClosePolicyViolation

+ const CloseProtocolError

+ const CloseServiceRestart

+ const CloseTLSHandshake

+ const CloseTryAgainLater

+ const CloseUnsupportedData

+ const PingMessage

+ const PongMessage

+ const TextMessage

+ var ErrBadHandshake = ws.ErrBadHandshake

+ var ErrNotWebSocket = ws.ErrNotWebSocket

+ func CheckOriginWithAllowedList(allowedOrigins []string) func(r *http.Request) bool

+ func DefaultCheckOrigin(r *http.Request) bool

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

+ func IsUnexpectedCloseError(err error, expectedCodes ...int) bool

+ type Conn struct

+ func (c *Conn) Close() error

+ func (c *Conn) CloseHandler() func(code int, text string) error

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

+ func (c *Conn) PingHandler() func(appData string) error

+ func (c *Conn) PongHandler() func(appData string) error

+ func (c *Conn) ReadJSON(v interface{}) error

+ func (c *Conn) ReadMessage() (messageType int, p []byte, err error)

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

+ func (c *Conn) SetCloseHandler(h func(code int, text string) error)

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

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

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

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

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

+ func (c *Conn) WriteJSON(v interface{}) error

+ func (c *Conn) WriteMessage(messageType int, data []byte) error

+ type PoolConfig struct

+ ConnectionTimeout time.Duration

+ EnableCompression bool

+ HealthCheckInterval time.Duration

+ IdleTimeout time.Duration

+ MaxConnectionsPerEndpoint int

+ MaxIdleConnections int

+ OnConnectionClosed func(endpoint string, conn *Conn, reason error)

+ OnConnectionCreated func(endpoint string, conn *Conn)

+ func DefaultPoolConfig() PoolConfig

+ type PoolStats struct

+ ActiveConnections atomic.Int64

+ ConnectionsCreated atomic.Int64

+ ConnectionsReused atomic.Int64

+ FailedConnections atomic.Int64

+ HealthChecksFailed atomic.Int64

+ IdleConnections atomic.Int64

+ TotalConnections atomic.Int64

+ type Upgrader struct

+ AllowedOrigins []string

+ BeforeUpgrade func(w http.ResponseWriter, r *http.Request) error

+ CheckOrigin func(r *http.Request) bool

+ EnableCompression bool

+ Error func(w http.ResponseWriter, r *http.Request, status int, reason error)

+ HandshakeTimeout time.Duration

+ MaxMessageSize int64

+ ReadBufferSize int

+ RequireProtocol bool

+ Subprotocols []string

+ WriteBufferSize int

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

+ type WebSocketPool struct

+ func NewWebSocketPool(config PoolConfig) *WebSocketPool

+ func (p *WebSocketPool) Close(conn *Conn, reason error) error

+ func (p *WebSocketPool) Get(ctx context.Context, endpoint string, upgrader *Upgrader, ...) (*Conn, error)

+ func (p *WebSocketPool) GetStats() PoolStats

+ func (p *WebSocketPool) Put(conn *Conn) error

+ func (p *WebSocketPool) Shutdown(ctx context.Context) error