Skip to content
Snippets Groups Projects
Commit ca498fbf authored by 邹毅贤's avatar 邹毅贤
Browse files

fix review comment

parent b248b6c1
No related branches found
No related tags found
No related merge requests found
......@@ -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)
}
......
......@@ -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
......
......@@ -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:
......
......@@ -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:
......
......@@ -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/")
......
......@@ -36,7 +36,7 @@ func init() {
// service event
// ////////////////////////////////////////
// ServiceEvent is createupdate or delete event of service
// ServiceEvent includes create, update, delete event
type ServiceEvent struct {
Action remoting.EventType
Service common.URL
......
......@@ -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
......
......@@ -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
}
......
......@@ -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
}
......@@ -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 {
......
......@@ -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
}
......@@ -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))
......
......@@ -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)
}
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment