-
Notifications
You must be signed in to change notification settings - Fork 794
/
common.go
68 lines (60 loc) · 2.64 KB
/
common.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
/*
* Copyright 2021 CloudWeGo 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 trans
import (
"context"
"fmt"
"net"
"time"
"github.com/cloudwego/kitex/pkg/remote"
"github.com/cloudwego/kitex/pkg/rpcinfo"
"github.com/cloudwego/kitex/pkg/serviceinfo"
)
var readMoreTimeout = 5 * time.Millisecond
// Extension is the interface that trans extensions need to implement, it will make the extension of trans more easily.
// Normally if we want to extend transport layer we need to implement the trans interfaces which are defined in trans_handler.go.
// In fact most code logic is similar in same mode, so the Extension interface is the the differentiated part that need to
// be implemented separately.
// The default common trans implement is in default_client_handler.go and default_server_handler.go.
type Extension interface {
SetReadTimeout(ctx context.Context, conn net.Conn, cfg rpcinfo.RPCConfig, role remote.RPCRole)
NewWriteByteBuffer(ctx context.Context, conn net.Conn, msg remote.Message) remote.ByteBuffer
NewReadByteBuffer(ctx context.Context, conn net.Conn, msg remote.Message) remote.ByteBuffer
ReleaseBuffer(remote.ByteBuffer, error) error
IsTimeoutErr(error) bool
// IsRemoteClosedErr is to check if the error caused by connection closed when output log or report metric
IsRemoteClosedErr(error) bool
}
// GetReadTimeout is to make the read timeout longer, it is better for proxy case to receive error resp.
func GetReadTimeout(cfg rpcinfo.RPCConfig) time.Duration {
if cfg.RPCTimeout() <= 0 {
return 0
}
return cfg.RPCTimeout() + readMoreTimeout
}
// GetMethodInfo is used to get method info from serviceinfo.MethodInfo by method name/
func GetMethodInfo(ri rpcinfo.RPCInfo, svcInfo *serviceinfo.ServiceInfo) (serviceinfo.MethodInfo, error) {
methodName := ri.Invocation().MethodName()
methodInfo := svcInfo.MethodInfo(methodName)
if methodInfo != nil {
return methodInfo, nil
}
return nil, remote.NewTransErrorWithMsg(remote.UnknownMethod, fmt.Sprintf("unknown method %s", methodName))
}
// MuxEnabledFlag is used to determine whether a serverHandlerFactory is multiplexing.
type MuxEnabledFlag interface {
MuxEnabled() bool
}