forked from aceld/zinx
-
Notifications
You must be signed in to change notification settings - Fork 0
/
kcp_connection.go
664 lines (549 loc) · 17.8 KB
/
kcp_connection.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
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
package znet
import (
"context"
"encoding/hex"
"errors"
"net"
"strconv"
"sync"
"sync/atomic"
"time"
"github.com/aceld/zinx/ziface"
"github.com/aceld/zinx/zconf"
"github.com/aceld/zinx/zinterceptor"
"github.com/aceld/zinx/zlog"
"github.com/aceld/zinx/zpack"
"github.com/gorilla/websocket"
"github.com/xtaci/kcp-go"
)
// Connection KCP connection module
// Used to handle the read and write business of KCP connections, one Connection corresponds to one connection
// (用于处理KCP连接的读写业务 一个连接对应一个Connection)
type KcpConnection struct {
// The socket KCP socket of the current connection(当前连接的socket KCP套接字)
conn *kcp.UDPSession
// The ID of the current connection, also known as SessionID, globally unique, used by server Connection
// uint64 range: 0~18,446,744,073,709,551,615
// This is the maximum number of connID theoretically supported by the process
// (当前连接的ID 也可以称作为SessionID,ID全局唯一 ,服务端Connection使用
// uint64 取值范围:0 ~ 18,446,744,073,709,551,615
// 这个是理论支持的进程connID的最大数量)
connID uint64
// connection id for string
// (字符串的连接id)
connIdStr string
// The workerid responsible for handling the link
// 负责处理该链接的workerid
workerID uint32
// The message management module that manages MsgID and the corresponding processing method
// (消息管理MsgID和对应处理方法的消息管理模块)
msgHandler ziface.IMsgHandle
// Channel to notify that the connection has exited/stopped
// (告知该链接已经退出/停止的channel)
ctx context.Context
cancel context.CancelFunc
// Buffered channel used for message communication between the read and write goroutines
// (有缓冲管道,用于读、写两个goroutine之间的消息通信)
msgBuffChan chan []byte
// Lock for user message reception and transmission
// (用户收发消息的Lock)
msgLock sync.RWMutex
// Connection properties
// (链接属性)
property map[string]interface{}
// Lock to protect the current property
// (保护当前property的锁)
propertyLock sync.Mutex
// The current connection's close state
// (当前连接的关闭状态)
closed int32
// Which Connection Manager the current connection belongs to
// (当前链接是属于哪个Connection Manager的)
connManager ziface.IConnManager
// Hook function when the current connection is created
// (当前连接创建时Hook函数)
onConnStart func(conn ziface.IConnection)
// Hook function when the current connection is disconnected
// (当前连接断开时的Hook函数)
onConnStop func(conn ziface.IConnection)
// Data packet packaging method
// (数据报文封包方式)
packet ziface.IDataPack
// Last activity time
// (最后一次活动时间)
lastActivityTime time.Time
// Framedecoder for solving fragmentation and packet sticking problems
// (断粘包解码器)
frameDecoder ziface.IFrameDecoder
// Heartbeat checker
// (心跳检测器)
hc ziface.IHeartbeatChecker
// Connection name, default to be the same as the name of the Server/Client that created the connection
// (链接名称,默认与创建链接的Server/Client的Name一致)
name string
// Local address of the current connection
// (当前链接的本地地址)
localAddr string
// Remote address of the current connection
// (当前链接的远程地址)
remoteAddr string
// Close callback
closeCallback callbacks
// Close callback mutex
closeCallbackMutex sync.RWMutex
}
// newKcpServerConn :for Server, method to create a Server-side connection with Server-specific properties
// (创建一个Server服务端特性的连接的方法)
func newKcpServerConn(server ziface.IServer, conn *kcp.UDPSession, connID uint64) ziface.IConnection {
// Initialize Conn properties
c := &KcpConnection{
conn: conn,
connID: connID,
connIdStr: strconv.FormatUint(connID, 10),
msgBuffChan: nil,
property: nil,
name: server.ServerName(),
localAddr: conn.LocalAddr().String(),
remoteAddr: conn.RemoteAddr().String(),
}
lengthField := server.GetLengthField()
if lengthField != nil {
c.frameDecoder = zinterceptor.NewFrameDecoder(*lengthField)
}
// Inherited properties from server (从server继承过来的属性)
c.packet = server.GetPacket()
c.onConnStart = server.GetOnConnStart()
c.onConnStop = server.GetOnConnStop()
c.msgHandler = server.GetMsgHandler()
// Bind the current Connection with the Server's ConnManager
// (将当前的Connection与Server的ConnManager绑定)
c.connManager = server.GetConnMgr()
// Add the newly created Conn to the connection manager
// (将新创建的Conn添加到链接管理中)
server.GetConnMgr().Add(c)
return c
}
// newKcpServerConn :for Server, method to create a Client-side connection with Client-specific properties
// (创建一个Client服务端特性的连接的方法)
func newKcpClientConn(client ziface.IClient, conn *kcp.UDPSession) ziface.IConnection {
c := &KcpConnection{
conn: conn,
connID: 0, // client ignore
connIdStr: "", // client ignore
msgBuffChan: nil,
property: nil,
name: client.GetName(),
localAddr: conn.LocalAddr().String(),
remoteAddr: conn.RemoteAddr().String(),
}
lengthField := client.GetLengthField()
if lengthField != nil {
c.frameDecoder = zinterceptor.NewFrameDecoder(*lengthField)
}
// Inherited properties from server (从client继承过来的属性)
c.packet = client.GetPacket()
c.onConnStart = client.GetOnConnStart()
c.onConnStop = client.GetOnConnStop()
c.msgHandler = client.GetMsgHandler()
return c
}
// StartWriter is the goroutine that writes messages to the client
// (写消息Goroutine, 用户将数据发送给客户端)
func (c *KcpConnection) StartWriter() {
zlog.Ins().DebugF("Writer Goroutine is running")
defer zlog.Ins().DebugF("%s [conn Writer exit!]", c.RemoteAddr().String())
for {
select {
case data, ok := <-c.msgBuffChan:
if ok {
if err := c.Send(data); err != nil {
zlog.Ins().ErrorF("Send Buff Data error:, %s Conn Writer exit", err)
break
}
} else {
zlog.Ins().ErrorF("msgBuffChan is Closed")
break
}
case <-c.ctx.Done():
return
}
}
}
// StartReader is a goroutine that reads data from the client
// (读消息Goroutine,用于从客户端中读取数据)
func (c *KcpConnection) StartReader() {
zlog.Ins().DebugF("[Reader Goroutine is running]")
defer zlog.Ins().DebugF("%s [conn Reader exit!]", c.RemoteAddr().String())
defer c.Stop()
defer func() {
if err := recover(); err != nil {
zlog.Ins().ErrorF("connID=%d, panic err=%v", c.GetConnID(), err)
}
}()
for {
select {
case <-c.ctx.Done():
return
default:
// add by uuxia 2023-02-03
buffer := make([]byte, zconf.GlobalObject.IOReadBuffSize)
// read data from the connection's IO into the memory buffer
// (从conn的IO中读取数据到内存缓冲buffer中)
n, err := c.conn.Read(buffer)
if err != nil {
zlog.Ins().ErrorF("read msg head [read datalen=%d], error = %s", n, err)
return
}
zlog.Ins().DebugF("read buffer %s \n", hex.EncodeToString(buffer[0:n]))
// If normal data is read from the peer, update the heartbeat detection Active state
// (正常读取到对端数据,更新心跳检测Active状态)
if n > 0 && c.hc != nil {
c.updateActivity()
}
// Deal with the custom protocol fragmentation problem, added by uuxia 2023-03-21
// (处理自定义协议断粘包问题)
if c.frameDecoder != nil {
// Decode the 0-n bytes of data read
// (为读取到的0-n个字节的数据进行解码)
bufArrays := c.frameDecoder.Decode(buffer[0:n])
if bufArrays == nil {
continue
}
for _, bytes := range bufArrays {
// zlog.Ins().DebugF("read buffer %s \n", hex.EncodeToString(bytes))
msg := zpack.NewMessage(uint32(len(bytes)), bytes)
// Get the current client's Request data
// (得到当前客户端请求的Request数据)
req := GetRequest(c, msg)
c.msgHandler.Execute(req)
}
} else {
msg := zpack.NewMessage(uint32(n), buffer[0:n])
// Get the current client's Request data
// (得到当前客户端请求的Request数据)
req := GetRequest(c, msg)
c.msgHandler.Execute(req)
}
}
}
}
// Start starts the connection and makes the current connection work.
// (启动连接,让当前连接开始工作)
func (c *KcpConnection) Start() {
defer func() {
if err := recover(); err != nil {
zlog.Ins().ErrorF("Connection Start() error: %v", err)
}
}()
c.ctx, c.cancel = context.WithCancel(context.Background())
// Execute the hook method for processing business logic when creating a connection
// (按照用户传递进来的创建连接时需要处理的业务,执行钩子方法)
c.callOnConnStart()
// Start heartbeating detection
if c.hc != nil {
c.hc.Start()
c.updateActivity()
}
// 占用workerid
c.workerID = useWorker(c)
// Start the Goroutine for reading data from the client
// (开启用户从客户端读取数据流程的Goroutine)
go c.StartReader()
select {
case <-c.ctx.Done():
c.finalizer()
// 归还workerid
freeWorker(c)
return
}
}
// Stop stops the connection and ends the current connection state.
// (停止连接,结束当前连接状态)
func (c *KcpConnection) Stop() {
c.cancel()
}
func (c *KcpConnection) GetConnection() net.Conn {
return c.conn
}
func (c *KcpConnection) GetWsConn() *websocket.Conn {
return nil
}
// Deprecated: use GetConnection instead
func (c *KcpConnection) GetTCPConnection() net.Conn {
return c.conn
}
func (c *KcpConnection) GetConnID() uint64 {
return c.connID
}
func (c *KcpConnection) GetConnIdStr() string {
return c.connIdStr
}
func (c *KcpConnection) GetWorkerID() uint32 {
return c.workerID
}
func (c *KcpConnection) RemoteAddr() net.Addr {
return c.conn.RemoteAddr()
}
func (c *KcpConnection) LocalAddr() net.Addr {
return c.conn.LocalAddr()
}
func (c *KcpConnection) Send(data []byte) error {
c.msgLock.RLock()
defer c.msgLock.RUnlock()
if c.isClosed() {
return errors.New("connection closed when send msg")
}
_, err := c.conn.Write(data)
if err != nil {
zlog.Ins().ErrorF("SendMsg err data = %+v, err = %+v", data, err)
return err
}
return nil
}
func (c *KcpConnection) SendToQueue(data []byte) error {
c.msgLock.RLock()
defer c.msgLock.RUnlock()
if c.msgBuffChan == nil {
c.msgBuffChan = make(chan []byte, zconf.GlobalObject.MaxMsgChanLen)
// Start a Goroutine to write data back to the client
// This method only reads data from the MsgBuffChan without allocating memory or starting a Goroutine
// (开启用于写回客户端数据流程的Goroutine
// 此方法只读取MsgBuffChan中的数据没调用SendBuffMsg可以分配内存和启用协程)
go c.StartWriter()
}
idleTimeout := time.NewTimer(5 * time.Millisecond)
defer idleTimeout.Stop()
if c.isClosed() {
return errors.New("Connection closed when send buff msg")
}
if data == nil {
zlog.Ins().ErrorF("Pack data is nil")
return errors.New("Pack data is nil")
}
// Send timeout
select {
case <-idleTimeout.C:
return errors.New("send buff msg timeout")
case c.msgBuffChan <- data:
return nil
}
}
// SendMsg directly sends Message data to the remote KCP client.
// (直接将Message数据发送数据给远程的KCP客户端)
func (c *KcpConnection) SendMsg(msgID uint32, data []byte) error {
if c.isClosed() {
return errors.New("connection closed when send msg")
}
// Pack data and send it
msg, err := c.packet.Pack(zpack.NewMsgPackage(msgID, data))
if err != nil {
zlog.Ins().ErrorF("Pack error msg ID = %d", msgID)
return errors.New("Pack error msg ")
}
err = c.Send(msg)
if err != nil {
zlog.Ins().ErrorF("SendMsg err msg ID = %d, data = %+v, err = %+v", msgID, string(msg), err)
return err
}
return nil
}
func (c *KcpConnection) SendBuffMsg(msgID uint32, data []byte) error {
if c.isClosed() {
return errors.New("connection closed when send buff msg")
}
if c.msgBuffChan == nil {
c.msgBuffChan = make(chan []byte, zconf.GlobalObject.MaxMsgChanLen)
// Start a Goroutine to write data back to the client
// This method only reads data from the MsgBuffChan without allocating memory or starting a Goroutine
// (开启用于写回客户端数据流程的Goroutine
// 此方法只读取MsgBuffChan中的数据没调用SendBuffMsg可以分配内存和启用协程)
go c.StartWriter()
}
idleTimeout := time.NewTimer(5 * time.Millisecond)
defer idleTimeout.Stop()
msg, err := c.packet.Pack(zpack.NewMsgPackage(msgID, data))
if err != nil {
zlog.Ins().ErrorF("Pack error msg ID = %d", msgID)
return errors.New("Pack error msg ")
}
// send timeout
select {
case <-idleTimeout.C:
return errors.New("send buff msg timeout")
case c.msgBuffChan <- msg:
return nil
}
}
func (c *KcpConnection) SetProperty(key string, value interface{}) {
c.propertyLock.Lock()
defer c.propertyLock.Unlock()
if c.property == nil {
c.property = make(map[string]interface{})
}
c.property[key] = value
}
func (c *KcpConnection) GetProperty(key string) (interface{}, error) {
c.propertyLock.Lock()
defer c.propertyLock.Unlock()
if value, ok := c.property[key]; ok {
return value, nil
}
return nil, errors.New("no property found")
}
func (c *KcpConnection) RemoveProperty(key string) {
c.propertyLock.Lock()
defer c.propertyLock.Unlock()
delete(c.property, key)
}
func (c *KcpConnection) Context() context.Context {
return c.ctx
}
func (c *KcpConnection) finalizer() {
// If the connection has already been closed
if c.isClosed() == true {
return
}
//set closed
if !c.setClose() {
return
}
// Call the callback function registered by the user when closing the connection if it exists
//(如果用户注册了该链接的 关闭回调业务,那么在此刻应该显示调用)
c.callOnConnStop()
c.msgLock.Lock()
defer c.msgLock.Unlock()
// Stop the heartbeat detector associated with the connection
if c.hc != nil {
c.hc.Stop()
}
// Close the socket connection
_ = c.conn.Close()
// Remove the connection from the connection manager
if c.connManager != nil {
c.connManager.Remove(c)
}
// Close all channels associated with the connection
if c.msgBuffChan != nil {
close(c.msgBuffChan)
}
go func() {
defer func() {
if err := recover(); err != nil {
zlog.Ins().ErrorF("Conn finalizer panic: %v", err)
}
}()
c.InvokeCloseCallbacks()
}()
zlog.Ins().DebugF("Conn Stop()...ConnID = %d", c.connID)
}
func (c *KcpConnection) callOnConnStart() {
if c.onConnStart != nil {
zlog.Ins().DebugF("ZINX CallOnConnStart....")
c.onConnStart(c)
}
}
func (c *KcpConnection) callOnConnStop() {
if c.onConnStop != nil {
zlog.Ins().DebugF("ZINX CallOnConnStop....")
c.onConnStop(c)
}
}
func (c *KcpConnection) IsAlive() bool {
if c.isClosed() {
return false
}
// Check the last activity time of the connection. If it's beyond the heartbeat interval,
// then the connection is considered dead.
// (检查连接最后一次活动时间,如果超过心跳间隔,则认为连接已经死亡)
return time.Now().Sub(c.lastActivityTime) < zconf.GlobalObject.HeartbeatMaxDuration()
}
func (c *KcpConnection) updateActivity() {
c.lastActivityTime = time.Now()
}
func (c *KcpConnection) SetHeartBeat(checker ziface.IHeartbeatChecker) {
c.hc = checker
}
func (c *KcpConnection) LocalAddrString() string {
return c.localAddr
}
func (c *KcpConnection) RemoteAddrString() string {
return c.remoteAddr
}
func (c *KcpConnection) GetName() string {
return c.name
}
func (c *KcpConnection) GetMsgHandler() ziface.IMsgHandle {
return c.msgHandler
}
func (c *KcpConnection) isClosed() bool {
return atomic.LoadInt32(&c.closed) != 0
}
func (c *KcpConnection) setClose() bool {
return atomic.CompareAndSwapInt32(&c.closed, 0, 1)
}
func (s *KcpConnection) AddCloseCallback(handler, key interface{}, f func()) {
if s.isClosed() {
return
}
s.closeCallbackMutex.Lock()
defer s.closeCallbackMutex.Unlock()
s.closeCallback.Add(handler, key, f)
}
func (s *KcpConnection) RemoveCloseCallback(handler, key interface{}) {
if s.isClosed() {
return
}
s.closeCallbackMutex.Lock()
defer s.closeCallbackMutex.Unlock()
s.closeCallback.Remove(handler, key)
}
// invokeCloseCallbacks 触发 close callback, 在独立协程完成
func (s *KcpConnection) InvokeCloseCallbacks() {
s.closeCallbackMutex.RLock()
defer s.closeCallbackMutex.RUnlock()
s.closeCallback.Invoke()
}
// Implement other KCP specific methods here...
// ...
// ...
// For example, to create a new KCP connection:
// func newKCPConn(client ziface.IClient, conn net.Conn) ziface.IConnection {
// c := &Connection{
// conn: conn,
// connID: 0, // client ignore
// isClosed: false,
// msgBuffChan: nil,
// property: nil,
// name: client.GetName(),
// localAddr: conn.LocalAddr().String(),
// remoteAddr: conn.RemoteAddr().String(),
// // ... Initialize other KCP specific properties ...
// }
// // Inherited properties from client
// c.packet = client.GetPacket()
// c.onConnStart = client.GetOnConnStart()
// c.onConnStop = client.GetOnConnStop()
// c.msgHandler = client.GetMsgHandler()
// return c
// }
// And similarly for the Server-side KCP connection:
// func newServerKCPConn(server ziface.IServer, conn net.Conn, connID uint64) ziface.IConnection {
// c := &Connection{
// conn: conn,
// connID: connID,
// isClosed: false,
// msgBuffChan: nil,
// property: nil,
// name: server.ServerName(),
// localAddr: conn.LocalAddr().String(),
// remoteAddr: conn.RemoteAddr().String(),
// // ... Initialize other KCP specific properties ...
// }
// // Inherited properties from server
// c.packet = server.GetPacket()
// c.onConnStart = server.GetOnConnStart()
// c.onConnStop = server.GetOnConnStop()
// c.msgHandler = server.GetMsgHandler()
// // ... Additional initialization specific to KCP ...
// return c
// }