websocket

Documentation

Overview

Package websocket 接收客户端消息，根据消息内容解包，调用对应模块API处理，然后封装返回

Index

• Variables
• func RegisterCallFunc(cmd string, callFunc CallFunc)
• func RegisterCmd()
• type ActionWrap
• type CallFunc
• type DeviceWrap
• type Error
• type EventType
• type Message
  • func NewEvent(eventType string) *Message
  • func NewResponse(id int) *Message
  • func (cr Message) AddResult(key string, value interface{})
• type MsgType
• type Result
  • func CheckUpdate(cs callService) (result Result, err error)
  • func ConnectDevice(cs callService) (result Result, err error)
  • func DisconnectDevice(cs callService) (result Result, err error)
  • func GetAttrs(cs callService) (result Result, err error)
  • func OTA(cs callService) (result Result, err error)
  • func SetAttrs(cs callService) (result Result, err error)
  • func UpdateThingModel(cs callService) (result Result, err error)
• type Server
  • func NewWebSocketServer() *Server
  • func (s *Server) AcceptWebSocket(c *gin.Context)
  • func (s *Server) Broadcast(areaID uint64, data []byte)
  • func (s *Server) OnDeviceChange(em event2.EventMessage) error
  • func (s *Server) Run(ctx context.Context)
  • func (s *Server) SingleCast(cliID string, data []byte) error

Variables

var (
	ErrClientNotFound = errors.New("client not found")
)

Functions

func RegisterCallFunc

func RegisterCallFunc(cmd string, callFunc CallFunc)

func RegisterCmd

func RegisterCmd()

Types

type ActionWrap

type ActionWrap struct {
	Cmd      string `json:"cmd"`
	Name     string `json:"name"`
	IsPermit bool   `json:"is_permit"`
}

type CallFunc

type CallFunc func(service callService) (Result, error)

type DeviceWrap

type DeviceWrap struct {
	Cmd      string `json:"cmd"`
	Name     string `json:"name"`
	IsPermit bool   `json:"is_permit"`
}

type Error

type Error struct {
	Code    codes.Code `json:"code"`
	Message string     `json:"message"`
}

type EventType

type EventType string

type Message

type Message struct {
	Type MsgType `json:"type"`
	// contains filtered or unexported fields
}

func NewEvent

func NewEvent(eventType string) *Message

func NewResponse

func NewResponse(id int) *Message

func (Message) AddResult

func (cr Message) AddResult(key string, value interface{})

type MsgType

type MsgType string

const (
	MsgTypeResponse MsgType = "response"
	MsgTypeEvent    MsgType = "event"
)

消息类型

type Result

type Result map[string]interface{}

func CheckUpdate

func CheckUpdate(cs callService) (result Result, err error)

CheckUpdate 检查设备是否有更新

func ConnectDevice

func ConnectDevice(cs callService) (result Result, err error)

ConnectDevice 连接设备 TODO 直接替代添加设备接口？

func DisconnectDevice

func DisconnectDevice(cs callService) (result Result, err error)

DisconnectDevice 设备断开连接（取消配对等） TODO 直接替代删除设备接口？

func GetAttrs

func GetAttrs(cs callService) (result Result, err error)

func OTA

func OTA(cs callService) (result Result, err error)

OTA 更新固件

func SetAttrs

func SetAttrs(cs callService) (result Result, err error)

func UpdateThingModel

func UpdateThingModel(cs callService) (result Result, err error)

UpdateThingModel 更新设备的影子模型字段

type Server

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

Server WebSocket服务端

func NewWebSocketServer

func NewWebSocketServer() *Server

func (*Server) AcceptWebSocket

func (s *Server) AcceptWebSocket(c *gin.Context)

func (*Server) Broadcast

func (s *Server) Broadcast(areaID uint64, data []byte)

func (*Server) OnDeviceChange

func (s *Server) OnDeviceChange(em event2.EventMessage) error

OnDeviceChange 设备状态,数量改变回调，会广播给所有客户端，并且触发场景

func (*Server) Run

func (s *Server) Run(ctx context.Context)

func (*Server) SingleCast

func (s *Server) SingleCast(cliID string, data []byte) error

SingleCast 发送单播消息