-
Notifications
You must be signed in to change notification settings - Fork 5
/
message.go
237 lines (210 loc) · 6.05 KB
/
message.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
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
package message
import (
container2 "github.com/nyan233/littlerpc/core/container"
)
const (
MagicNumber uint8 = 0x45
// Call 表示这是一条调用的消息
Call uint8 = 0x10
// Return 表示这是一条调用返回消息
Return uint8 = 0x18
// ContextCancel 用户服务端接收的context.Context的取消API
ContextCancel uint8 = 0x24
// Ping Ping消息
Ping uint8 = 0x33
// Pong Pong消息
Pong uint8 = 0x35
// BaseLen 的基本长度
BaseLen = _ScopeLength + 4 + 8
// DefaultPacker TODO: 将Encoder改为Packer
DefaultPacker string = "text" // encoding == text
DefaultCodec string = "json" // codec == text
ErrorCode string = "code"
ErrorMessage string = "message"
ErrorMore string = "bin"
ContextId string = "context-id"
CodecScheme string = "codec"
// PackerScheme TODO: 将Encoder改为Packer
PackerScheme string = "packer"
)
const (
_ScopeLength = 2
_ServiceName = 1
_Metadata = 1
_PayloadLayout = 1
)
type Getter interface {
First() uint8
BaseLength() int
Length() uint32
GetAndSetLength() uint32
GetMsgType() uint8
GetServiceName() string
GetMsgId() uint64
Payloads() container2.Slice[byte]
PayloadsIterator() *container2.Iterator[[]byte]
MinMux() int
}
type Setter interface {
GetAndSetLength() uint32
SetMsgType(msgTyp uint8)
SetServiceName(serviceName string)
SetMsgId(msgId uint64)
AppendPayloads(p []byte)
ReWritePayload(p []byte)
SetPayloads(payloads []byte)
Reset()
}
type GetterSetter interface {
Getter
Setter
}
func New() *Message {
return &Message{
MetaData: container2.NewSliceMap[string, string](4),
scope: [2]uint8{MagicNumber},
payloadLayout: make([]uint32, 0, 2),
payloads: nil,
}
}
// Message 是对一次RPC调用传递的数据的描述
// 封装的方法均不是线程安全的
// DecodeHeader会修改一些内部值,调用时需要注意顺序
// 为了使用一致性的API,在访问内部一些简单的属性时,请使用Getxx方法
// 在设置一些值的过程中可能需要调整其它值,所以请使用Setxx方法
type Message struct {
// int/uint数值统一使用大端序
// [0] == Magic (魔数,表示这是由littlerpc客户端发起或者服务端回复)
// [1] == MsgType (call/return & ping/pong)
scope [2]uint8
// 消息ID,用于表示一次完整的call/return的回复
msgId uint64
// 载荷数据的总长度
payloadLength uint32
// 实例名和调用方法名的布局
// Length (1 Byte) | ServiceName
serviceName string
// NOTE:
// 有效载荷和元数据的范围
// 在Mux模式中MetaData及其Desc必须能在一个MuxBlock下被装下,否则将会丢失数据
// 元数据的布局
// NMetaData(1 Byte)|Key-Size(4 Byte)|Value-Size(4 Byte)|Key|Size
// Example :
// "hello":"world","world:hello"
// OutPut:
// 0x00000002|0x00000005|0x00000005|hello|world|0x00000005|0x00000005|world|hello
MetaData *container2.SliceMap[string, string]
// 有效载荷数据的布局描述
// Format :
// NArgs(1 Byte)|Arg1-Size(4 Byte)|Arg2-Size(4 Byte)|Arg3-Size(4 Byte)
// Example :
// {"mypyload1":"haha"},{"mypyload2":"hehe"}
// OutPut:
// 0x00000002|0x00000014|0x00000014
payloadLayout container2.Slice[uint32]
// 调用参数序列化后的载荷数据
// 如果被压缩了那么在反序列化时,最后剩下的数据均为参数载荷
payloads container2.Slice[byte]
}
// BaseLength 获取基本数据的长度防止输入过短的数据导致panic
func (m *Message) BaseLength() int {
ml := m.MinMux()
// MinMux + NameLayout + NMetaData + NArgs
return ml + _PayloadLayout + _ServiceName + _Metadata
}
// Length 根据结构计算序列化之后的数据长度, 长度存在时直接返回结果
// 不会设置m.payloadLength
func (m *Message) Length() uint32 {
if m.payloadLength > 0 {
return m.payloadLength
}
// desc : Scope & MsgId & PayloadLength & ServiceName & MetaData & Args
baseLen := m.MinMux() + _ServiceName + _Metadata + _PayloadLayout
// InstanceName & MethodName
baseLen += len(m.serviceName)
if m.MetaData != nil && m.MetaData.Len() > 0 {
// Key&Value Struct MetaData
baseLen += (m.MetaData.Len() * 4) * 2
// Key & Value Size
m.MetaData.Range(func(k, v string) bool {
baseLen += len(k) + len(v)
return true
})
}
// NArgs
baseLen += m.payloadLayout.Len() * 4
baseLen += m.payloads.Len()
return uint32(baseLen)
}
func (m *Message) GetAndSetLength() uint32 {
m.payloadLength = m.Length()
return m.Length()
}
func (m *Message) First() uint8 {
return m.scope[0]
}
func (m *Message) GetMsgType() uint8 {
return m.scope[1]
}
func (m *Message) SetMsgType(msgTyp uint8) {
m.scope[1] = msgTyp
}
func (m *Message) GetServiceName() string {
return m.serviceName
}
func (m *Message) SetServiceName(s string) {
m.serviceName = s
}
func (m *Message) GetMsgId() uint64 {
return m.msgId
}
func (m *Message) SetMsgId(msgId uint64) {
m.msgId = msgId
}
func (m *Message) AppendPayloads(p []byte) {
m.payloads = append(m.payloads, p...)
m.payloadLayout = append(m.payloadLayout, uint32(len(p)))
}
func (m *Message) Payloads() container2.Slice[byte] {
return m.payloads
}
func (m *Message) ReWritePayload(p []byte) {
m.payloads.Reset()
m.payloads.Append(p)
}
func (m *Message) SetPayloads(payloads []byte) {
m.payloads = payloads
}
func (m *Message) PayloadsIterator() *container2.Iterator[[]byte] {
rangCount := 0
var length int
if m.payloadLayout == nil || m.payloadLayout.Len() == 0 {
length = 0
} else {
length = m.payloadLayout.Len()
}
return container2.NewIterator[[]byte](length, false, func(current int) []byte {
if current+1 == m.payloadLayout.Len() {
return m.payloads[rangCount : rangCount+int(m.payloadLayout[current])]
}
old := rangCount
rangCount += int(m.payloadLayout[current])
return m.payloads[old:rangCount]
}, func() {
rangCount = 0
})
}
func (m *Message) MinMux() int {
// Scope + MsgId + PayloadLength
return len(m.scope) + 8 + 4
}
// Reset 给内存复用的操作提供一致性的语义
func (m *Message) Reset() {
m.scope = [...]uint8{MagicNumber, 0}
m.serviceName = ""
m.msgId = 0
m.payloadLength = 0
m.MetaData.Reset()
m.payloadLayout.Reset()
m.payloads.Reset()
}