Documentation ¶
Overview ¶
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.
Index ¶
- type App
- type ClientRPChandler
- type Module
- type Option
- func BILogDir(v string) Option
- func Configure(v string) Option
- func Debug(t bool) Option
- func KillWaitTTL(t time.Duration) Option
- func LogDir(v string) Option
- func Nats(nc *nats.Conn) Option
- func ProcessID(v string) Option
- func RegisterInterval(t time.Duration) Option
- func RegisterTTL(t time.Duration) Option
- func Registry(r registry.Registry) Option
- func Selector(r selector.Selector) Option
- func SetClientRPChandler(t ClientRPChandler) Option
- func Version(v string) Option
- func WorkDir(v string) Option
- type Options
- type ProtocolMarshal
- type RPCModule
- type RPCSerialize
- type ServerSession
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type App ¶
type App interface { Run(mods ...Module) error SetMapRoute(fn func(app App, route string) string) error Configure(settings conf.Config) error OnInit(settings conf.Config) error OnDestroy() error Options() Options Transport() *nats.Conn Registry() registry.Registry GetServerById(id string) (ServerSession, error) /** filter 调用者服务类型 moduleType|moduleType@moduleID Type 想要调用的服务类型 */ GetRouteServer(filter string, opts ...selector.SelectOption) (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 RpcCall(ctx context.Context, moduleType, _func string, param mqrpc.ParamOption, opts ...selector.SelectOption) (interface{}, string) /** 添加一个 自定义参数序列化接口 gate,system 关键词一被占用请使用其他名称 */ AddRPCSerialize(name string, Interface RPCSerialize) error GetRPCSerialize() map[string]RPCSerialize GetModuleInited() func(app App, module Module) OnConfigurationLoaded(func(app App)) error OnModuleInited(func(app App, module Module)) error OnStartup(func(app App)) error SetProtocolMarshal(protocolMarshal func(Trace string, Result interface{}, Error string) (ProtocolMarshal, string)) error /** 与客户端通信的协议包接口 */ ProtocolMarshal(Trace string, Result interface{}, Error string) (ProtocolMarshal, string) NewProtocolMarshal(data []byte) ProtocolMarshal GetProcessID() string WorkDir() string }
type ClientRPChandler ¶ added in v1.1.13
type Module ¶
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 Option ¶
type Option func(*Options)
func KillWaitTTL ¶
RegisterInterval specifies the interval on which to re-register
func RegisterInterval ¶
RegisterInterval specifies the interval on which to re-register
func RegisterTTL ¶
RegisterTTL specifies the TTL to use when registering the service
func SetClientRPChandler ¶ added in v1.1.13
func SetClientRPChandler(t ClientRPChandler) Option
RegisterInterval specifies the interval on which to re-register
type Options ¶
type Options struct { Nats *nats.Conn Version string Debug bool WorkDir string ConfPath string LogDir string BIDir string ProcessID string KillWaitTTL time.Duration Registry registry.Registry Selector selector.Selector // Register loop interval RegisterInterval time.Duration RegisterTTL time.Duration ClientRPChandler ClientRPChandler }
type ProtocolMarshal ¶
type ProtocolMarshal interface {
GetData() []byte
}
type RPCModule ¶
type RPCModule interface { context.Context 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 /* 通用RPC调度函数 ctx context.Context 上下文,可以设置这次请求的超时时间 moduleType string 服务名称 _func string 需要调度的服务方法 param mqrpc.ParamOption 方法传参 opts ...selector.SelectOption 服务发现模块过滤,可以用来选择调用哪个服务节点 */ RpcCall(ctx context.Context, moduleType, _func string, param mqrpc.ParamOption, opts ...selector.SelectOption) (interface{}, string) GetModuleSettings() (settings *conf.ModuleSettings) /** filter 调用者服务类型 moduleType|moduleType@moduleID Type 想要调用的服务类型 */ GetRouteServer(filter string, opts ...selector.SelectOption) (ServerSession, error) GetStatistical() (statistical string, err error) GetExecuting() int64 }
type RPCSerialize ¶
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 }
* rpc 自定义参数序列化接口
type ServerSession ¶
type ServerSession interface { GetId() string GetName() string GetRpc() mqrpc.RPCClient GetApp() App GetNode() *registry.Node SetNode(node *registry.Node) (err error) Call(ctx context.Context, _func string, params ...interface{}) (interface{}, string) CallNR(_func string, params ...interface{}) (err error) CallArgs(ctx context.Context, _func string, ArgsType []string, args [][]byte) (interface{}, string) CallNRArgs(_func string, ArgsType []string, args [][]byte) (err error) }