WebsocketDealer

Documentation

Overview

@Title WebsocketDealer.go @Description 实现websocket低成本call 需要客户端配合 @Author Dorbmon

Index

• Constants
• Variables
• func Decode(data []byte) ([]byte, error)
• func InitWebsocketDealer()
• type Coder
• type ConnectData
• type DefaultCoder
  • func (z *DefaultCoder) Encode(data []byte) []byte
• type FunctionCall
• type GlobalHandler
  • func NewGlobalHandler() GlobalHandler
  • func (z *GlobalHandler) GC()
  • func (z *GlobalHandler) MountUser(key interface{}, val interface{}) bool
  • func (z *GlobalHandler) SetDownFunction(f func(key interface{}, userData interface{}, lastBeatTime time.Time) bool)
  • func (z *GlobalHandler) SetMaxHandleTime(time time.Duration)
  • func (z *GlobalHandler) UserBeat(key interface{}) bool
• type NumberPool
  • func NewNumberPool(initNumber uint64) (ret NumberPool)
  • func (z *NumberPool) Get() uint64
  • func (z *NumberPool) Put(num uint64)
• type Ranger
• type Replier
  • func R() *Replier
  • func (z *Replier) Call(functionName string, args ...interface{}) (interface{}, error)
  • func (z *Replier) CallNotWait(functionName string, args ...interface{}) error
  • func (z *Replier) Return(data interface{}) error
  • func (z *Replier) ToCaller() *Replier
• type Session
  • func NewSession() *Session
  • func S() *Session
• type StandardCall
• type StandardReply
• type WebsocketCallInterceptor
• type WebsocketDealFunction
• type WebsocketDealer
  • func New() (r WebsocketDealer)
  • func (z *WebsocketDealer) AddInterceptor(interceptor WebsocketCallInterceptor)
  • func (z *WebsocketDealer) BindFunction(FunctionName string, Function WebsocketDealFunction) error
  • func (z *WebsocketDealer) BroadCast(ranger Ranger) error
  • func (z *WebsocketDealer) BroadCastIdRange(ranger Ranger, ids []uint64) error
  • func (z *WebsocketDealer) Handler(context *RWeb.Context)
• type WebsocketResponse

Constants

const (
	EventNewConnection = iota
	/*
		 	EventNewConnection call with *NewConnectData
			The caller of NewConnectData won't be collected.
	*/
	EventConnectionClose
	/*
		EventConnectionClose call with *NewConnectData.
		But you shouldn't write any data cause the connection had been close.
	*/
	EventFunctionCall
)

const (
	ModuleName    = "WebsocketDealer"
	ModuleVersion = 0.4
)

const EventNum = 3

Variables

var FunctionCallPool = sync.Pool{New: func() interface{} {
	return new(FunctionCall)
}}

var NewConnectDataPool = sync.Pool{New: func() interface{} {
	return new(ConnectData)
}}

var Once sync.Once

Functions

func Decode

func Decode(data []byte) ([]byte, error)

func InitWebsocketDealer

func InitWebsocketDealer()

Types

type Coder

type Coder interface {
	Encode([]byte) []byte
	Decode([]byte) ([]byte, error)
}

type ConnectData

type ConnectData struct {
	Session *Session
	Context *RWeb.Context
	Caller  *Replier
}

type DefaultCoder

type DefaultCoder struct{}

func (*DefaultCoder) Encode

func (z *DefaultCoder) Encode(data []byte) []byte

type FunctionCall

type FunctionCall struct {
	FunctionName string
	Argument     []interface{}
	Session      *Session
}

type GlobalHandler

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

func NewGlobalHandler

func NewGlobalHandler() GlobalHandler

func (*GlobalHandler) GC

func (z *GlobalHandler) GC()

func (*GlobalHandler) MountUser

func (z *GlobalHandler) MountUser(key interface{}, val interface{}) bool

func (*GlobalHandler) SetDownFunction

func (z *GlobalHandler) SetDownFunction(f func(key interface{}, userData interface{}, lastBeatTime time.Time) bool)

func (*GlobalHandler) SetMaxHandleTime

func (z *GlobalHandler) SetMaxHandleTime(time time.Duration)

SetMaxHandleTime when it takes too long for a user to send a heart beat message,the user will be kicked off from the server. The MaxHandleTime is the limit.

func (*GlobalHandler) UserBeat

func (z *GlobalHandler) UserBeat(key interface{}) bool

type NumberPool

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

func NewNumberPool

func NewNumberPool(initNumber uint64) (ret NumberPool)

newNumberPool 生成新的Pool initNumber 初始化的数字数量

func (*NumberPool) Get

func (z *NumberPool) Get() uint64

func (*NumberPool) Put

func (z *NumberPool) Put(num uint64)

type Ranger

type Ranger func(data *ConnectData) error

Ranger broadCast ranger

type Replier

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

func R

func R() *Replier

R get the replier

func (*Replier) Call

func (z *Replier) Call(functionName string, args ...interface{}) (interface{}, error)

Call 调用客户端函数

func (*Replier) CallNotWait

func (z *Replier) CallNotWait(functionName string, args ...interface{}) error

CallNotWait 不等待回复

func (*Replier) Return

func (z *Replier) Return(data interface{}) error

Return 返回值

func (*Replier) ToCaller

func (z *Replier) ToCaller() *Replier

ToCaller With this function,you can turn a replier to a pure caller which means that you can keep this new caller while the replier will be collected and reused by RWeb.

type Session

type Session struct {
	Data       interface{}
	CreateTime int64

	Id uuid.UUID
	// contains filtered or unexported fields
}

func NewSession

func NewSession() *Session

NewSession Build a session

func S

func S() *Session

S get the session

type StandardCall

type StandardCall struct {
	Function string          `json:"function"`
	Argument []interface{}   `json:"argument"`
	Id       jsoniter.Number `json:"id"`
	IsReply  bool            `json:"reply"` //只是保留，客户端不需要实现 若为Reply时，需要设置为true
}

type StandardReply

type StandardReply struct {
	Id   jsoniter.Number `json:"id"`
	Data interface{}     `json:"data"`
}

type WebsocketCallInterceptor

type WebsocketCallInterceptor func(functionName string, replier *Replier, session *Session, args []interface{}) bool

type WebsocketDealFunction

type WebsocketDealFunction interface{}

type WebsocketDealer

type WebsocketDealer struct {
	OriginCheck func(ctx *RWeb.Context) bool

	Events event.System
	// contains filtered or unexported fields
}

func New

func New() (r WebsocketDealer)

New new websocket dealer

func (*WebsocketDealer) AddInterceptor

func (z *WebsocketDealer) AddInterceptor(interceptor WebsocketCallInterceptor)

AddInterceptor 添加拦截器

func (*WebsocketDealer) BindFunction

func (z *WebsocketDealer) BindFunction(FunctionName string, Function WebsocketDealFunction) error

BindFunction 绑定函数

func (*WebsocketDealer) BroadCast

func (z *WebsocketDealer) BroadCast(ranger Ranger) error

BroadCast 广播

func (*WebsocketDealer) BroadCastIdRange

func (z *WebsocketDealer) BroadCastIdRange(ranger Ranger, ids []uint64) error

func (*WebsocketDealer) Handler

func (z *WebsocketDealer) Handler(context *RWeb.Context)

*

Handler 使用此函数作为引擎的绑定函数

type WebsocketResponse

type WebsocketResponse struct {
	Id      jsoniter.Number `json:"id"`
	Data    interface{}     `json:"data"`
	IsReply bool            `json:"reply"`
}