Skip to content

Latest commit

 

History

History
175 lines (127 loc) · 4.01 KB

README.zh.md

File metadata and controls

175 lines (127 loc) · 4.01 KB
Raw

Build Status Coverage Status

FlyRPC，用最少的流量满足最多的需求。

go get gopkg.in/flyrpc.v1

协议

消息协议

Name Length Flag Transfer Flag Sequence CMD Len CMD Buffer CRC16
Bytes 2 1 1 2 1 * * 2
消息长度 标志位 传输控制位 序列ID 命令长度 命令ID 消息体 校验

Flag说明

子协议 控制位
2 bit 6 bit
子协议 1 2 3 4 5 6 7 8
RPC 1 1 ? CRC16 Buffer Error Resp Req
Ping 1 0 ? CRC16 ? ? Pong Ping
Helo 0 1 ? CRC16 ? ? ? ?
MQ 0 0 ? CRC16 ? ? ? ?

CRC16 允许加盐

Transfer Flag

Transfer Flag 0x00 should be plain json.

Not complete.

Design A

Accept Encoding Encoding Accept Serializer Serializer
2 bits 2 bits 2 bits 2 bits

Up to 4 encoding and 4 serializer.

Design B

Encoding Serializer
2 bits 2 bits

If HELO, it means Accept-Encoding and Accept-Serializer

Up to 16 encoding and 16 serializer. (Who need 16 encoding and 16 serializer)

Buffer

如果Error为1，Buffer为 string

服务器内部多路复用协议

Client count Client Id 1 ... Client Id n Buffer Length Buffer
1 byte 2 byte ... 2 byte 2byte n byte

草案

模式

  • [OK]Send/Recv
  • [OK]Req/Res
  • Pub/Sub

网络协议

  • [OK]TCP
  • UDP
  • Websocket
  • P2P

序列化接口

  • 数据压缩
  • [OK]自定义
  • [OK]json
  • [OK]protobuf (proto3)
  • [OK]msgpack

多路复用

  • Gateway Node
  • Backend Node

API

type MessageHandler

MessageHandler 可以有以下几种形式的参数的组合或无参数

  • *Context
  • *Packet
  • []byte
  • *UserCustomMessage

返回可以是：

  • UserCustomMessage
  • UserCustomMessage, error
  • non return
  • error
// 有返回值，用于处理Call
func(*Context, in MyMessage) (out Message, err error)
func(*Packet, in MyMessage) out Message

// 无返回值，用于处理SendMessage
func(bytes []byte) err error
func()

Server.Listen(addr)

Server.OnMessage(cmd, MessageHandler)

Context.SendMessage(cmd, Message)

Context.Call(cmd, Message) (Message, error)

Context.Ping(length, timeout) error

Client.Connect(addr)

Client.OnMessage(cmd, MessageHandler)

Client.SendMessage(cmd, Message)

Client.Call(cmd, Message) (Message, error)

Client.Ping(length, timeout) error

待定

type ClientStub struct {
    foo func(a) b `flyid:1`
}

rpc := &ClientStub{}
client.InjectService(rpc)
b := rpc.foo(a)

类关联结构

TCP/UDP/WS        Packet    json/protobuf/msgpack
 |                + + +                   |
 |                | | |                   |
 -->Protocol ------ | |      Serializer <--
      +       ------- |          +
      |       | ----Route --------
      |       | |     *+
      |       | |     |
      |       | |   Router
      |       | |    + +
      ------- | | ---- |
          1*| | + |    |
       --->Context     |
       |transport+*    |
       |        ------ |
       |             | |
 -->Client          Server<--   MultiplexedServer<--
 |                          |                      |
 |                          |                      |
TCP/UDP/WS            TCP/UDP/WS               TCP/UDP/WS
  • * 多实例
  • --> 继承或实现
  • + 被引用