wssvr

Documentation

Index

• func WebsocketServer(opts ...WsServerOption) register.RegisterOption
• type BroadcastInput
• type BroadcastOutput
• type Client
  • func NewClient(uid, groupId string, hub *WsServer, w http.ResponseWriter, r *http.Request) (*Client, error)
  • func (c *Client) Close()
  • func (c *Client) Start()
• type Config
• type MessageBox
• type MessageType
• type WsServer
  • func (ws *WsServer) ExitRoom(uid, groupId string) error
  • func (ws *WsServer) JoinRoom(uid, groupId string) error
  • func (ws *WsServer) Name() string
  • func (ws *WsServer) Ready()
  • func (ws *WsServer) SendMessage(uid string, targets []string, msg string)
  • func (ws *WsServer) Start(ctx context.Context) error
  • func (ws *WsServer) Watch() map[string]int
• type WsServerOption
  • func SetWsConfig(cfgs ...Config) WsServerOption
  • func SetWsName(name string) WsServerOption

Functions

func WebsocketServer

func WebsocketServer(opts ...WsServerOption) register.RegisterOption

Types

type BroadcastInput

type BroadcastInput struct {
	ClientId string
	GroupId  string
	Msg      []byte
}

type BroadcastOutput

type BroadcastOutput struct {
	Type   MessageType `json:"type"`
	Value  string      `json:"value"`
	Values []string    `json:"values"`
	Msg    []byte      `json:"msg"`
}

type Client

type Client struct {
	ClientId string
	GroupId  string
	// contains filtered or unexported fields
}

func NewClient

func NewClient(uid, groupId string, hub *WsServer, w http.ResponseWriter, r *http.Request) (*Client, error)

func (*Client) Close

func (c *Client) Close()

func (*Client) Start

func (c *Client) Start()

type Config

type Config struct {
	Name              string
	WriteWait         time.Duration
	PongWait          time.Duration
	PingPeriod        time.Duration
	MaxMessageSize    int64
	ReadBufferSize    int64
	WriteBufferSize   int64
	MaxMsgChannelSize int64
}

type MessageBox

type MessageBox struct {
	Title struct {
		SysMsg int    `json:"sys_msg"`
		Source string `json:"source"`
		Target string `json:"target"`
	} `json:"title"`
	Body string `json:"body"`
}

前端约定的消息实体

type MessageType

type MessageType string

var (
	MessageAll     MessageType = "all"     // 全局消息
	MessageGroup   MessageType = "room"    // 房间消息
	MessageClient  MessageType = "client"  // 单点客户端消息
	MessageClients MessageType = "clients" // 一组客户目标消息
	MessageSys     MessageType = "sys"     // 系统消息
)

type WsServer

type WsServer struct {
	WriteWait         time.Duration `toml:"write_wait"`
	PongWait          time.Duration `toml:"pong_wait"`
	PingPeriod        time.Duration `toml:"ping_period"`
	ReadBufferSize    int64         `toml:"read_buffer_size"`
	WriteBufferSize   int64         `toml:"write_buffer_size"`
	MaxMessageSize    int64         `toml:"max_message_size"`
	MaxMsgChannelSize int64         `toml:"max_msg_channel_size"`
	// contains filtered or unexported fields
}

var (
	WsSvc *WsServer
)

func (*WsServer) ExitRoom

func (ws *WsServer) ExitRoom(uid, groupId string) error

func (*WsServer) JoinRoom

func (ws *WsServer) JoinRoom(uid, groupId string) error

func (*WsServer) Name

func (ws *WsServer) Name() string

func (*WsServer) Ready

func (ws *WsServer) Ready()

func (*WsServer) SendMessage

func (ws *WsServer) SendMessage(uid string, targets []string, msg string)

func (*WsServer) Start

func (ws *WsServer) Start(ctx context.Context) error

func (*WsServer) Watch

func (ws *WsServer) Watch() map[string]int

type WsServerOption

type WsServerOption func(*WsServer)

func SetWsConfig

func SetWsConfig(cfgs ...Config) WsServerOption

func SetWsName

func SetWsName(name string) WsServerOption