传输模块扩展

remote_module

Kitex 默认集成了自研的高性能网络库 Netpoll,但没有与 Netpoll 强绑定,同时也支持使用者扩展其他网络库按需选择。Kitex 还提供了 ShmIPC 进一步提升 IPC 性能,该扩展会在后续开源。

扩展接口

传输模块主要的扩展接口如下:

type TransServer interface {...}

type ServerTransHandler interface {...}

type ClientTransHandler interface {...}

type ByteBuffer interface {...}

type Extension interface {...}

// -------------------------------------------------------------
// TransServerFactory is used to create TransServer instances.
type TransServerFactory interface {
  NewTransServer(opt *ServerOption, transHdlr ServerTransHandler) TransServer
}

// ClientTransHandlerFactory to new TransHandler for client
type ClientTransHandlerFactory interface {
  NewTransHandler(opt *ClientOption) (ClientTransHandler, error)
}

// ServerTransHandlerFactory to new TransHandler for server
type ServerTransHandlerFactory interface {
  NewTransHandler(opt *ServerOption) (ServerTransHandler, error)
}

TransServer 是服务端的启动接口,ServerTransHandler 和 ClientTransHandler 分别是服务端和调用端对消息的处理接口,ByteBuffer 是读写接口。相同的 IO 模型下 TransHandler 的逻辑通常是一致的,Kitex 对同步 IO 提供了默认实现的 TransHandler,针对不一样的地方抽象出了 Extension 接口,所以在同步 IO 的场景下不需要实现完整的 TransHandler 接口,只需实现 Extension 即可。

Netpoll 的扩展

如下是 Kitex 对 Netpoll 同步 IO 的扩展,分别实现了Extension、ByteBuffer、TransServer 接口。

netpoll_extension

指定自定义的传输模块

  • 服务端

    option: WithTransServerFactory, WithTransHandlerFactory

    var opts []server.Option
    opts = append(opts, server.WithTransServerFactory(yourTransServerFactory)
    opts = append(opts, server.WithTransHandlerFactory(yourTransHandlerFactory)
    
    svr := xxxservice.NewServer(handler, opts...)
    
  • 调用端

    option: WithTransHandlerFactory

    cli, err := xxxservice.NewClient(targetService, client.WithTransHandlerFactory(yourTransHandlerFactory)
    

最后修改 December 2, 2022 : chore: add lark footer link (#460) (f41a884)