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 module

Go to main page

Versions in this module

v1

v1.4.0

Aug 25, 2018

v1.3.0

Aug 16, 2018

v1.2.0

Jun 20, 2017

v1.1.0

Dec 16, 2016

v1.0.0

Apr 28, 2016

v0

v0.3.1

Mar 25, 2025

v0.3.0

Mar 25, 2025

v0.0.1

Mar 31, 2025

Changes in this version

+ const BinaryMessage

+ const CloseAbnormalClosure

+ const CloseGoingAway

+ const CloseInternalServerErr

+ 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 DefaultDialer = &Dialer

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

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

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

+ var ErrWriteDeadlineExceeded = errors.New("websocket: writing deadline exceeded")

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

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

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

+ func IsWebSocketUpgrade(r *http.Request) bool

+ func JoinMessages(c *Conn, term string) io.Reader

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

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

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

+ type BufferPool interface

+ Get func() interface{}

+ Put func(interface{})

+ type CloseError struct

+ Code int

+ Text string

+ func (e *CloseError) Error() string

+ type Conn struct

+ Unsafe bool

+ func NewClient(netConn net.Conn, u *url.URL, requestHeader http.Header, ...) (c *Conn, response *http.Response, err error)

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

+ func (c *Conn) Close() error

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

+ func (c *Conn) CloseWithoutFlush() error

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

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

+ func (c *Conn) NextReader() (messageType int, r io.Reader, err error)

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

+ 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) SetCompressionLevel(level int) 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) SetReadLimit(limit int64)

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

+ func (c *Conn) Subprotocol() string

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

+ 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

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

+ type Dialer struct

+ EnableCompression bool

+ HandshakeTimeout time.Duration

+ Jar http.CookieJar

+ MaxHeaderSize int64

+ NetDial func(network, addr string) (net.Conn, error)

+ NetDialContext func(ctx context.Context, network, addr string) (net.Conn, error)

+ Proxy func(*http.Request) (*url.URL, error)

+ ReadBufferSize int

+ Subprotocols []string

+ TLSClientConfig *tls.Config

+ WriteBufferPool BufferPool

+ WriteBufferSize int

+ func (d *Dialer) Dial(urlStr string, requestHeader http.Header) (*Conn, *http.Response, error)

+ func (d *Dialer) DialContext(ctx context.Context, urlStr string, requestHeader http.Header) (*Conn, *http.Response, error)

+ type HandshakeError struct

+ func (e HandshakeError) Error() string

+ type PreparedMessage struct

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

+ type Upgrader struct

+ CheckOrigin func(r *http.Request) bool

+ EnableCompression bool

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

+ HandshakeTimeout time.Duration

+ ReadBufferSize int

+ Subprotocols []string

+ WriteBufferPool BufferPool

+ WriteBufferSize int

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

v0.0.0-20250324202656

Mar 25, 2025

v0.0.0-20250324200217

Mar 25, 2025