message

package

v0.2.2 Latest Latest Go to latest Published: Apr 7, 2020 License: Apache-2.0 Imports: 6 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/lightjiang/webds

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
Variables
func IsInnerTopic(t Topic) bool
func IsPublicTopic(t Topic) bool
func IsSysTopic(t Topic) bool
func TypeofTopic(t Topic) string
type Func
type FuncBlank
type FuncBool
type FuncBytes
type FuncDefault
type FuncInt
type FuncString
type MsgType
- func (m MsgType) Name() string
- func (m MsgType) String() string
type Serializer
- func NewSerializer(messagePrefix []byte) *Serializer
- func (ms *Serializer) Deserialize(t Topic, websocketMessage []byte) (interface{}, MsgType, error)
- func (ms *Serializer) GetMsgTopic(websocketMessage []byte) Topic
- func (ms *Serializer) Serialize(t Topic, data interface{}) ([]byte, error)
type Topic
- func NewTopic(t string) Topic

Constants ¶

View Source

const (
	PublicTopic = ""
	// 用户保留主题 不会进行广播
	InnerTopic = "inner"
	// 系统保留主题 不会触发任何注册的回调函数
	SysTopic = "sys"
)

Variables ¶

View Source

var (
	TopicSubscribe = NewTopic("/sys/subscribe")
	TopicCancel    = NewTopic("/sys/cancel")
	TopicCancelAll = NewTopic("/sys/cancel_all")
	// 敏感操作 仅来自127.0.0.1的节点通过判定
	TopicGetAllTopics = NewTopic("/sys/admin/get_all_topics")
	TopicGetAllNodes  = NewTopic("/sys/admin/get_all_nodes")
	TopicStopNode     = NewTopic("/sys/admin/stop_node")

	TopicSysLog = NewTopic("/sys/log")
	TopicAuth   = NewTopic("/sys/auth")
)

View Source

var (
	ErrNotAllowedTopic = errors.New("this topic is not allowed to subscribe or publish")
	ErrUnformedMsg     = errors.New("unformed Msg")
)

View Source

var InvalidMessage = errors.New("invalid message")

Functions ¶

func IsInnerTopic ¶

func IsInnerTopic(t Topic) bool

func IsPublicTopic ¶

func IsPublicTopic(t Topic) bool

func IsSysTopic ¶

func IsSysTopic(t Topic) bool

func TypeofTopic ¶

func TypeofTopic(t Topic) string

Types ¶

type Func ¶ added in v0.2.2

type Func interface{}

A callback which should receives one parameter of type string, int, bool or any valid JSON/Go struct

type FuncBlank ¶ added in v0.2.2

type FuncBlank = func()

type FuncBool ¶ added in v0.2.2

type FuncBool = func(bool)

type FuncBytes ¶ added in v0.2.2

type FuncBytes = func([]byte)

type FuncDefault ¶ added in v0.2.2

type FuncDefault = func(interface{})

type FuncInt ¶ added in v0.2.2

type FuncInt = func(int)

type FuncString ¶ added in v0.2.2

type FuncString = func(string)

type MsgType ¶ added in v0.2.2

type MsgType string

const (
	MsgTypeString MsgType = "0"
	MsgTypeInt    MsgType = "1"
	MsgTypeBool   MsgType = "2"
	MsgTypeBytes  MsgType = "3"
	MsgTypeJSON   MsgType = "4"
)

The same values are exists on client side too.

func (MsgType) Name ¶ added in v0.2.2

func (m MsgType) Name() string

func (MsgType) String ¶ added in v0.2.2

func (m MsgType) String() string

type Serializer ¶

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

func NewSerializer ¶

func NewSerializer(messagePrefix []byte) *Serializer

func (*Serializer) Deserialize ¶

func (ms *Serializer) Deserialize(t Topic, websocketMessage []byte) (interface{}, MsgType, error)

deserialize deserializes a custom websocket message from the client such as prefix:topic;0:abc_msg Supported data types are: string, int, bool, bytes and JSON.

func (*Serializer) GetMsgTopic ¶

func (ms *Serializer) GetMsgTopic(websocketMessage []byte) Topic

getWebsocketCustomEvent return empty string when the websocketMessage is native message

func (*Serializer) Serialize ¶

func (ms *Serializer) Serialize(t Topic, data interface{}) ([]byte, error)

websocketMessageSerialize serializes a custom websocket message from websocketServer to be delivered to the client returns the string form of the message Supported data types are: string, int, bool, bytes and JSON.

type Topic ¶

type Topic interface {
	String() string
	FirstFragment() string
	Fragment(int) string
	Since(int) string
	Len() int
}

func NewTopic ¶

func NewTopic(t string) Topic

Source Files ¶

View all Source files

message.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL