/
module.go
128 lines (116 loc) · 4.82 KB
/
module.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
// Copyright 2014 mqant Author. All Rights Reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package module
import (
"github.com/liangdas/mqant/conf"
"github.com/liangdas/mqant/gate"
"github.com/liangdas/mqant/rpc"
opentracing "github.com/opentracing/opentracing-go"
)
type ServerSession interface {
GetId() string
GetType() string
GetRpc() mqrpc.RPCClient
Call(_func string, params ...interface{}) (interface{}, string)
CallNR(_func string, params ...interface{}) (err error)
CallArgs(_func string, ArgsType []string, args [][]byte) (interface{}, string)
CallNRArgs(_func string, ArgsType []string, args [][]byte) (err error)
}
type App interface {
Run(debug bool, mods ...Module) error
/**
当同一个类型的Module存在多个服务时,需要根据情况选择最终路由到哪一个服务去
fn: func(moduleType string,serverId string,[]*ServerSession)(*ServerSession)
*/
Route(moduleType string, fn func(app App, Type string, hash string) ServerSession) error
Configure(settings conf.Config) error
OnInit(settings conf.Config) error
OnDestroy() error
RegisterLocalClient(serverId string, server mqrpc.RPCServer) error
GetServersById(id string) (ServerSession, error)
/**
filter 调用者服务类型 moduleType|moduleType@moduleID
Type 想要调用的服务类型
*/
GetRouteServers(filter string, hash string) (ServerSession, error) //获取经过筛选过的服务
GetServersByType(Type string) []ServerSession
GetSettings() conf.Config //获取配置信息
RpcInvoke(module RPCModule, moduleType string, _func string, params ...interface{}) (interface{}, string)
RpcInvokeNR(module RPCModule, moduleType string, _func string, params ...interface{}) error
/**
添加一个 自定义参数序列化接口
gate,system 关键词一被占用请使用其他名称
*/
AddRPCSerialize(name string, Interface RPCSerialize) error
GetRPCSerialize() map[string]RPCSerialize
DefaultTracer(func() opentracing.Tracer) error
GetTracer() opentracing.Tracer
GetModuleInited() func(app App, module Module)
GetJudgeGuest() func(session gate.Session) bool
OnConfigurationLoaded(func(app App)) error
OnModuleInited(func(app App, module Module)) error
OnStartup(func(app App)) error
SetJudgeGuest(judgeGuest func(session gate.Session) bool) error
}
type Module interface {
Version() string //模块版本
GetType() string //模块类型
OnAppConfigurationLoaded(app App) //当App初始化时调用,这个接口不管这个模块是否在这个进程运行都会调用
OnConfChanged(settings *conf.ModuleSettings) //为以后动态服务发现做准备
OnInit(app App, settings *conf.ModuleSettings)
OnDestroy()
GetApp() App
Run(closeSig chan bool)
}
type RPCModule interface {
Module
GetServerId() string //模块类型
RpcInvoke(moduleType string, _func string, params ...interface{}) (interface{}, string)
RpcInvokeNR(moduleType string, _func string, params ...interface{}) error
RpcInvokeArgs(moduleType string, _func string, ArgsType []string, args [][]byte) (interface{}, string)
RpcInvokeNRArgs(moduleType string, _func string, ArgsType []string, args [][]byte) error
GetModuleSettings() (settings *conf.ModuleSettings)
/**
filter 调用者服务类型 moduleType|moduleType@moduleID
Type 想要调用的服务类型
*/
GetRouteServers(filter string, hash string) (ServerSession, error)
GetStatistical() (statistical string, err error)
GetExecuting() int64
}
/**
rpc 自定义参数序列化接口
*/
type RPCSerialize interface {
/**
序列化 结构体-->[]byte
param 需要序列化的参数值
@return ptype 当能够序列化这个值,并且正确解析为[]byte时 返回改值正确的类型,否则返回 ""即可
@return p 解析成功得到的数据, 如果无法解析该类型,或者解析失败 返回nil即可
@return err 无法解析该类型,或者解析失败 返回错误信息
*/
Serialize(param interface{}) (ptype string, p []byte, err error)
/**
反序列化 []byte-->结构体
ptype 参数类型 与Serialize函数中ptype 对应
b 参数的字节流
@return param 解析成功得到的数据结构
@return err 无法解析该类型,或者解析失败 返回错误信息
*/
Deserialize(ptype string, b []byte) (param interface{}, err error)
/**
返回这个接口能够处理的所有类型
*/
GetTypes() []string
}