Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  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.0

Jul 22, 2020

v1.3.1

Jan 9, 2020

v1.3.0

Oct 10, 2019

v1.2.1

Aug 24, 2019

v1.2.0

Aug 7, 2019

Changes in this version

+ const All

+ const Broadcast

+ const CloseMessage

+ const DefaultEvtMessageKey

+ const DefaultWebsocketMaxMessageSize

+ const DefaultWebsocketPingPeriod

+ const DefaultWebsocketPongTimeout

+ const DefaultWebsocketReadBufferSize

+ const DefaultWebsocketReadTimeout

+ const DefaultWebsocketWriteTimeout

+ const DefaultWebsocketWriterBufferSize

+ const WriteWait

+ var ClientSource = []byte(...)

+ var DefaultIDGenerator = func(context.Context) string

+ var ErrAlreadyDisconnected = errors.New("already disconnected")

+ func ClientHandler() context.Handler

+ type Config struct

+ BinaryMessages bool

+ CheckOrigin func(r *http.Request) bool

+ EnableCompression bool

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

+ EvtMessagePrefix []byte

+ HandshakeTimeout time.Duration

+ IDGenerator func(ctx context.Context) string

+ MaxMessageSize int64

+ Ping bool

+ PingPeriod time.Duration

+ PongTimeout time.Duration

+ ReadBufferSize int

+ ReadTimeout time.Duration

+ Subprotocols []string

+ WriteBufferSize int

+ WriteTimeout time.Duration

+ func (c Config) Validate() Config

+ type Connection interface

+ Context func() context.Context

+ Disconnect func() error

+ Err func() error

+ FireOnError func(err error)

+ GetValue func(key string) interface{}

+ GetValueArrString func(key string) []string

+ GetValueInt func(key string) int

+ GetValueString func(key string) string

+ ID func() string

+ IsJoined func(roomName string) bool

+ Join func(string)

+ Leave func(string) bool

+ On func(string, MessageFunc)

+ OnDisconnect func(DisconnectFunc)

+ OnError func(ErrorFunc)

+ OnLeave func(roomLeaveCb LeaveRoomFunc)

+ OnMessage func(NativeMessageFunc)

+ OnPing func(PingFunc)

+ OnPong func(PongFunc)

+ Server func() *Server

+ SetValue func(key string, value interface{})

+ To func(string) Emitter

+ Wait func()

+ Write func(websocketMessageType int, data []byte) error

+ type ConnectionFunc func(Connection)

+ type ConnectionValues []connectionValue

+ func (r *ConnectionValues) Get(key string) interface{}

+ func (r *ConnectionValues) Reset()

+ func (r *ConnectionValues) Set(key string, value interface{})

+ type DisconnectFunc func()

+ type Emitter interface

+ Emit func(string, interface{}) error

+ EmitMessage func([]byte) error

+ type ErrorFunc (func(error))

+ type LeaveRoomFunc func(roomName string)

+ type MessageFunc interface

+ type NativeMessageFunc func([]byte)

+ type PingFunc func()

+ type PongFunc func()

+ type Server struct

+ ClientSource []byte

+ func New(cfg Config) *Server

+ func (s *Server) Disconnect(connID string) (err error)

+ func (s *Server) GetConnection(connID string) Connection

+ func (s *Server) GetConnections() []Connection

+ func (s *Server) GetConnectionsByRoom(roomName string) []Connection

+ func (s *Server) GetTotalConnections() (n int)

+ func (s *Server) Handler() context.Handler

+ func (s *Server) IsConnected(connID string) bool

+ func (s *Server) IsJoined(roomName string, connID string) bool

+ func (s *Server) Join(roomName string, connID string)

+ func (s *Server) Leave(roomName string, connID string) bool

+ func (s *Server) LeaveAll(connID string)

+ func (s *Server) OnConnection(cb ConnectionFunc)

+ func (s *Server) Upgrade(ctx context.Context) Connection

+ type UnderlineConnection interface

+ Close func() error

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

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

+ SetPingHandler func(h func(appData string) error)

+ SetPongHandler func(h func(appData string) error)

+ SetReadDeadline func(t time.Time) error

+ SetReadLimit func(limit int64)

+ SetWriteDeadline func(t time.Time) error

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

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