message

Documentation

Index

• Variables
• func ShortVersion(version string) uint32
• func WriteDictionary(items []*clusterpb.DictionaryItem)
• func WriteDictionaryItem(route string, code uint32)
• type Dictionary
• type LuaDictionary
  • func NewLuaDictionary(file string) *LuaDictionary
  • func (d *LuaDictionary) IndexCode(code uint32) (string, error)
  • func (d *LuaDictionary) IndexRoute(route string) (uint32, error)
  • func (d *LuaDictionary) InitModule(l *lua.LState) int
  • func (d *LuaDictionary) LoadLua(file string)
• type MemberDictionary
  • func DuplicateDictionary() *MemberDictionary
  • func NewMemberDictionary() *MemberDictionary
  • func (d *MemberDictionary) IndexCode(code uint32) (string, error)
  • func (d *MemberDictionary) IndexRoute(route string) (uint32, error)
• type Message
  • func New() *Message
  • func (m *Message) Serializer() serializer.Serializer
  • func (m *Message) String() string
  • func (m *Message) TypeValid() bool
• type Type
  • func (t Type) String() string

Variables

var (
	EmptyDictionary = NewMemberDictionary()
)

var ErrIndexCodeNotFound = errors.New("dictionary: index code not found")

var ErrIndexRouteNotFound = errors.New("dictionary: index route not found")

Functions

func ShortVersion

func ShortVersion(version string) uint32

func WriteDictionary

func WriteDictionary(items []*clusterpb.DictionaryItem)

WriteDictionary is to set dictionary when new route dictionary is found.

func WriteDictionaryItem

func WriteDictionaryItem(route string, code uint32)

WriteDictionaryItem is to set dictionary item when server registers.

Types

type Dictionary

type Dictionary interface {
	IndexRoute(string) (uint32, error)
	IndexCode(uint32) (string, error)
}

type LuaDictionary

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

func NewLuaDictionary

func NewLuaDictionary(file string) *LuaDictionary

func (*LuaDictionary) IndexCode

func (d *LuaDictionary) IndexCode(code uint32) (string, error)

func (*LuaDictionary) IndexRoute

func (d *LuaDictionary) IndexRoute(route string) (uint32, error)

func (*LuaDictionary) InitModule

func (d *LuaDictionary) InitModule(l *lua.LState) int

func (*LuaDictionary) LoadLua

func (d *LuaDictionary) LoadLua(file string)

type MemberDictionary

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

func DuplicateDictionary

func DuplicateDictionary() *MemberDictionary

DuplicateDictionary returns dictionary for compressed route.

func NewMemberDictionary

func NewMemberDictionary() *MemberDictionary

func (*MemberDictionary) IndexCode

func (d *MemberDictionary) IndexCode(code uint32) (string, error)

func (*MemberDictionary) IndexRoute

func (d *MemberDictionary) IndexRoute(route string) (uint32, error)

type Message

type Message struct {
	Type      Type   // message type
	Branch    uint32 // client branch
	ShortVer  uint32 // message short version
	ID        uint64 // unique id, zero while notify mode
	UnixTime  uint32 // unix time in seconds
	SessionID uint64 // server session id int64
	Route     string // route for locating service
	DataType  uint32 // data type
	Data      []byte // payload
}

Message represents a unmarshaled message or a message which to be marshaled

func New

func New() *Message

New returns a new message instance

func (*Message) Serializer

func (m *Message) Serializer() serializer.Serializer

func (*Message) String

func (m *Message) String() string

String, implementation of fmt.Stringer interface

func (*Message) TypeValid

func (m *Message) TypeValid() bool

type Type

type Type byte

Type represents the type of message, which could be Request/Notify/Response/Push

const (
	Request Type = iota
	Notify
	Response
	Push
)

Message types

func (Type) String

func (t Type) String() string