-
Notifications
You must be signed in to change notification settings - Fork 18
/
server.go
965 lines (820 loc) · 25.4 KB
/
server.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
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
// Go support for Protocol Buffers RPC which compatible with https://github.com/Baidu-ecom/Jprotobuf-rpc-socket
//
// Copyright 2002-2007 the original author or authors.
//
// 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.
package baidurpc
import (
"context"
"errors"
"fmt"
"log"
"net"
"os"
"os/signal"
"reflect"
"strconv"
"strings"
"sync"
"time"
"github.com/jhunters/goassist/concurrent/syncx"
"github.com/jhunters/goassist/netutil"
"github.com/jhunters/link"
"google.golang.org/protobuf/proto"
)
const (
/** success status. */
ST_SUCCESS int = 0
/** 方法未找到异常. */
ST_SERVICE_NOTFOUND int = 1001
/** 未知异常. */
ST_ERROR int = 2001
/** 验证错误. */
ST_AUTH_ERROR = 1004
// log id key
KT_LOGID = "_logid_"
RPC_STATUS_SERVICENAME = "___baidurpc_service"
// in seconds
Reqeust_QPS_Expire = 300 //
Proto2_Version = "proto2"
Shutdown_Timeout = time.Second
)
// error log info definition
var (
errServerNotInit = errors.New("[server-001]serverMeta is nil. please use NewTpcServer() to create TcpServer")
errInvalidPort = errors.New("[server-002]port of server is nil or invalid")
errResponseToClient = errors.New("[server-003]response call session.Send to client failed")
errAuth = errors.New("authenticate failed, pls use correct authenticate value")
LOG_SERVICE_NOTFOUND = "[server-" + strconv.Itoa(ST_SERVICE_NOTFOUND) + "]Service name '%s' or method name '%s' not found"
LOG_SERVICE_DUPLICATE = "[server-004]Service name '%s' or method name '%s' already exist"
LOG_SERVER_STARTED_INFO = "[server-100]BaiduRpc server started on '%v'"
LOG_INTERNAL_ERROR = "[server-" + strconv.Itoa(ST_ERROR) + "] unknown internal error:'%s'"
LOG_TIMECOST_INFO = "[server-101]Server name '%s' method '%s' process cost '%.5g' seconds"
LOG_TIMECOST_INFO2 = "[server-102]Server name '%s' method '%s' process cost '%.5g' seconds.(without net cost) "
DEFAULT_IDLE_TIME_OUT_SECONDS = 10
m proto.Message
MessageType = reflect.TypeOf(m)
chunkExpireTimewheelInterval = 1 * time.Second
chunkExpireTimeWheelSlot = 300
// object pool for RpcDataPackage
dataPackagePool = syncx.NewPool(func() *RpcDataPackage {
return NewRpcDataPackage()
})
)
type ServerMeta struct {
Host *string
Port *int
IdleTimeoutSeconds *int
QPSExpireInSecs int
ChunkSize uint32
TimeoutSeconds uint32
}
type serviceType struct {
name string // name of service
rcvr reflect.Value // receiver of methods for the service
typ reflect.Type // type of the receiver
method map[string]*methodType // registered methods
}
type methodType struct {
sync.Mutex // protects counters
method reflect.Method
ArgType reflect.Type
ArgValue reflect.Value
ReturnType reflect.Type
ReturnValue reflect.Value
InArgValue interface{}
InPbFieldMetas []*PbFieldMeta
RetrunPbFieldMetas []*PbFieldMeta
}
// ParsePbMeta parse pb tag string
func (mt *methodType) ParsePbMeta() {
t := mt.ArgType
if t != nil {
mt.InPbFieldMetas = parsePbMetaFromType(t)
}
t = mt.ReturnType
if t != nil {
mt.RetrunPbFieldMetas = parsePbMetaFromType(t)
}
}
func parsePbMetaFromType(t reflect.Type) []*PbFieldMeta {
if t.Kind() == reflect.Ptr {
t = t.Elem()
}
size := t.NumField()
if size == 0 {
return nil
}
metas := make([]*PbFieldMeta, 0)
for i := 0; i < size; i++ {
tagstruct := t.Field(i).Tag
// check if if map
pbtag := tagstruct.Get("protobuf")
meta := parseMetaString(pbtag)
if meta == nil {
continue
}
metas = append(metas, meta)
mapKey := tagstruct.Get("protobuf_key")
mapValue := tagstruct.Get("protobuf_val")
if len(mapKey) > 0 && len(mapValue) > 0 {
meta.SubFieldMeta = make([]*PbFieldMeta, 2)
meta.SubFieldMeta[0] = parseMetaString(mapKey)
meta.SubFieldMeta[1] = parseMetaString(mapValue)
meta.HasSub = true
}
subType := t.Field(i).Type
if matched, _ := isMessageType(subType); matched {
meta.SubFieldMeta = parsePbMetaFromType(subType)
}
}
return metas
}
func parseMetaString(meta string) *PbFieldMeta {
if len(meta) == 0 {
return nil // empty tag meta return directly
}
partials := strings.Split(meta, ",")
metaSize := len(partials)
if metaSize >= 4 {
tag, _ := strconv.Atoi(partials[1])
meta := &PbFieldMeta{Type: partials[0], Tag: tag, Opt: partials[2]}
// check if has version Version: partials[4]
if metaSize >= 5 {
meta.Version = partials[4]
} else {
meta.Version = Proto2_Version
}
nameSplit := strings.Split(partials[3], "=")
if len(nameSplit) == 2 {
meta.Name = nameSplit[1]
}
return meta
} else {
Warningf("invalid proto tag '%s' size is %d", meta, len(partials))
}
return nil
}
type PbFieldMeta struct {
Name string `json:"name,omitempty"`
Tag int `json:"tag,omitempty"`
Type string `json:"type,omitempty"`
Opt string `json:"opt,omitempty"` // opt or req
Version string `json:"version,omitempty"` // proto2 or proto3
SubFieldMeta []*PbFieldMeta `json:"sub_field_meta,omitempty"`
HasSub bool `json:"has_sub,omitempty"`
}
type attachement struct {
}
var attachementKey attachement
type logidkey struct {
}
var logidKey logidkey
var errorKey struct{}
type RPCFN func(msg proto.Message, attachment []byte, logId *int64) (proto.Message, []byte, error)
// Service rpc service
type Service interface {
/*
RPC service call back method.
message : parameter in from RPC client or 'nil' if has no parameter
attachment : attachment content from RPC client or 'nil' if has no attachment
logId : with a int64 type log sequence id from client or 'nil if has no logId
return:
[0] message return back to RPC client or 'nil' if need not return method response
[1] attachment return back to RPC client or 'nil' if need not return attachemnt
[2] return with any error or 'nil' represents success
*/
DoService(message proto.Message, attachment []byte, logId *int64) (proto.Message, []byte, error)
GetServiceName() string
GetMethodName() string
NewParameter() proto.Message
}
// AuthService authenticate service
type AuthService interface {
// Authenticate do auth action if return true auth success
Authenticate(service, name string, authToken []byte) bool
}
type TraceInfo struct {
TraceId int64
SpanId int64
ParentSpanId int64
RpcRequestMetaExt map[string]string
}
// TraceService to monitor trace info and return trace info back
type TraceService interface {
Trace(service, name string, traceInfo *TraceInfo) *TraceInfo
}
// DefaultService default implemention for Service interface
type DefaultService struct {
sname string
mname string
callback RPCFN
inType proto.Message
}
// DoService do call back function on RPC invocation
func (s *DefaultService) DoService(message proto.Message, attachment []byte, logId *int64) (proto.Message, []byte, error) {
return s.callback(message, attachment, logId)
}
// GetMethodName get method name
func (s *DefaultService) GetMethodName() string {
return s.mname
}
// NewParameter no long will be used
func (s *DefaultService) NewParameter() proto.Message {
return s.inType
}
// GetServiceName get service name
func (s *DefaultService) GetServiceName() string {
return s.sname
}
type Server interface {
Start() error
Stop() error
Register(service *Service) (bool, error)
}
// ErrorContext
type ErrorContext struct {
err error
}
// TcpServer RPC server base on tcp transport
type TcpServer struct {
serverMeta *ServerMeta
services map[string]Service
servicesMeta map[string]*serviceMeta
started bool
stop bool
server *link.Server[*RpcDataPackage, *RpcDataPackage]
requestStatus *RPCRequestStatus
authService AuthService
protocol *RpcDataPackageProtocol[*RpcDataPackage, *RpcDataPackage]
traceService TraceService
enableHttp bool
selector *netutil.CustomListenerSelector
EnablePerformanceLog bool
httpServer *HttpServer
}
type serviceMeta struct {
InPbFieldMetas []*PbFieldMeta
RetrunPbFieldMetas []*PbFieldMeta
}
// NewTpcServer
func NewTpcServer(serverMeta *ServerMeta) *TcpServer {
tcpServer := TcpServer{}
tcpServer.services = make(map[string]Service)
tcpServer.servicesMeta = make(map[string]*serviceMeta)
tcpServer.started = false
tcpServer.stop = false
if serverMeta.IdleTimeoutSeconds == nil {
serverMeta.IdleTimeoutSeconds = &DEFAULT_IDLE_TIME_OUT_SECONDS
}
if serverMeta.QPSExpireInSecs <= 0 {
serverMeta.QPSExpireInSecs = Reqeust_QPS_Expire
}
tcpServer.serverMeta = serverMeta
// register status rpc method
hsv := &HttpStatusView{server: &tcpServer}
tcpServer.RegisterName(RPC_STATUS_SERVICENAME, hsv)
return &tcpServer
}
// StartServer start server with net.Listener
func (s *TcpServer) StartServer(l net.Listener) error {
protocol, err := NewRpcDataPackageProtocol()
protocol.chunkSize = s.serverMeta.ChunkSize
if s.serverMeta.TimeoutSeconds > 0 {
t := time.Duration(int64(s.serverMeta.TimeoutSeconds)) * time.Second
protocol.timeout = &t
}
if err != nil {
return err
}
selector, err := netutil.NewCustomListenerSelectorByListener(l, 4, netutil.Equal_Mode)
if err != nil {
return err
}
rpcServerListener, err := selector.RegisterListener(MAGIC_CODE) //"PRPC"
if err != nil {
return err
}
if s.enableHttp {
httpServer := &HttpServer{s: s}
log.Println("Enabled with http server mode.")
httpServerListener := selector.RegisterDefaultListener()
httpServer.serverHttp(httpServerListener)
s.httpServer = httpServer
}
// start customize listener
go selector.Serve()
server := link.NewServer[*RpcDataPackage, *RpcDataPackage](rpcServerListener, protocol, 0 /* sync send */, link.HandlerFunc[*RpcDataPackage, *RpcDataPackage](s.handleResponse))
s.protocol = protocol
s.server = server
go server.Serve()
s.started = true
s.stop = false
Infof(LOG_SERVER_STARTED_INFO, l.Addr())
s.requestStatus = NewRPCRequestStatus(s.services) // inital request status monitor
s.requestStatus.expireAfterSecs = int16(s.serverMeta.QPSExpireInSecs)
go s.requestStatus.Start()
return nil
}
func (s *TcpServer) Start() error {
if s.serverMeta == nil {
return errServerNotInit
}
var addr = ""
host := ""
if s.serverMeta.Host != nil {
host = *s.serverMeta.Host
}
port := s.serverMeta.Port
if port == nil || *port <= 0 {
return errInvalidPort
}
addr = addr + host + ":" + strconv.Itoa(*port)
listener, err := net.Listen("tcp", addr)
if err != nil {
return err
}
return s.StartServer(listener)
}
func (s *TcpServer) StartAndBlock() error {
err := s.Start()
if err != nil {
return err
}
timeContext, _ := context.WithTimeout(context.Background(), Shutdown_Timeout)
defer s.Stop(timeContext)
c := make(chan os.Signal, 1)
signal.Notify(c, os.Interrupt, os.Kill)
// Block until a signal is received.
fmt.Println("Press Ctrl+C or send kill sinal to exit.")
<-c
return nil
}
// EnableHttp
func (s *TcpServer) EnableHttp() {
s.enableHttp = true
}
// SetAuthService set authenticate service
func (s *TcpServer) SetAuthService(authservice AuthService) {
s.authService = authservice
}
// SetTraceService set trace service
func (s *TcpServer) SetTraceService(traceService TraceService) {
s.traceService = traceService
}
func (s *TcpServer) handleResponse(session *link.Session[*RpcDataPackage, *RpcDataPackage]) {
// after function return must close session
defer func() {
session.Close()
}()
for {
req, err := session.Receive()
if err != nil { // or error connection with bad request
Errorf(LOG_INTERNAL_ERROR, err.Error())
return
}
// error package
if req == nil {
return
}
go s.doHandleProcess(session, req)
}
}
func (s *TcpServer) doHandleProcess(session *link.Session[*RpcDataPackage, *RpcDataPackage], r *RpcDataPackage) error {
now := time.Now().UnixNano()
serviceName := r.GetMeta().GetRequest().GetServiceName()
methodName := r.GetMeta().GetRequest().GetMethodName()
defer func() {
// return to object pool
dataPackagePool.Put(r)
// catch panic and log
if p := recover(); p != nil {
err := fmt.Errorf("RPC server '%v' method '%v' got a internal error: %v", serviceName, methodName, p)
log.Println(err.Error())
}
}()
if s.authService != nil {
authOk := s.authService.Authenticate(serviceName, methodName, r.Meta.AuthenticationData)
if !authOk {
wrapResponse(r, ST_AUTH_ERROR, errAuth.Error())
err := session.Send(r)
if err != nil {
Error(errResponseToClient.Error(), "sessionId=", session.ID(), err)
return err
}
return nil
}
}
if s.traceService != nil {
traceInfo := &TraceInfo{TraceId: r.GetTraceId(), SpanId: r.GetSpanId(), ParentSpanId: r.GetParentSpanId()}
traceInfo.RpcRequestMetaExt = r.GetRpcRequestMetaExt()
traceRetrun := s.traceService.Trace(serviceName, methodName, traceInfo)
if traceRetrun != nil {
r.TraceId(traceRetrun.TraceId)
r.SpanId(traceRetrun.SpanId)
r.ParentSpanId(traceRetrun.ParentSpanId)
if traceRetrun.RpcRequestMetaExt != nil {
r.RpcRequestMetaExt(traceRetrun.RpcRequestMetaExt)
}
}
}
serviceId := GetServiceId(serviceName, methodName)
service := s.services[serviceId]
if service == nil {
wrapResponse(r, ST_SERVICE_NOTFOUND, fmt.Sprintf(LOG_SERVICE_NOTFOUND, serviceName, methodName))
err := session.Send(r)
if err != nil {
Error(errResponseToClient.Error(), "sessionId=", session.ID(), err)
return err
}
return nil
}
var msg proto.Message
requestData := r.GetData()
if requestData != nil {
msg = service.NewParameter()
if msg != nil {
proto.Unmarshal(requestData, msg)
}
}
now2 := time.Now()
ec := &ErrorContext{}
// do service here
messageRet, attachment, err := s.doServiceInvoke(ec, msg, r.Meta.Request.ServiceName, r.Meta.Request.MethodName, r.GetAttachment(), r.GetLogId(), service)
if ec.err != nil {
err = ec.err
}
if err != nil { // return response with error message
wrapResponse(r, ST_ERROR, err.Error())
err := session.Send(r)
if err != nil {
Error(errResponseToClient.Error(), "sessionId=", session.ID(), err)
return err
}
if s.EnablePerformanceLog {
took2 := TimetookInSeconds(now2.Unix())
Infof(LOG_TIMECOST_INFO2, serviceName, methodName, took2)
}
return nil
}
if s.EnablePerformanceLog {
took2 := TimetookInSeconds(now2.Unix())
Infof(LOG_TIMECOST_INFO2, serviceName, methodName, took2)
}
if messageRet == nil {
r.SetData(nil)
} else {
d, err := proto.Marshal(messageRet)
if err != nil {
wrapResponse(r, ST_ERROR, err.Error())
err = session.Send(r)
if err != nil {
Error(errResponseToClient.Error(), "sessionId=", session.ID(), err)
return err
}
return nil
}
r.SetData(d)
r.SetAttachment(attachment)
wrapResponse(r, ST_SUCCESS, "")
}
err = session.Send(r)
if err != nil {
Error(errResponseToClient.Error(), "sessionId=", session.ID(), err)
return err
}
if s.EnablePerformanceLog {
took := TimetookInSeconds(now)
Infof(LOG_TIMECOST_INFO, serviceName, methodName, took)
}
return nil
}
func (s *TcpServer) doServiceInvoke(c *ErrorContext, msg proto.Message, sname, method string, attachment []byte, logid int64, service Service) (proto.Message, []byte, error) {
var err error
defer func() {
if p := recover(); p != nil {
err = fmt.Errorf("RPC server '%v' method '%v' got a internal error: %v", sname, method, p)
c.err = err
log.Println(err.Error())
}
}()
// do moinitor
s.requestStatus.RequestIn(GetServiceId(sname, method), time.Now(), 1)
messageRet, attachment, err := service.DoService(msg, attachment, proto.Int64(logid))
return messageRet, attachment, err
}
func wrapResponse(r *RpcDataPackage, errorCode int, errorText string) {
r.GetMeta().Response = &Response{}
r.GetMeta().GetResponse().ErrorCode = int32(errorCode)
r.GetMeta().GetResponse().ErrorText = errorText
}
func GetServiceId(serviceName, methodName string) string {
return serviceName + "!" + methodName
}
// Stop do stop rpc server
func (s *TcpServer) Stop(ctx context.Context) error {
s.stop = true
s.started = false
if s.selector != nil {
s.selector.Close()
}
if s.server != nil {
s.server.Stop()
}
if s.requestStatus != nil {
s.requestStatus.Stop()
}
if s.protocol != nil {
s.protocol.Stop()
}
if s.httpServer != nil {
s.httpServer.shutdown(ctx)
}
return nil
}
// Register register RPC service
func (s *TcpServer) Register(service interface{}) (bool, error) {
return s.RegisterName("", service)
}
// Register register RPC service
func (s *TcpServer) registerServiceType(ss Service) (bool, error) {
serviceId := GetServiceId(ss.GetServiceName(), ss.GetMethodName())
exsit := s.services[serviceId]
if exsit != nil {
err := fmt.Errorf(LOG_SERVICE_DUPLICATE, ss.GetServiceName(), ss.GetMethodName())
Error(err.Error())
return false, err
}
log.Println("Rpc service registered. service=", ss.GetServiceName(), " method=", ss.GetMethodName())
s.services[serviceId] = ss
return true, nil
}
// RegisterNameWithMethodMapping call RegisterName with method name mapping map
func (s *TcpServer) RegisterNameWithMethodMapping(name string, rcvr interface{}, mapping map[string]string) (bool, error) {
ss, ok := rcvr.(Service)
if !ok {
return s.registerWithMethodMapping(name, rcvr, mapping)
}
if name != "" {
callback := func(msg proto.Message, attachment []byte, logId *int64) (proto.Message, []byte, error) {
return ss.DoService(msg, attachment, logId)
}
mName := ss.GetMethodName()
if mapping != nil {
mname, ok := mapping[mName]
if ok {
mName = mname
}
}
service := &DefaultService{
sname: name,
mname: mName,
callback: callback,
inType: ss.NewParameter(),
}
ss = service
}
return s.registerServiceType(ss)
}
// RegisterName register publishes in the server with specified name for its set of methods of the
// receiver value that satisfy the following conditions:
// - exported method of exported type
// - one argument, exported type and should be the type implements from proto.Message
// - one return value, of type proto.Message
//
// It returns an error if the receiver is not an exported type or has
// no suitable methods. It also logs the error using package log.
// The client accesses each method using a string of the form "Type.Method",
// where Type is the receiver's concrete type.
func (s *TcpServer) RegisterName(name string, rcvr interface{}) (bool, error) {
return s.RegisterNameWithMethodMapping(name, rcvr, nil)
}
// registerWithMethodMapping call RegisterName with method name mapping map
func (s *TcpServer) registerWithMethodMapping(name string, rcvr interface{}, mapping map[string]string) (bool, error) {
st := &serviceType{
typ: reflect.TypeOf(rcvr),
rcvr: reflect.ValueOf(rcvr),
}
sname := reflect.Indirect(st.rcvr).Type().Name()
if name != "" {
sname = name
}
st.name = sname
// Install the methods
st.method = suitableMethods(st.typ, true)
if len(st.method) == 0 {
str := ""
// To help the user, see if a pointer receiver would work.
method := suitableMethods(reflect.PtrTo(st.typ), false)
if len(method) != 0 {
str = "rpc.Register: type " + sname + " has no exported methods of suitable type (hint: pass a pointer to value of that type)"
} else {
str = "rpc.Register: type " + sname + " has no exported methods of suitable type"
}
log.Print(str)
return false, errors.New(str)
}
// do register rpc
for _, methodType := range st.method {
function := methodType.method.Func
hasArgType := false
if methodType.ArgType != nil {
hasArgType = true
}
callback := func(msg proto.Message, attachment []byte, logId *int64) (proto.Message, []byte, error) {
// process context value
c := context.Background()
if attachment != nil {
c = BindAttachement(c, attachment)
}
if logId != nil {
c = BindLogId(c, *logId)
}
contextValue := reflect.ValueOf(c)
var attachmentRet []byte = nil
var err error
var returnValues []reflect.Value
if hasArgType {
returnValues = function.Call([]reflect.Value{st.rcvr, contextValue, reflect.ValueOf(msg)})
} else {
returnValues = function.Call([]reflect.Value{st.rcvr, contextValue})
}
if len(returnValues) == 1 {
return returnValues[0].Interface().(proto.Message), attachmentRet, nil
}
if len(returnValues) == 2 {
ctx := returnValues[1].Interface().(context.Context)
attachmentRet = Attachement(ctx)
err = Errors(ctx)
return returnValues[0].Interface().(proto.Message), attachmentRet, err
}
return nil, attachmentRet, nil
}
var inType proto.Message
if methodType.InArgValue != nil {
inType = methodType.InArgValue.(proto.Message)
if inType == nil {
// if type is not proto.Message
continue
}
}
mName := methodType.method.Name
if mapping != nil {
mname, ok := mapping[mName]
if ok {
mName = mname
}
}
s.RegisterRpc(st.name, mName, callback, inType)
methodType.ParsePbMeta()
sid := GetServiceId(st.name, mName)
s.servicesMeta[sid] = &serviceMeta{methodType.InPbFieldMetas, methodType.RetrunPbFieldMetas}
}
return true, nil
}
// suitableMethods returns suitable Rpc methods of typ, it will report
// error using log if reportErr is true.
func suitableMethods(typ reflect.Type, reportErr bool) map[string]*methodType {
methods := make(map[string]*methodType)
for m := 0; m < typ.NumMethod(); m++ {
method := typ.Method(m)
mtype := method.Type
mname := method.Name
var inArgValue interface{}
var ok bool
// Method must be exported.
if method.PkgPath != "" {
continue
}
// Method needs two ins: receiver, context, *args.
if mtype.NumIn() != 2 && mtype.NumIn() != 3 {
if reportErr {
log.Printf("rpc.Register: method %q has %d input parameters; needs exactly three\n", mname, mtype.NumIn())
}
continue
}
// and must be type of context.Context
contextType := mtype.In(1)
if !isContextType(contextType) {
if reportErr {
log.Printf("rpc.Register: argument type of method %q is not implements from context.Context: %q\n", mname, contextType)
}
continue
}
// and must be type of proto message
var argType reflect.Type
if mtype.NumIn() == 3 {
argType = mtype.In(2)
if ok, inArgValue = isMessageType(argType); !ok {
if reportErr {
log.Printf("rpc.Register: argument type of method %q is not implements from proto.Message: %q\n", mname, argType)
}
continue
}
}
// Method needs one out.
if mtype.NumOut() != 1 && mtype.NumOut() != 2 {
if reportErr {
log.Printf("rpc.Register: method %q has %d output parameters; needs one or two. \n", mname, mtype.NumOut())
}
continue
}
// The return type of the method must be error.
returnType := mtype.Out(0)
if ok, _ := isMessageType(returnType); !ok {
if reportErr {
log.Printf("rpc.Register: return type of method %q is %q, must be implements from proto.Message\n", mname, returnType)
}
continue
}
if mtype.NumOut() == 2 {
// The return type of the method must be error.
returnContextType := mtype.Out(1)
if !isContextType(returnContextType) {
if reportErr {
log.Printf("rpc.Register: return type of method %q is %q, must be implements from context.Context\n", mname, returnType)
}
continue
}
}
methods[mname] = &methodType{method: method, ArgType: argType,
ReturnType: returnType, InArgValue: inArgValue}
}
return methods
}
// Is this type implements from proto.Message
func isMessageType(t reflect.Type) (bool, interface{}) {
if t.Kind() == reflect.Ptr {
t = t.Elem()
}
// should not a interface type
if t.Kind() == reflect.Interface {
return false, nil
}
argv := reflect.New(t)
v, ok := argv.Interface().(proto.Message)
return ok, v
}
// Is this type implements from context.Context
func isContextType(t reflect.Type) bool {
if t.Kind() == reflect.Ptr {
t = t.Elem()
}
ok := t.Implements(reflect.TypeOf((*context.Context)(nil)).Elem())
return ok
}
// RegisterRpc register Rpc direct
func (s *TcpServer) RegisterRpc(sname, mname string, callback RPCFN, inType proto.Message) (bool, error) {
service := &DefaultService{
sname: sname,
mname: mname,
callback: callback,
inType: inType,
}
return s.registerServiceType(service)
}
func LogID(context context.Context) int64 {
v := context.Value(logidKey)
if v == nil {
return -1
}
return v.(int64)
}
// Attachment utility function to get attachemnt from context
func Attachement(context context.Context) []byte {
v := context.Value(attachementKey)
if v == nil {
return nil
}
return v.([]byte)
}
// BindAttachement add attachement value to the context
func BindAttachement(c context.Context, attachement interface{}) context.Context {
return context.WithValue(c, attachementKey, attachement)
}
// BindError add error value to the context
func BindError(c context.Context, err error) context.Context {
return context.WithValue(c, errorKey, err)
}
// BindError add error value to the context
func BindLogId(c context.Context, logid int64) context.Context {
return context.WithValue(c, logidKey, logid)
}
// BindError add error value to the context
func Errors(c context.Context) error {
v := c.Value(errorKey)
if v == nil {
return nil
}
return v.(error)
}