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

ws

package

Go to main page

Versions in this module

v0

v0.16.0

May 10, 2021

Changes in this version

type Channel

+ GetTLSConnectionState func() *tls.ConnectionState

type Server

+ func (server *Server) Addr() *net.TCPAddr

type WebSocket

+ func (websocket *WebSocket) GetTLSConnectionState() *tls.ConnectionState

type WsServer

+ Addr func() *net.TCPAddr

v0.14.1

Apr 8, 2021

v0.14.0

Apr 8, 2021

v0.0.4

Apr 21, 2021

v0.0.3

Apr 16, 2021

v0.0.2

Apr 8, 2021

v0.0.1

Apr 8, 2021

Changes in this version

+ type Channel interface

+ GetID func() string

+ type Client struct

+ func NewClient() *Client

+ func NewTLSClient(tlsConfig *tls.Config) *Client

+ func (client *Client) AddOption(option interface{})

+ func (client *Client) Errors() <-chan error

+ func (client *Client) IsConnected() bool

+ func (client *Client) SetBasicAuth(username string, password string)

+ func (client *Client) SetDisconnectedHandler(handler func(err error))

+ func (client *Client) SetHeaderValue(key string, value string)

+ func (client *Client) SetMessageHandler(handler func(data []byte) error)

+ func (client *Client) SetReconnectedHandler(handler func())

+ func (client *Client) SetTimeoutConfig(config ClientTimeoutConfig)

+ func (client *Client) Start(url string) error

+ func (client *Client) Stop()

+ func (client *Client) Write(data []byte) error

+ type ClientTimeoutConfig struct

+ HandshakeTimeout time.Duration

+ PingPeriod time.Duration

+ PongWait time.Duration

+ ReconnectBackoff time.Duration

+ ReconnectMaxBackoff time.Duration

+ WriteWait time.Duration

+ func NewClientTimeoutConfig() ClientTimeoutConfig

+ type HttpConnectionError struct

+ Details string

+ HttpCode int

+ HttpStatus string

+ Message string

+ func (e HttpConnectionError) Error() string

+ type Server struct

+ func NewServer() *Server

+ func NewTLSServer(certificatePath string, certificateKey string, tlsConfig *tls.Config) *Server

+ func (server *Server) AddSupportedSubprotocol(subProto string)

+ func (server *Server) Errors() <-chan error

+ func (server *Server) SetBasicAuthHandler(handler func(username string, password string) bool)

+ func (server *Server) SetCheckOriginHandler(handler func(r *http.Request) bool)

+ func (server *Server) SetDisconnectedClientHandler(handler func(ws Channel))

+ func (server *Server) SetMessageHandler(handler func(ws Channel, data []byte) error)

+ func (server *Server) SetNewClientHandler(handler func(ws Channel))

+ func (server *Server) SetTimeoutConfig(config ServerTimeoutConfig)

+ func (server *Server) Start(port int, listenPath string)

+ func (server *Server) Stop()

+ func (server *Server) Write(webSocketId string, data []byte) error

+ type ServerTimeoutConfig struct

+ PingWait time.Duration

+ WriteWait time.Duration

+ func NewServerTimeoutConfig() ServerTimeoutConfig

+ type WebSocket struct

+ func (websocket *WebSocket) GetID() string

+ type WsClient interface

+ AddOption func(option interface{})

+ Errors func() <-chan error

+ IsConnected func() bool

+ SetBasicAuth func(username string, password string)

+ SetDisconnectedHandler func(handler func(err error))

+ SetHeaderValue func(key string, value string)

+ SetMessageHandler func(handler func(data []byte) error)

+ SetReconnectedHandler func(handler func())

+ SetTimeoutConfig func(config ClientTimeoutConfig)

+ Start func(url string) error

+ Stop func()

+ Write func(data []byte) error

+ type WsServer interface

+ AddSupportedSubprotocol func(subProto string)

+ Errors func() <-chan error

+ SetBasicAuthHandler func(handler func(username string, password string) bool)

+ SetCheckOriginHandler func(handler func(r *http.Request) bool)

+ SetDisconnectedClientHandler func(handler func(ws Channel))

+ SetMessageHandler func(handler func(ws Channel, data []byte) error)

+ SetNewClientHandler func(handler func(ws Channel))

+ SetTimeoutConfig func(config ServerTimeoutConfig)

+ Start func(port int, listenPath string)

+ Stop func()

+ Write func(webSocketId string, data []byte) error