websocket

Documentation

Index

• func BroadcastMessage(msg string)
• func HandleWebSocketCommand(cmd, usage string, handler func(c *WebsocketConnection, array []string))
• func InitWebSocket(cfg config.WebsocketConfig)
• func SendPrivateMessage(session string, msg string)
• func ServeWs(w http.ResponseWriter, r *http.Request)
• type Hub
• type MsgType
• type WebsocketConnection
  • func (c *WebsocketConnection) Broadcast(msg string)
  • func (c *WebsocketConnection) WriteMessage(t MsgType, msg string) error
  • func (c *WebsocketConnection) WritePrivateMessage(msg string) error
• type WebsocketHandlerFunc

Functions

func BroadcastMessage

func BroadcastMessage(msg string)

BroadcastMessage send broadcast message to channel and record stats

func HandleWebSocketCommand

func HandleWebSocketCommand(cmd, usage string, handler func(c *WebsocketConnection, array []string))

HandleWebSocketCommand used to register command and handler

func InitWebSocket

func InitWebSocket(cfg config.WebsocketConfig)

InitWebSocket start websocket

func SendPrivateMessage

func SendPrivateMessage(session string, msg string)

func ServeWs

func ServeWs(w http.ResponseWriter, r *http.Request)

ServeWs handles websocket requests from the peer.

Types

type Hub

type Hub struct {
	// contains filtered or unexported fields
}

Hub maintains the set of active connections and broadcasts messages to the connections.

type MsgType

type MsgType string

MsgType is the type of different message

const (
	// PrivateMessage means message is 1 to 1
	PrivateMessage MsgType = "PRIVATE"
	// PublicMessage means broadcast message
	PublicMessage MsgType = "PUBLIC"
	// ConfigMessage used to send configuration
	ConfigMessage MsgType = "CONFIG"
)

type WebsocketConnection

type WebsocketConnection struct {
	// contains filtered or unexported fields
}

WebsocketConnection is an middleman between the websocket connection and the hub.

func (*WebsocketConnection) Broadcast

func (c *WebsocketConnection) Broadcast(msg string)

Broadcast public message to all channels

func (*WebsocketConnection) WriteMessage

func (c *WebsocketConnection) WriteMessage(t MsgType, msg string) error

WriteMessage will use the right way to write message, don't call c.write directly

func (*WebsocketConnection) WritePrivateMessage

func (c *WebsocketConnection) WritePrivateMessage(msg string) error

WritePrivateMessage will send msg to channel

type WebsocketHandlerFunc

type WebsocketHandlerFunc func(c *WebsocketConnection, array []string)

WebsocketHandlerFunc define the func to handle websocket