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

Go to main page

Versions in this module

v0

v0.22.0

Mar 21, 2019

Changes in this version

type Client

+ func (c *Client) Start()

+ type ClientOpts struct

+ AuthOpts *shttp.AuthenticationOpts

+ Headers http.Header

+ Protocol Protocol

+ QueueSize int

+ TLSConfig *tls.Config

+ WriteCompression bool

type Conn

+ func (c *Conn) Flush()

+ func (c *Conn) Run()

+ func (c *Conn) Start()

+ func (c *Conn) Stop()

+ type ProtobufObject interface

+ type Protocol string

+ const RawProtocol

+ func (p *Protocol) String() string

+ type ServerOpts struct

+ PingDelay time.Duration

+ PongTimeout time.Duration

+ QueueSize int

+ WriteCompression bool

type Speaker

+ Start func()

+ Stop func()

v0.20.1

Dec 17, 2018

v0.19.1

Sep 14, 2018

Changes in this version

+ const JSONProtocol

+ const ProtobufProtocol

+ const WildcardNamespace

+ var DefaultRequestTimeout = 10 * time.Second

+ type Client struct

+ AuthOpts *shttp.AuthenticationOpts

+ Path string

+ func NewClient(host string, clientType common.ServiceType, url *url.URL, ...) *Client

+ func NewClientFromConfig(clientType common.ServiceType, url *url.URL, ...) *Client

+ func (c *Client) Connect()

+ func (c *Client) UpgradeToStructSpeaker() *StructSpeaker

+ type ClientPool struct

+ func NewClientPool(name string) *ClientPool

+ func (s *ClientPool) ConnectAll()

+ type Conn struct

+ func (c *Conn) AddEventHandler(h SpeakerEventHandler)

+ func (c *Conn) Connect()

+ func (c *Conn) Disconnect()

+ func (c *Conn) GetAddrPort() (string, int)

+ func (c *Conn) GetClientProtocol() string

+ func (c *Conn) GetHeaders() http.Header

+ func (c *Conn) GetHost() string

+ func (c *Conn) GetRemoteHost() string

+ func (c *Conn) GetRemoteServiceType() common.ServiceType

+ func (c *Conn) GetServiceType() common.ServiceType

+ func (c *Conn) GetStatus() ConnStatus

+ func (c *Conn) GetURL() *url.URL

+ func (c *Conn) IsConnected() bool

+ func (c *Conn) SendMessage(m Message) error

+ func (c *Conn) SendRaw(b []byte) error

+ type ConnState int32

+ func (s *ConnState) MarshalJSON() ([]byte, error)

+ func (s *ConnState) UnmarshalJSON(b []byte) error

+ type ConnStatus struct

+ Addr string

+ ClientProtocol string

+ ConnectTime time.Time

+ Headers http.Header

+ Host string

+ Port int

+ RemoteHost string

+ RemoteServiceType common.ServiceType

+ ServiceType common.ServiceType

+ State *ConnState

+ URL *url.URL

+ type DefaultSpeakerEventHandler struct

+ func (d *DefaultSpeakerEventHandler) OnConnected(c Speaker)

+ func (d *DefaultSpeakerEventHandler) OnDisconnected(c Speaker)

+ func (d *DefaultSpeakerEventHandler) OnMessage(c Speaker, m Message)

+ type IncomerHandler func(*websocket.Conn, *auth.AuthenticatedRequest) Speaker

+ type MasterElection struct

+ func NewMasterElection(pool SpeakerPool) *MasterElection

+ func (a *MasterElection) AddEventHandler(eventHandler MasterEventHandler)

+ func (a *MasterElection) GetMaster() Speaker

+ func (a *MasterElection) OnConnected(c Speaker)

+ func (a *MasterElection) OnDisconnected(c Speaker)

+ func (a *MasterElection) SendMessageToMaster(m Message)

+ type MasterEventHandler interface

+ OnNewMaster func(c Speaker)

+ type Message interface

+ Bytes func(protocol string) []byte

+ type Pool struct

+ func (s *Pool) AddClient(c Speaker) error

+ func (s *Pool) AddEventHandler(h SpeakerEventHandler)

+ func (s *Pool) BroadcastMessage(m Message)

+ func (s *Pool) DisconnectAll()

+ func (s *Pool) GetName() string

+ func (s *Pool) GetSpeakerByRemoteHost(host string) Speaker

+ func (s *Pool) GetSpeakers() (speakers []Speaker)

+ func (s *Pool) GetSpeakersByType(serviceType common.ServiceType) (speakers []Speaker)

+ func (s *Pool) GetStatus() map[string]ConnStatus

+ func (s *Pool) OnConnected(c Speaker)

+ func (s *Pool) OnDisconnected(c Speaker)

+ func (s *Pool) OnMessage(c Speaker, m Message)

+ func (s *Pool) PickConnectedSpeaker() Speaker

+ func (s *Pool) RemoveClient(c Speaker) bool

+ func (s *Pool) SendMessageTo(m Message, host string) error

+ func (s *Pool) Start()

+ func (s *Pool) Stop()

+ type RawMessage []byte

+ func (m RawMessage) Bytes(protocol string) []byte

+ type Server struct

+ func NewServer(server *shttp.Server, endpoint string, authBackend shttp.AuthenticationBackend) *Server

+ func (s Server) AddClient(c Speaker) error

+ func (s Server) OnDisconnected(c Speaker)

+ type Speaker interface

+ AddEventHandler func(SpeakerEventHandler)

+ Connect func()

+ Disconnect func()

+ GetAddrPort func() (string, int)

+ GetClientProtocol func() string

+ GetHeaders func() http.Header

+ GetHost func() string

+ GetRemoteHost func() string

+ GetRemoteServiceType func() common.ServiceType

+ GetServiceType func() common.ServiceType

+ GetStatus func() ConnStatus

+ GetURL func() *url.URL

+ IsConnected func() bool

+ SendMessage func(m Message) error

+ SendRaw func(r []byte) error

+ type SpeakerEventHandler interface

+ OnConnected func(c Speaker)

+ OnDisconnected func(c Speaker)

+ OnMessage func(c Speaker, m Message)

+ type SpeakerPool interface

+ AddClient func(c Speaker) error

+ AddEventHandler func(h SpeakerEventHandler)

+ BroadcastMessage func(m Message)

+ GetSpeakerByRemoteHost func(host string) Speaker

+ GetSpeakers func() []Speaker

+ PickConnectedSpeaker func() Speaker

+ RemoveClient func(c Speaker) bool

+ SendMessageTo func(m Message, host string) error

+ type SpeakerStructMessageDispatcher interface

+ AddStructMessageHandler func(h SpeakerStructMessageHandler, namespaces []string)

+ type SpeakerStructMessageHandler interface

+ OnStructMessage func(c Speaker, m *StructMessage)

+ type StructClientPool struct

+ func NewStructClientPool(name string) *StructClientPool

+ func (a *StructClientPool) AddClient(c Speaker) error

+ func (d StructClientPool) AddStructMessageHandler(h SpeakerStructMessageHandler, namespaces []string)

+ func (d StructClientPool) AddStructSpeaker(c *StructSpeaker)

+ func (s *StructClientPool) Request(host string, request *StructMessage, timeout time.Duration) (*StructMessage, error)

+ type StructMessage struct

+ JsonObj *json.RawMessage

+ Namespace string

+ ProtobufObj []byte

+ Protocol string

+ Status int64

+ Type string

+ UUID string

+ func NewStructMessage(ns string, tp string, v interface{}, uuids ...string) *StructMessage

+ func (g *StructMessage) Debug() string

+ func (g *StructMessage) DecodeObj(obj interface{}) error

+ func (g *StructMessage) Reply(v interface{}, kind string, status int) *StructMessage

+ func (g *StructMessage) UnmarshalObj(obj interface{}) error

+ func (g StructMessage) Bytes(protocol string) []byte

+ type StructMessageJSON struct

+ Namespace string

+ Obj *json.RawMessage

+ Status int64

+ Type string

+ UUID string

+ func (g *StructMessageJSON) Marshal() []byte

+ type StructServer struct

+ func NewStructServer(server *Server) *StructServer

+ func (d StructServer) AddStructMessageHandler(h SpeakerStructMessageHandler, namespaces []string)

+ func (d StructServer) AddStructSpeaker(c *StructSpeaker)

+ func (s *StructServer) OnConnected(c Speaker)

+ func (s *StructServer) OnDisconnected(c Speaker)

+ func (s *StructServer) OnMessage(c Speaker, m Message)

+ func (s *StructServer) Request(host string, request *StructMessage, timeout time.Duration) (*StructMessage, error)

+ func (s StructServer) AddClient(c Speaker) error

+ type StructSpeaker struct

+ func (a StructSpeaker) AddStructMessageHandler(h SpeakerStructMessageHandler, namespaces []string)

+ func (p StructSpeaker) OnConnected(c Speaker)

+ func (p StructSpeaker) OnDisconnected(c Speaker)

+ func (s *StructSpeaker) OnMessage(c Speaker, m Message)

+ func (s *StructSpeaker) Request(m *StructMessage, timeout time.Duration) (*StructMessage, error)

+ func (s *StructSpeaker) Send(m Message)

+ type StructSpeakerPool interface

+ Request func(host string, request *StructMessage, timeout time.Duration) (*StructMessage, error)