Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

websocket

package

Go to main page

Versions in this module

v1

v1.4.1

May 3, 2026

v1.4.0

Apr 19, 2026

v1.3.4

Apr 14, 2026

Changes in this version

+ const BinaryMessage

+ const CloseAbnormalClosure

+ const CloseGoingAway

+ const CloseInternalError

+ const CloseInvalidPayload

+ const CloseMandatoryExt

+ const CloseMessageTooBig

+ const CloseNoStatusReceived

+ const CloseNormalClosure

+ const ClosePolicyViolation

+ const CloseProtocolError

+ const CloseServiceRestart

+ const CloseTryAgainLater

+ const CloseUnsupportedData

+ const CompressionLevelBestSize

+ const CompressionLevelBestSpeed

+ const CompressionLevelDefault

+ const CompressionLevelHuffman

+ const TextMessage

+ var ErrClosed = errors.New("websocket: connection closed")

+ var ErrControlTooLarge = errors.New("websocket: control frame payload > 125")

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

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

+ var ErrInvalidCloseData = errors.New("websocket: invalid close frame data")

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

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

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

+ var ErrReservedBits = errors.New("websocket: reserved bits set")

+ var ErrWriteClosed = errors.New("websocket: write on closed connection")

+ var ErrWriteTimeout = errors.New("websocket: write deadline exceeded")

+ func FormatCloseMessage(code int, text string) []byte

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

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

+ func New(config ...Config) celeris.HandlerFunc

+ type BufferPool interface

+ Get func(dst io.Writer) *bufio.Writer

+ Put func(bw *bufio.Writer)

+ type CloseError struct

+ Code int

+ Text string

+ func (e *CloseError) Error() string

+ type Config struct

+ BackpressureHighPct int

+ BackpressureLowPct int

+ CheckOrigin func(c *celeris.Context) bool

+ CompressionLevel int

+ CompressionThreshold int

+ EnableCompression bool

+ Handler Handler

+ HandshakeTimeout time.Duration

+ IdleTimeout time.Duration

+ MaxBackpressureBuffer int

+ OnConnect func(*Conn) error

+ OnDisconnect func(*Conn)

+ ReadBufferSize int

+ ReadLimit int64

+ Skip func(c *celeris.Context) bool

+ SkipPaths []string

+ Subprotocols []string

+ WriteBufferPool BufferPool

+ WriteBufferSize int

+ type Conn struct

+ func (c *Conn) BackpressureDropped() uint64

+ func (c *Conn) Close() error

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

+ func (c *Conn) Context() context.Context

+ func (c *Conn) EnableWriteCompression(enable bool)

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

+ func (c *Conn) Header(key string) string

+ func (c *Conn) IP() string

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

+ func (c *Conn) Locals(key string) any

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

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

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

+ func (c *Conn) Param(key string) string

+ func (c *Conn) PingHandler() func(data []byte) error

+ func (c *Conn) PongHandler() func(data []byte) error

+ func (c *Conn) Query(key string) string

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

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

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

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

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

+ func (c *Conn) SetCompressionLevel(level int) error

+ func (c *Conn) SetLocals(key string, val any)

+ func (c *Conn) SetPingHandler(h func(data []byte) error)

+ func (c *Conn) SetPongHandler(h func(data []byte) error)

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

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

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

+ func (c *Conn) Subprotocol() string

+ func (c *Conn) WriteBinary(data []byte) error

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

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

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

+ func (c *Conn) WritePing(data []byte) error

+ func (c *Conn) WritePreparedMessage(pm *PreparedMessage) error

+ func (c *Conn) WriteText(data []byte) error

+ type Handler func(*Conn)

+ type MessageType = Opcode

+ type Opcode byte

+ const OpBinary

+ const OpClose

+ const OpContinuation

+ const OpPing

+ const OpPong

+ const OpText

+ func (o Opcode) IsControl() bool

+ func (o Opcode) IsData() bool

+ type PreparedMessage struct

+ func NewPreparedMessage(messageType MessageType, data []byte) (*PreparedMessage, error)