diff --git a/protocol/grpc/client.go b/protocol/grpc/client.go
index 0c7499a179571d623eccc607dd4cc8f1950f3239..5773eb80a9b07e300fd980d580ac052bbfd45841 100644
--- a/protocol/grpc/client.go
+++ b/protocol/grpc/client.go
@@ -33,13 +33,13 @@ import (
"github.com/apache/dubbo-go/config"
)
-// Client ...
+// Client is gRPC client include client connection and invoker
type Client struct {
*grpc.ClientConn
invoker reflect.Value
}
-// NewClient ...
+// NewClient creates a new gRPC client.
func NewClient(url common.URL) *Client {
// if global trace instance was set , it means trace function enabled. If not , will return Nooptracer
tracer := opentracing.GlobalTracer()
diff --git a/protocol/grpc/grpc_exporter.go b/protocol/grpc/grpc_exporter.go
index 0296ad8b5b06b693fd5e0972f18be77a69cd21ed..79962b59e29bb0e3aeb58776f6c26abc2e6832de 100644
--- a/protocol/grpc/grpc_exporter.go
+++ b/protocol/grpc/grpc_exporter.go
@@ -33,14 +33,14 @@ type GrpcExporter struct {
*protocol.BaseExporter
}
-// NewGrpcExporter ...
+// NewGrpcExporter creates a new gRPC exporter
func NewGrpcExporter(key string, invoker protocol.Invoker, exporterMap *sync.Map) *GrpcExporter {
return &GrpcExporter{
BaseExporter: protocol.NewBaseExporter(key, invoker, exporterMap),
}
}
-// Unexport ...
+// Unexport and unregister gRPC service from registry and memory.
func (gg *GrpcExporter) Unexport() {
serviceId := gg.GetInvoker().GetUrl().GetParam(constant.BEAN_NAME_KEY, "")
interfaceName := gg.GetInvoker().GetUrl().GetParam(constant.INTERFACE_KEY, "")
diff --git a/protocol/grpc/grpc_invoker.go b/protocol/grpc/grpc_invoker.go
index 78439fcd9b7f7d3b845f326bf432ea486855965e..e150d05e6fb39890bd3e355f4042b4ef34db42ed 100644
--- a/protocol/grpc/grpc_invoker.go
+++ b/protocol/grpc/grpc_invoker.go
@@ -35,8 +35,7 @@ import (
"github.com/apache/dubbo-go/protocol"
)
-// ErrNoReply ...
-var ErrNoReply = errors.New("request need @response")
+var errNoReply = errors.New("request need @response")
// GrpcInvoker ...
type GrpcInvoker struct {
@@ -60,7 +59,7 @@ func (gi *GrpcInvoker) Invoke(ctx context.Context, invocation protocol.Invocatio
)
if invocation.Reply() == nil {
- result.Err = ErrNoReply
+ result.Err = errNoReply
}
in := []reflect.Value{}
diff --git a/protocol/grpc/grpc_protocol.go b/protocol/grpc/grpc_protocol.go
index cc4aba10bf69f5e80d761649b9830fd61c4084cd..68594a4b35921b6e3b1d59d404ed163025d57a81 100644
--- a/protocol/grpc/grpc_protocol.go
+++ b/protocol/grpc/grpc_protocol.go
@@ -39,14 +39,14 @@ func init() {
var grpcProtocol *GrpcProtocol
-// GrpcProtocol ...
+// GrpcProtocol is gRPC protocol
type GrpcProtocol struct {
protocol.BaseProtocol
serverMap map[string]*Server
serverLock sync.Mutex
}
-// NewGRPCProtocol ...
+// NewGRPCProtocol creates new gRPC protocol
func NewGRPCProtocol() *GrpcProtocol {
return &GrpcProtocol{
BaseProtocol: protocol.NewBaseProtocol(),
@@ -54,7 +54,7 @@ func NewGRPCProtocol() *GrpcProtocol {
}
}
-// Export ...
+// Export gRPC service for remote invocation
func (gp *GrpcProtocol) Export(invoker protocol.Invoker) protocol.Exporter {
url := invoker.GetUrl()
serviceKey := url.ServiceKey()
@@ -84,7 +84,7 @@ func (gp *GrpcProtocol) openServer(url common.URL) {
}
}
-// Refer ...
+// Refer a remote gRPC service
func (gp *GrpcProtocol) Refer(url common.URL) protocol.Invoker {
invoker := NewGrpcInvoker(url, NewClient(url))
gp.SetInvokers(invoker)
@@ -92,7 +92,7 @@ func (gp *GrpcProtocol) Refer(url common.URL) protocol.Invoker {
return invoker
}
-// Destroy ...
+// Destroy will destroy gRPC all invoker and exporter, so it only is called once.
func (gp *GrpcProtocol) Destroy() {
logger.Infof("GrpcProtocol destroy.")
@@ -104,7 +104,7 @@ func (gp *GrpcProtocol) Destroy() {
}
}
-// GetProtocol ...
+// GetProtocol gets gRPC protocol , will create if null.
func GetProtocol() protocol.Protocol {
if grpcProtocol == nil {
grpcProtocol = NewGRPCProtocol()
diff --git a/protocol/grpc/internal/server.go b/protocol/grpc/internal/server.go
index a6b861cac6ccb73f8bdf894f462f380123fa9ae3..f7b99fa0ba557fa002321b5d2435d17cf792dd38 100644
--- a/protocol/grpc/internal/server.go
+++ b/protocol/grpc/internal/server.go
@@ -42,7 +42,7 @@ func (s *server) SayHello(ctx context.Context, in *HelloRequest) (*HelloReply, e
return &HelloReply{Message: "Hello " + in.GetName()}, nil
}
-// InitGrpcServer ...
+// InitGrpcServer creates global gRPC server.
func InitGrpcServer() {
port := ":30000"
@@ -57,7 +57,7 @@ func InitGrpcServer() {
}
}
-// ShutdownGrpcServer ...
+// ShutdownGrpcServer shuts down gRPC server gracefully
func ShutdownGrpcServer() {
if s == nil {
return
diff --git a/protocol/grpc/server.go b/protocol/grpc/server.go
index 63783040f9840c26dbd0cc843e9d49cdc981e64a..4017b65dd5c35ef19795b390e40d7afff6699306 100644
--- a/protocol/grpc/server.go
+++ b/protocol/grpc/server.go
@@ -37,24 +37,27 @@ import (
"github.com/apache/dubbo-go/protocol"
)
-// Server ...
+// Server is a gRPC server
type Server struct {
grpcServer *grpc.Server
}
-// NewServer ...
+// NewServer creates a new server
func NewServer() *Server {
return &Server{}
}
-// DubboGrpcService ...
+// DubboGrpcService is gRPC service
type DubboGrpcService interface {
+ // SetProxyImpl sets proxy.
SetProxyImpl(impl protocol.Invoker)
+ // GetProxyImpl gets proxy.
GetProxyImpl() protocol.Invoker
+ // ServiceDesc gets an RPC service's specification.
ServiceDesc() *grpc.ServiceDesc
}
-// Start ...
+// Start gRPC server with @url
func (s *Server) Start(url common.URL) {
var (
addr string
@@ -106,7 +109,7 @@ func (s *Server) Start(url common.URL) {
}()
}
-// Stop ...
+// Stop gRPC server
func (s *Server) Stop() {
s.grpcServer.Stop()
}
diff --git a/protocol/invocation.go b/protocol/invocation.go
index eedf5f0253c2b76a3e0e1b52a00124d648351cfc..44bebfd948c4fa2b0fe8f760183ed43f8d18b620 100644
--- a/protocol/invocation.go
+++ b/protocol/invocation.go
@@ -21,17 +21,26 @@ import (
"reflect"
)
-// Invocation ...
+// Invocation is a invocation for each remote method.
type Invocation interface {
+ // MethodName gets invocation method name.
MethodName() string
+ // ParameterTypes gets invocation parameter types.
ParameterTypes() []reflect.Type
+ // ParameterValues gets invocation parameter values.
ParameterValues() []reflect.Value
+ // Arguments get arguments.
Arguments() []interface{}
+ // Reply gets request response
Reply() interface{}
+ // Attachments gets all attachments
Attachments() map[string]string
+ // AttachmentsByKey gets attachment by key , if nil then return default value
AttachmentsByKey(string, string) string
// Refer to dubbo 2.7.6. It is different from attachment. It is used in internal process.
Attributes() map[string]interface{}
+ // AttributeByKey gets attribute by key , if nil then return default value
AttributeByKey(string, interface{}) interface{}
+ // Invoker gets the invoker in current context.
Invoker() Invoker
}
diff --git a/protocol/invoker.go b/protocol/invoker.go
index bb71bab1cfa2ede7fb035912ae996f9adb7411e0..3ca370479cbe2255f26628b855b11b07396f1b6d 100644
--- a/protocol/invoker.go
+++ b/protocol/invoker.go
@@ -31,6 +31,7 @@ import (
// Extension - Invoker
type Invoker interface {
common.Node
+ // Invoke the invocation and return result.
Invoke(context.Context, Invocation) Result
}
@@ -38,14 +39,14 @@ type Invoker interface {
// base invoker
/////////////////////////////
-// BaseInvoker ...
+// BaseInvoker provides default invoker implement
type BaseInvoker struct {
url common.URL
available bool
destroyed bool
}
-// NewBaseInvoker ...
+// NewBaseInvoker creates a new BaseInvoker
func NewBaseInvoker(url common.URL) *BaseInvoker {
return &BaseInvoker{
url: url,
@@ -54,27 +55,27 @@ func NewBaseInvoker(url common.URL) *BaseInvoker {
}
}
-// GetUrl ...
+// GetUrl gets base invoker URL
func (bi *BaseInvoker) GetUrl() common.URL {
return bi.url
}
-// IsAvailable ...
+// IsAvailable gets available flag
func (bi *BaseInvoker) IsAvailable() bool {
return bi.available
}
-// IsDestroyed ...
+// IsDestroyed gets destroyed flag
func (bi *BaseInvoker) IsDestroyed() bool {
return bi.destroyed
}
-// Invoke ...
+// Invoke provides default invoker implement
func (bi *BaseInvoker) Invoke(context context.Context, invocation Invocation) Result {
return &RPCResult{}
}
-// Destroy ...
+// Destroy changes available and destroyed flag
func (bi *BaseInvoker) Destroy() {
logger.Infof("Destroy invoker: %s", bi.GetUrl().String())
bi.destroyed = true
diff --git a/protocol/protocol.go b/protocol/protocol.go
index a873469a8ba361c9dfc922b071ffbf256c6a8b98..6bed5ec4c2be82edda7a642eb342381c53387460 100644
--- a/protocol/protocol.go
+++ b/protocol/protocol.go
@@ -29,15 +29,20 @@ import (
// Protocol
// Extension - protocol
type Protocol interface {
+ // Export service for remote invocation
Export(invoker Invoker) Exporter
+ // Refer a remote service
Refer(url common.URL) Invoker
+ // Destroy will destroy all invoker and exporter, so it only is called once.
Destroy()
}
// Exporter
// wrapping invoker
type Exporter interface {
+ // GetInvoker gets invoker.
GetInvoker() Invoker
+ // Unexport exported service.
Unexport()
}
@@ -45,45 +50,45 @@ type Exporter interface {
// base protocol
/////////////////////////////
-// BaseProtocol ...
+// BaseProtocol is default protocol implement.
type BaseProtocol struct {
exporterMap *sync.Map
invokers []Invoker
}
-// NewBaseProtocol ...
+// NewBaseProtocol creates a new BaseProtocol
func NewBaseProtocol() BaseProtocol {
return BaseProtocol{
exporterMap: new(sync.Map),
}
}
-// SetExporterMap ...
+// SetExporterMap set @exporter with @key to local memory.
func (bp *BaseProtocol) SetExporterMap(key string, exporter Exporter) {
bp.exporterMap.Store(key, exporter)
}
-// ExporterMap ...
+// ExporterMap gets exporter map.
func (bp *BaseProtocol) ExporterMap() *sync.Map {
return bp.exporterMap
}
-// SetInvokers ...
+// SetInvokers sets invoker into local memory
func (bp *BaseProtocol) SetInvokers(invoker Invoker) {
bp.invokers = append(bp.invokers, invoker)
}
-// Invokers ...
+// Invokers gets all invokers
func (bp *BaseProtocol) Invokers() []Invoker {
return bp.invokers
}
-// Export ...
+// Export is default export implement.
func (bp *BaseProtocol) Export(invoker Invoker) Exporter {
return NewBaseExporter("base", invoker, bp.exporterMap)
}
-// Refer ...
+// Refer is default refer implement.
func (bp *BaseProtocol) Refer(url common.URL) Invoker {
return NewBaseInvoker(url)
}
@@ -113,14 +118,14 @@ func (bp *BaseProtocol) Destroy() {
// base exporter
/////////////////////////////
-// BaseExporter ...
+// BaseExporter is default exporter implement.
type BaseExporter struct {
key string
invoker Invoker
exporterMap *sync.Map
}
-// NewBaseExporter ...
+// NewBaseExporter creates a new BaseExporter
func NewBaseExporter(key string, invoker Invoker, exporterMap *sync.Map) *BaseExporter {
return &BaseExporter{
key: key,
@@ -129,13 +134,13 @@ func NewBaseExporter(key string, invoker Invoker, exporterMap *sync.Map) *BaseEx
}
}
-// GetInvoker ...
+// GetInvoker gets invoker
func (de *BaseExporter) GetInvoker() Invoker {
return de.invoker
}
-// Unexport ...
+// Unexport exported service.
func (de *BaseExporter) Unexport() {
logger.Infof("Exporter unexport.")
de.invoker.Destroy()
diff --git a/protocol/protocolwrapper/mock_protocol_filter.go b/protocol/protocolwrapper/mock_protocol_filter.go
index dedf8aa64b6ae1b7b4782350e2625b02171aac44..8763c20410915d4e81afd35691be7d9ed490f7a1 100644
--- a/protocol/protocolwrapper/mock_protocol_filter.go
+++ b/protocol/protocolwrapper/mock_protocol_filter.go
@@ -28,19 +28,22 @@ import (
type mockProtocolFilter struct{}
-// NewMockProtocolFilter ...
+// NewMockProtocolFilter creates a new mock protocol
func NewMockProtocolFilter() protocol.Protocol {
return &mockProtocolFilter{}
}
+// Export mock service for remote invocation
func (pfw *mockProtocolFilter) Export(invoker protocol.Invoker) protocol.Exporter {
return protocol.NewBaseExporter("key", invoker, &sync.Map{})
}
+// Refer a mock remote service
func (pfw *mockProtocolFilter) Refer(url common.URL) protocol.Invoker {
return protocol.NewBaseInvoker(url)
}
+// Destroy will do nothing
func (pfw *mockProtocolFilter) Destroy() {
}
diff --git a/protocol/protocolwrapper/protocol_filter_wrapper.go b/protocol/protocolwrapper/protocol_filter_wrapper.go
index 70d2da0faed3bc9797eb23cec653bea05d445d91..cba1d5d5bce8c3de387381d17cc3f7965bf3adac 100644
--- a/protocol/protocolwrapper/protocol_filter_wrapper.go
+++ b/protocol/protocolwrapper/protocol_filter_wrapper.go
@@ -31,7 +31,7 @@ import (
)
const (
- // FILTER ...
+ // FILTER is protocol key.
FILTER = "filter"
)
@@ -45,7 +45,7 @@ type ProtocolFilterWrapper struct {
protocol protocol.Protocol
}
-// Export ...
+// Export service for remote invocation
func (pfw *ProtocolFilterWrapper) Export(invoker protocol.Invoker) protocol.Exporter {
if pfw.protocol == nil {
pfw.protocol = extension.GetProtocol(invoker.GetUrl().Protocol)
@@ -54,7 +54,7 @@ func (pfw *ProtocolFilterWrapper) Export(invoker protocol.Invoker) protocol.Expo
return pfw.protocol.Export(invoker)
}
-// Refer ...
+// Refer a remote service
func (pfw *ProtocolFilterWrapper) Refer(url common.URL) protocol.Invoker {
if pfw.protocol == nil {
pfw.protocol = extension.GetProtocol(url.Protocol)
@@ -62,7 +62,7 @@ func (pfw *ProtocolFilterWrapper) Refer(url common.URL) protocol.Invoker {
return buildInvokerChain(pfw.protocol.Refer(url), constant.REFERENCE_FILTER_KEY)
}
-// Destroy ...
+// Destroy will destroy all invoker and exporter.
func (pfw *ProtocolFilterWrapper) Destroy() {
pfw.protocol.Destroy()
}
diff --git a/protocol/result.go b/protocol/result.go
index 34e76d2dddbaed33b2e2c015631443565cfaea87..2e7a6e492a60888ec9d9f420c77e6b77aee6aa70 100644
--- a/protocol/result.go
+++ b/protocol/result.go
@@ -17,15 +17,23 @@
package protocol
-// Result ...
+// Result is a RPC result
type Result interface {
+ // SetError sets error.
SetError(error)
+ // Error gets error.
Error() error
+ // SetResult sets invoker result.
SetResult(interface{})
+ // Result gets invoker result.
Result() interface{}
+ // SetAttachments replaces the existing attachments with the specified param.
SetAttachments(map[string]string)
+ // Attachments gets all attachments
Attachments() map[string]string
+ // AddAttachment adds the specified map to existing attachments in this instance.
AddAttachment(string, string)
+ // Attachment gets attachment by key with default value.
Attachment(string, string) string
}
@@ -33,48 +41,49 @@ type Result interface {
// Result Impletment of RPC
/////////////////////////////
-// RPCResult ...
+// RPCResult is default RPC result.
type RPCResult struct {
Attrs map[string]string
Err error
Rest interface{}
}
-// SetError ...
+// SetError sets error.
func (r *RPCResult) SetError(err error) {
r.Err = err
}
+// Error gets error.
func (r *RPCResult) Error() error {
return r.Err
}
-// SetResult ...
+// SetResult sets invoker result.
func (r *RPCResult) SetResult(rest interface{}) {
r.Rest = rest
}
-// Result ...
+// Result gets invoker result.
func (r *RPCResult) Result() interface{} {
return r.Rest
}
-// SetAttachments ...
+// SetAttachments replaces the existing attachments with the specified param.
func (r *RPCResult) SetAttachments(attr map[string]string) {
r.Attrs = attr
}
-// Attachments ...
+// Attachments gets all attachments
func (r *RPCResult) Attachments() map[string]string {
return r.Attrs
}
-// AddAttachment ...
+// AddAttachment adds the specified map to existing attachments in this instance.
func (r *RPCResult) AddAttachment(key, value string) {
r.Attrs[key] = value
}
-// Attachment ...
+// Attachment gets attachment by key with default value.
func (r *RPCResult) Attachment(key, defaultValue string) string {
v, ok := r.Attrs[key]
if !ok {
diff --git a/protocol/rpc_status.go b/protocol/rpc_status.go
index 13be47c98ece1cc006250ad49ab2b9a8c3b1f625..0eeca6c1bba1f471117eb687a92d0458b9d5901d 100644
--- a/protocol/rpc_status.go
+++ b/protocol/rpc_status.go
@@ -32,7 +32,7 @@ var (
serviceStatistic sync.Map // url -> RPCStatus
)
-// RPCStatus ...
+// RPCStatus is URL statistics.
type RPCStatus struct {
active int32
failed int32
@@ -46,63 +46,63 @@ type RPCStatus struct {
lastRequestFailedTimestamp int64
}
-// GetActive ...
+// GetActive gets active.
func (rpc *RPCStatus) GetActive() int32 {
return atomic.LoadInt32(&rpc.active)
}
-// GetFailed ...
+// GetFailed gets failed.
func (rpc *RPCStatus) GetFailed() int32 {
return atomic.LoadInt32(&rpc.failed)
}
-// GetTotal ...
+// GetTotal gets total.
func (rpc *RPCStatus) GetTotal() int32 {
return atomic.LoadInt32(&rpc.total)
}
-// GetTotalElapsed ...
+// GetTotalElapsed gets total elapsed.
func (rpc *RPCStatus) GetTotalElapsed() int64 {
return atomic.LoadInt64(&rpc.totalElapsed)
}
-// GetFailedElapsed ...
+// GetFailedElapsed gets failed elapsed.
func (rpc *RPCStatus) GetFailedElapsed() int64 {
return atomic.LoadInt64(&rpc.failedElapsed)
}
-// GetMaxElapsed ...
+// GetMaxElapsed gets max elapsed.
func (rpc *RPCStatus) GetMaxElapsed() int64 {
return atomic.LoadInt64(&rpc.maxElapsed)
}
-// GetFailedMaxElapsed ...
+// GetFailedMaxElapsed gets failed max elapsed.
func (rpc *RPCStatus) GetFailedMaxElapsed() int64 {
return atomic.LoadInt64(&rpc.failedMaxElapsed)
}
-// GetSucceededMaxElapsed ...
+// GetSucceededMaxElapsed gets succeeded max elapsed.
func (rpc *RPCStatus) GetSucceededMaxElapsed() int64 {
return atomic.LoadInt64(&rpc.succeededMaxElapsed)
}
-// GetLastRequestFailedTimestamp ...
+// GetLastRequestFailedTimestamp gets last request failed timestamp.
func (rpc *RPCStatus) GetLastRequestFailedTimestamp() int64 {
return atomic.LoadInt64(&rpc.lastRequestFailedTimestamp)
}
-// GetSuccessiveRequestFailureCount ...
+// GetSuccessiveRequestFailureCount gets successive request failure count.
func (rpc *RPCStatus) GetSuccessiveRequestFailureCount() int32 {
return atomic.LoadInt32(&rpc.successiveRequestFailureCount)
}
-// GetURLStatus ...
+// GetURLStatus get URL RPC status.
func GetURLStatus(url common.URL) *RPCStatus {
rpcStatus, _ := serviceStatistic.LoadOrStore(url.Key(), &RPCStatus{})
return rpcStatus.(*RPCStatus)
}
-// GetMethodStatus ...
+// GetMethodStatus get method RPC status.
func GetMethodStatus(url common.URL, methodName string) *RPCStatus {
identifier := url.Key()
methodMap, found := methodStatistics.Load(identifier)
@@ -122,13 +122,13 @@ func GetMethodStatus(url common.URL, methodName string) *RPCStatus {
return status
}
-// BeginCount ...
+// BeginCount gets begin count.
func BeginCount(url common.URL, methodName string) {
beginCount0(GetURLStatus(url))
beginCount0(GetMethodStatus(url, methodName))
}
-// EndCount ...
+// EndCount gets end count.
func EndCount(url common.URL, methodName string, elapsed int64, succeeded bool) {
endCount0(GetURLStatus(url), elapsed, succeeded)
endCount0(GetMethodStatus(url, methodName), elapsed, succeeded)
@@ -163,7 +163,7 @@ func endCount0(rpcStatus *RPCStatus, elapsed int64, succeeded bool) {
}
}
-// CurrentTimeMillis ...
+// CurrentTimeMillis get current timestamp
func CurrentTimeMillis() int64 {
return time.Now().UnixNano() / int64(time.Millisecond)
}