diff --git a/config_center/configuration_listener.go b/config_center/configuration_listener.go
index 096df1a5862430491175de1df2c096db1c07c39d..97fd9c70923f5c921ce2ca2b4028a71ea2b49e27 100644
--- a/config_center/configuration_listener.go
+++ b/config_center/configuration_listener.go
@@ -27,7 +27,7 @@ import (
// ConfigurationListener for changing listener's event
type ConfigurationListener interface {
- // Process notified once there's any change happens on the config
+ // Process the notification event once there's any change happens on the config
Process(*ConfigChangeEvent)
}
diff --git a/registry/base_configuration_listener.go b/registry/base_configuration_listener.go
index 855af648c26ebfc4bff52f40180a370a2c0c86bb..7b28d7ee1b30a03b8211c4c1efa5824c3b61453a 100644
--- a/registry/base_configuration_listener.go
+++ b/registry/base_configuration_listener.go
@@ -41,7 +41,7 @@ func (bcl *BaseConfigurationListener) Configurators() []config_center.Configurat
return bcl.configurators
}
-// InitWith will init BaseConfigurationListener with @key 、@listener and @f
+// InitWith will init BaseConfigurationListener by @key+@Listener+@f
func (bcl *BaseConfigurationListener) InitWith(key string, listener config_center.ConfigurationListener, f func(url *common.URL) config_center.Configurator) {
bcl.dynamicConfiguration = config.GetEnvInstance().GetDynamicConfiguration()
if bcl.dynamicConfiguration == nil {
@@ -60,7 +60,7 @@ func (bcl *BaseConfigurationListener) InitWith(key string, listener config_cente
}
}
-// Process can reference ConfigurationListener.Process
+// Process the notification event once there's any change happens on the config.
func (bcl *BaseConfigurationListener) Process(event *config_center.ConfigChangeEvent) {
logger.Infof("Notification of overriding rule, change type is: %v , raw config content is:%v", event.ConfigType, event.Value)
if event.ConfigType == remoting.EventTypeDel {
@@ -82,14 +82,14 @@ func (bcl *BaseConfigurationListener) genConfiguratorFromRawRule(rawConfig strin
return nil
}
-// OverrideUrl gets existing configuration rule and override provider url before exporting.
+// OverrideUrl gets existing configuration rule and overrides provider url before exporting.
func (bcl *BaseConfigurationListener) OverrideUrl(url *common.URL) {
for _, v := range bcl.configurators {
v.Configure(url)
}
}
-// ToConfigurators converts override urls to map for use when re-refer. Send all rules every time, the urls will be reassembled and calculated
+// ToConfigurators converts @urls by @f to config_center.Configurators
func ToConfigurators(urls []*common.URL, f func(url *common.URL) config_center.Configurator) []config_center.Configurator {
if len(urls) == 0 {
return nil
diff --git a/registry/consul/listener.go b/registry/consul/listener.go
index 841ecbacc53db988f4d394847ca016d7caa18131..cf3888dd16ee4a9b504664383be69ca1faf4d842 100644
--- a/registry/consul/listener.go
+++ b/registry/consul/listener.go
@@ -187,7 +187,7 @@ func (l *consulListener) handler(idx uint64, raw interface{}) {
}
}
-// Next returns next service event once received
+// Next returns the service event from consul.
func (l *consulListener) Next() (*registry.ServiceEvent, error) {
select {
case event := <-l.eventCh:
diff --git a/registry/consul/registry.go b/registry/consul/registry.go
index c03f2c06ffbda084d09399cbdbd30e5ea79dd382..4ef87394687aecc8804b2cebedd58fc0e72e8e6e 100644
--- a/registry/consul/registry.go
+++ b/registry/consul/registry.go
@@ -163,7 +163,7 @@ func (r *consulRegistry) GetUrl() common.URL {
return *r.URL
}
-// IsAvailable determines consul registry center whether is available
+// IsAvailable checks consul registry center whether is available
func (r *consulRegistry) IsAvailable() bool {
select {
case <-r.done:
diff --git a/registry/etcdv3/listener.go b/registry/etcdv3/listener.go
index 0ecdbf7af83d7318cab915a80f90025b8b5cf089..436b6eca5b0dfb8514cbc21a47032490f7b1c21f 100644
--- a/registry/etcdv3/listener.go
+++ b/registry/etcdv3/listener.go
@@ -43,12 +43,12 @@ func NewRegistryDataListener(listener config_center.ConfigurationListener) *data
return &dataListener{listener: listener}
}
-// AddInterestedURL add more URL of registry center to listen
+// AddInterestedURL adds a registration @url to listen
func (l *dataListener) AddInterestedURL(url *common.URL) {
l.interestedURL = append(l.interestedURL, url)
}
-// Process data change event from registry center of etcd
+// DataChange processes the data change event from registry center of etcd
func (l *dataListener) DataChange(eventType remoting.Event) bool {
index := strings.Index(eventType.Path, "/providers/")
diff --git a/registry/event.go b/registry/event.go
index 00fe183a9839c6e3d00f205abae065ea88328e3e..5fe6df6a379e1de8662917fb76c6d16fa9a17f37 100644
--- a/registry/event.go
+++ b/registry/event.go
@@ -36,7 +36,7 @@ func init() {
// service event
// ////////////////////////////////////////
-// ServiceEvent is create、update or delete event of service
+// ServiceEvent includes create, update, delete event
type ServiceEvent struct {
Action remoting.EventType
Service common.URL
diff --git a/registry/event_listener.go b/registry/event_listener.go
index 7ab011a549fe6ed55cfea2f43549a72fac50f2ee..1805f2833c96bd08c4cf9c92337d7d221e8829e9 100644
--- a/registry/event_listener.go
+++ b/registry/event_listener.go
@@ -36,7 +36,7 @@ type ConditionalEventListener interface {
Accept(e Event) bool
}
-// ServiceInstancesChangedListener is use for the Service Discovery Changed
+// ServiceInstancesChangedListener is used when the Service Discovery Changed
// TODO (implement ConditionalEventListener)
type ServiceInstancesChangedListener struct {
ServiceName string
diff --git a/registry/kubernetes/listener.go b/registry/kubernetes/listener.go
index 3da01166007d39e33add2ef22eb7f6ddee1892f6..24c8d81614c7dd323e4f23ec7de5d28b24eecb70 100644
--- a/registry/kubernetes/listener.go
+++ b/registry/kubernetes/listener.go
@@ -43,7 +43,7 @@ func NewRegistryDataListener(listener config_center.ConfigurationListener) *data
return &dataListener{listener: listener}
}
-// AddInterestedURL add more URL of registry center to listen
+// AddInterestedURL adds the @url of registry center to the listener
func (l *dataListener) AddInterestedURL(url *common.URL) {
l.interestedURL = append(l.interestedURL, url)
}
@@ -91,7 +91,7 @@ func NewConfigurationListener(reg *kubernetesRegistry) *configurationListener {
return &configurationListener{registry: reg, events: make(chan *config_center.ConfigChangeEvent, 32)}
}
-// Process data change event from config center of kubernetes
+// Process processes the data change event from config center of kubernetes
func (l *configurationListener) Process(configType *config_center.ConfigChangeEvent) {
l.events <- configType
}
diff --git a/registry/mock_registry.go b/registry/mock_registry.go
index 7dbcbbd4e2b766c602a64782ff2a154d0efe8492..2b83d5ab8892f673e1123cd01fa74e48e3d2dc22 100644
--- a/registry/mock_registry.go
+++ b/registry/mock_registry.go
@@ -30,13 +30,13 @@ import (
"github.com/apache/dubbo-go/common/logger"
)
-// MockRegistry is use for mock registry
+// MockRegistry is used as mock registry
type MockRegistry struct {
listener *listener
destroyed *atomic.Bool
}
-// NewMockRegistry is use for create a mock registry
+// NewMockRegistry creates a mock registry
func NewMockRegistry(url *common.URL) (Registry, error) {
registry := &MockRegistry{
destroyed: atomic.NewBool(false),
@@ -46,12 +46,12 @@ func NewMockRegistry(url *common.URL) (Registry, error) {
return registry, nil
}
-// Register is use for register a mock registry
+// Register is used as a mock registry
func (*MockRegistry) Register(url common.URL) error {
return nil
}
-// Destroy is use for destory a mock registry
+// nolint
func (r *MockRegistry) Destroy() {
if r.destroyed.CAS(false, true) {
}
@@ -62,7 +62,7 @@ func (r *MockRegistry) IsAvailable() bool {
return !r.destroyed.Load()
}
-// GetUrl is use for register a mock registry URL
+// nolint
func (r *MockRegistry) GetUrl() common.URL {
return common.URL{}
}
@@ -71,7 +71,7 @@ func (r *MockRegistry) subscribe(*common.URL) (Listener, error) {
return r.listener, nil
}
-// Subscribe is use for subscribe a mock registry
+// nolint
func (r *MockRegistry) Subscribe(url *common.URL, notifyListener NotifyListener) {
go func() {
for {
@@ -123,7 +123,7 @@ func (*listener) Close() {
}
-// MockEvent is use for register a mock event
+// nolint
func (r *MockRegistry) MockEvent(event *ServiceEvent) {
r.listener.listenChan <- event
}
diff --git a/registry/nacos/listener.go b/registry/nacos/listener.go
index 9af731801c942a1584685a96b53a30b02028243a..36f733df5a32f57e3410a2f31f9ab4b0af735d49 100644
--- a/registry/nacos/listener.go
+++ b/registry/nacos/listener.go
@@ -109,7 +109,7 @@ func generateUrl(instance model.Instance) *common.URL {
)
}
-// Callback will callback when subscribed
+// Callback will be invoked when got subscribed events.
func (nl *nacosListener) Callback(services []model.SubscribeService, err error) {
if err != nil {
logger.Errorf("nacos subscribe callback error:%s , subscribe:%+v ", err.Error(), nl.subscribeParam)
@@ -199,7 +199,7 @@ func (nl *nacosListener) process(configType *config_center.ConfigChangeEvent) {
nl.events <- configType
}
-// Next returns next service event once received
+// Next returns the service event from nacos.
func (nl *nacosListener) Next() (*registry.ServiceEvent, error) {
for {
select {
diff --git a/registry/nacos/registry.go b/registry/nacos/registry.go
index 345e5145e0a143b434f8eba3b91e31f30453a912..3eeb7680abb3da98f5ed08f1aea57d490b2caf85 100644
--- a/registry/nacos/registry.go
+++ b/registry/nacos/registry.go
@@ -123,7 +123,7 @@ func createRegisterParam(url common.URL, serviceName string) vo.RegisterInstance
return instance
}
-// Register service to nacos registry center
+// Register will register the service @url to its nacos registry center
func (nr *nacosRegistry) Register(url common.URL) error {
serviceName := getServiceName(url)
param := createRegisterParam(url, serviceName)
@@ -141,7 +141,7 @@ func (nr *nacosRegistry) subscribe(conf *common.URL) (registry.Listener, error)
return NewNacosListener(*conf, nr.namingClient)
}
-//subscribe from registry
+// subscribe from registry
func (nr *nacosRegistry) Subscribe(url *common.URL, notifyListener registry.NotifyListener) {
for {
if !nr.IsAvailable() {
@@ -175,17 +175,17 @@ func (nr *nacosRegistry) Subscribe(url *common.URL, notifyListener registry.Noti
}
}
-// GetUrl get registry URL of nacos registry center
+// GetUrl gets its registration URL
func (nr *nacosRegistry) GetUrl() common.URL {
return *nr.URL
}
-// IsAvailable determines nacos registry center whether is available
+// IsAvailable determines nacos registry center whether it is available
func (nr *nacosRegistry) IsAvailable() bool {
return true
}
-// Destroy nacos registry center
+// nolint
func (nr *nacosRegistry) Destroy() {
return
}
diff --git a/registry/protocol/protocol.go b/registry/protocol/protocol.go
index 68d8a9efb49514c4a58b32ba0591951ced7571bb..4c669b2cee74b95ceb3bc8287f145ccd6b99bc0b 100644
--- a/registry/protocol/protocol.go
+++ b/registry/protocol/protocol.go
@@ -231,7 +231,7 @@ func newOverrideSubscribeListener(overriderUrl *common.URL, invoker protocol.Inv
return &overrideSubscribeListener{url: overriderUrl, originInvoker: invoker, protocol: proto}
}
-// Notify will triggered when a service change notification is received.
+// Notify will be triggered when a service change notification is received.
func (nl *overrideSubscribeListener) Notify(event *registry.ServiceEvent) {
if isMatched(&(event.Service), nl.url) && event.Action == remoting.EventTypeAdd {
nl.configurator = extension.GetDefaultConfigurator(&(event.Service))
diff --git a/registry/zookeeper/registry.go b/registry/zookeeper/registry.go
index e7ae2279f8215543561c0a3a5423ada71cf50a60..1e7bd08adef5ac9920413fd198b726f49c11ecd4 100644
--- a/registry/zookeeper/registry.go
+++ b/registry/zookeeper/registry.go
@@ -116,7 +116,7 @@ func newMockZkRegistry(url *common.URL, opts ...zookeeper.Option) (*zk.TestClust
return c, r, nil
}
-// InitListeners init listeners of zookeeper registry center
+// InitListeners initializes listeners of zookeeper registry center
func (r *zkRegistry) InitListeners() {
r.listener = zookeeper.NewZkEventListener(r.client)
newDataListener := NewRegistryDataListener()
@@ -142,7 +142,7 @@ func (r *zkRegistry) InitListeners() {
r.dataListener = newDataListener
}
-// CreatePath create the path in the registry center of zookeeper
+// CreatePath creates the path in the registry center of zookeeper
func (r *zkRegistry) CreatePath(path string) error {
return r.ZkClient().Create(path)
}
@@ -152,7 +152,7 @@ func (r *zkRegistry) DoRegister(root string, node string) error {
return r.registerTempZookeeperNode(root, node)
}
-// DoSubscribe actually subscribe the provider URL
+// DoSubscribe actually subscribes the provider URL
func (r *zkRegistry) DoSubscribe(conf *common.URL) (registry.Listener, error) {
return r.getListener(conf)
}