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.0.3

Sep 15, 2022

Changes in this version

type Client

+ func (c *Client) Shutdown() error

v1.0.2

Sep 11, 2022

v1.0.1

Aug 10, 2022

v1.0.0

Dec 28, 2021

v0

v0.1.2

Dec 28, 2021

Changes in this version

+ const DefaultPayloadSize

+ const StatusGoAway

+ const StatusNone

+ const StatusNotAcceptable

+ const StatusNotConsistent

+ const StatusProtocolError

+ const StatusReserved

+ const StatusTooBig

+ const StatusUnexpected

+ const StatusViolation

+ const StatuseExtensionsNeeded

+ var ErrCannotUpgrade = errors.New("cannot upgrade connection")

+ func ReleaseFrame(fr *Frame)

+ func UpgradeAsClient(c net.Conn, url string, r *fasthttp.Request) error

+ type Client struct

+ func ClientWithHeaders(c net.Conn, url string, req *fasthttp.Request) (*Client, error)

+ func Dial(url string) (*Client, error)

+ func DialTLS(url string, cnf *tls.Config) (*Client, error)

+ func DialWithHeaders(url string, req *fasthttp.Request) (*Client, error)

+ func MakeClient(c net.Conn, url string) (*Client, error)

+ func (c *Client) Close() error

+ func (c *Client) ReadFrame(fr *Frame) (int, error)

+ func (c *Client) Write(b []byte) (int, error)

+ func (c *Client) WriteBinary(b []byte) (int, error)

+ func (c *Client) WriteFrame(fr *Frame) (int, error)

+ type CloseHandler func(c *Conn, err error)

+ type Code uint8

+ const CodeBinary

+ const CodeClose

+ const CodeContinuation

+ const CodePing

+ const CodePong

+ const CodeText

+ func (code Code) String() string

+ type Conn struct

+ MaxPayloadSize uint64

+ ReadTimeout time.Duration

+ WriteTimeout time.Duration

+ func (c *Conn) Close() error

+ func (c *Conn) CloseDetail(status StatusCode, reason string)

+ func (c *Conn) ID() uint64

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

+ func (c *Conn) Ping(data []byte)

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

+ func (c *Conn) SetUserValue(key string, value interface{})

+ func (c *Conn) UserValue(key string) interface{}

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

+ func (c *Conn) WriteFrame(fr *Frame)

+ type Error struct

+ Reason string

+ Status StatusCode

+ func (e Error) Error() string

+ type ErrorHandler func(c *Conn, err error)

+ type Frame struct

+ func AcquireFrame() *Frame

+ func (fr *Frame) Code() Code

+ func (fr *Frame) CopyTo(fr2 *Frame)

+ func (fr *Frame) HasRSV1() bool

+ func (fr *Frame) HasRSV2() bool

+ func (fr *Frame) HasRSV3() bool

+ func (fr *Frame) IsClose() bool

+ func (fr *Frame) IsContinuation() bool

+ func (fr *Frame) IsControl() bool

+ func (fr *Frame) IsFin() bool

+ func (fr *Frame) IsMasked() bool

+ func (fr *Frame) IsPing() bool

+ func (fr *Frame) IsPong() bool

+ func (fr *Frame) Len() (length uint64)

+ func (fr *Frame) Mask()

+ func (fr *Frame) MaskKey() []byte

+ func (fr *Frame) Payload() []byte

+ func (fr *Frame) PayloadLen() int

+ func (fr *Frame) PayloadSize() uint64

+ func (fr *Frame) ReadFrom(rd io.Reader) (int64, error)

+ func (fr *Frame) Reset()

+ func (fr *Frame) SetBinary()

+ func (fr *Frame) SetClose()

+ func (fr *Frame) SetCode(code Code)

+ func (fr *Frame) SetContinuation()

+ func (fr *Frame) SetFin()

+ func (fr *Frame) SetMask(b []byte)

+ func (fr *Frame) SetPayload(b []byte)

+ func (fr *Frame) SetPayloadSize(size uint64)

+ func (fr *Frame) SetPing()

+ func (fr *Frame) SetPong()

+ func (fr *Frame) SetRSV1()

+ func (fr *Frame) SetRSV2()

+ func (fr *Frame) SetRSV3()

+ func (fr *Frame) SetStatus(status StatusCode)

+ func (fr *Frame) SetText()

+ func (fr *Frame) Status() (status StatusCode)

+ func (fr *Frame) String() string

+ func (fr *Frame) Unmask()

+ func (fr *Frame) UnsetMask()

+ func (fr *Frame) Write(b []byte) (int, error)

+ func (fr *Frame) WriteTo(wr io.Writer) (n int64, err error)

+ type FrameHandler func(c *Conn, fr *Frame)

+ type MessageHandler func(c *Conn, isBinary bool, data []byte)

+ type OpenHandler func(c *Conn)

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

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

+ type RequestHandler func(conn *Conn)

+ type Server struct

+ Origin string

+ Protocols []string

+ UpgradeHandler UpgradeHandler

+ UpgradeNetHandler UpgradeNetHandler

+ func (s *Server) HandleClose(closeHandler CloseHandler)

+ func (s *Server) HandleData(msgHandler MessageHandler)

+ func (s *Server) HandleError(errHandler ErrorHandler)

+ func (s *Server) HandleFrame(frameHandler FrameHandler)

+ func (s *Server) HandleOpen(openHandler OpenHandler)

+ func (s *Server) HandlePing(pingHandler PingHandler)

+ func (s *Server) HandlePong(pongHandler PongHandler)

+ func (s *Server) NetUpgrade(resp http.ResponseWriter, req *http.Request)

+ func (s *Server) Upgrade(ctx *fasthttp.RequestCtx)

+ type StatusCode uint16

+ func (status StatusCode) String() string

+ type UpgradeHandler func(*fasthttp.RequestCtx) bool

+ type UpgradeNetHandler func(resp http.ResponseWriter, req *http.Request) bool