Documentation
¶
Index ¶
- type WebSocketDriver
- func (d *WebSocketDriver) Broadcast(channels []string, event string, data interface{}) error
- func (d *WebSocketDriver) BroadcastExcept(channels []string, event string, data interface{}, socketID string) error
- func (d *WebSocketDriver) GetClients(channel string) []string
- func (d *WebSocketDriver) GetServer() *websocket.Server
- func (d *WebSocketDriver) Subscribe(channel string, client *websocket.Client) error
- func (d *WebSocketDriver) Unsubscribe(channel string, clientID string) error
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type WebSocketDriver ¶
type WebSocketDriver struct {
// contains filtered or unexported fields
}
WebSocketDriver adapts the existing WebSocket server for broadcasting
func NewWebSocketDriver ¶
func NewWebSocketDriver(config websocket.Config) *WebSocketDriver
NewWebSocketDriver creates a new WebSocket driver
func (*WebSocketDriver) Broadcast ¶
func (d *WebSocketDriver) Broadcast(channels []string, event string, data interface{}) error
Broadcast sends an event to channels
func (*WebSocketDriver) BroadcastExcept ¶
func (d *WebSocketDriver) BroadcastExcept(channels []string, event string, data interface{}, socketID string) error
BroadcastExcept broadcasts to all except specified socket
func (*WebSocketDriver) GetClients ¶
func (d *WebSocketDriver) GetClients(channel string) []string
GetClients returns clients in a channel
func (*WebSocketDriver) GetServer ¶
func (d *WebSocketDriver) GetServer() *websocket.Server
GetServer returns the underlying WebSocket server
func (*WebSocketDriver) Subscribe ¶
func (d *WebSocketDriver) Subscribe(channel string, client *websocket.Client) error
Subscribe adds a client to a channel
func (*WebSocketDriver) Unsubscribe ¶
func (d *WebSocketDriver) Unsubscribe(channel string, clientID string) error
Unsubscribe removes a client from a channel
Source Files
Click to show internal directories.
Click to hide internal directories.