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
- API
  
  Reference documentation for the pkg.go.dev API
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 module

Go to main page

Versions in this module

v1

v1.8.15

Jun 15, 2026

v1.8.14

Sep 5, 2025

Changes in this version

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

v1.8.13

Mar 14, 2025

Changes in this version

type AcceptOptions — darwin/amd64, linux/amd64, windows/amd64

+ OnPingReceived func(ctx context.Context, payload []byte) bool

+ OnPongReceived func(ctx context.Context, payload []byte)

type DialOptions — darwin/amd64, linux/amd64, windows/amd64

+ OnPingReceived func(ctx context.Context, payload []byte) bool

+ OnPongReceived func(ctx context.Context, payload []byte)

v1.8.12

Aug 9, 2024

Changes in this version

+ func NetConn(ctx context.Context, c *Conn, msgType MessageType) net.Conn

+ type AcceptOptions struct

+ CompressionMode CompressionMode

+ CompressionThreshold int

+ InsecureSkipVerify bool

+ OriginPatterns []string

+ Subprotocols []string

+ type CloseError struct

+ Code StatusCode

+ Reason string

+ func (ce CloseError) Error() string

+ type CompressionMode int

+ const CompressionContextTakeover

+ const CompressionDisabled

+ const CompressionNoContextTakeover

+ type Conn struct

+ func Accept(w http.ResponseWriter, r *http.Request, opts *AcceptOptions) (*Conn, error)

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

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

+ func (c *Conn) Close(code StatusCode, reason string) (err error)

+ func (c *Conn) Close(code StatusCode, reason string) error

+ func (c *Conn) CloseNow() (err error)

+ func (c *Conn) CloseNow() error

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

+ func (c *Conn) Ping(ctx context.Context) error

+ func (c *Conn) Read(ctx context.Context) (MessageType, []byte, error)

+ func (c *Conn) Reader(ctx context.Context) (MessageType, io.Reader, error)

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

+ func (c *Conn) Subprotocol() string

+ func (c *Conn) Write(ctx context.Context, typ MessageType, p []byte) error

+ func (c *Conn) Writer(ctx context.Context, typ MessageType) (io.WriteCloser, error)

+ type DialOptions struct

+ CompressionMode CompressionMode

+ CompressionThreshold int

+ HTTPClient *http.Client

+ HTTPHeader http.Header

+ Host string

+ Subprotocols []string

+ type MessageType int

+ const MessageBinary

+ const MessageText

+ func (i MessageType) String() string

+ type StatusCode int

+ const StatusAbnormalClosure

+ const StatusBadGateway

+ const StatusGoingAway

+ const StatusInternalError

+ const StatusInvalidFramePayloadData

+ const StatusMandatoryExtension

+ const StatusMessageTooBig

+ const StatusNoStatusRcvd

+ const StatusNormalClosure

+ const StatusPolicyViolation

+ const StatusProtocolError

+ const StatusServiceRestart

+ const StatusTLSHandshake

+ const StatusTryAgainLater

+ const StatusUnsupportedData

+ func CloseStatus(err error) StatusCode

+ func (i StatusCode) String() string