diff --git a/common/config/environment.go b/common/config/environment.go
index 071af31152ba4ce3c579f70aa23df59d718ce506..446c46aa1ef71a68aa024bf83dd9088cf03677f2 100644
--- a/common/config/environment.go
+++ b/common/config/environment.go
@@ -46,7 +46,7 @@ var (
once sync.Once
)
-// GetEnvInstance ...
+// GetEnvInstance gets env instance by singleton
func GetEnvInstance() *Environment {
once.Do(func() {
instance = &Environment{configCenterFirst: true}
@@ -54,7 +54,7 @@ func GetEnvInstance() *Environment {
return instance
}
-// NewEnvInstance ...
+// NewEnvInstance creates Environment instance
func NewEnvInstance() {
instance = &Environment{configCenterFirst: true}
}
@@ -67,21 +67,22 @@ func NewEnvInstance() {
// return env.configCenterFirst
//}
-// UpdateExternalConfigMap ...
+// UpdateExternalConfigMap updates env externalConfigMap field
func (env *Environment) UpdateExternalConfigMap(externalMap map[string]string) {
for k, v := range externalMap {
env.externalConfigMap.Store(k, v)
}
}
-// UpdateAppExternalConfigMap ...
+// UpdateAppExternalConfigMap updates env appExternalConfigMap field
func (env *Environment) UpdateAppExternalConfigMap(externalMap map[string]string) {
for k, v := range externalMap {
env.appExternalConfigMap.Store(k, v)
}
}
-// Configuration ...
+// Configuration puts externalConfigMap and appExternalConfigMap into list
+// List represents a doubly linked list.
func (env *Environment) Configuration() *list.List {
cfgList := list.New()
// The sequence would be: SystemConfiguration -> ExternalConfiguration -> AppExternalConfiguration -> AbstractConfig -> PropertiesConfiguration
@@ -90,17 +91,17 @@ func (env *Environment) Configuration() *list.List {
return cfgList
}
-// SetDynamicConfiguration ...
+// SetDynamicConfiguration sets value for dynamicConfiguration
func (env *Environment) SetDynamicConfiguration(dc config_center.DynamicConfiguration) {
env.dynamicConfiguration = dc
}
-// GetDynamicConfiguration ...
+// GetDynamicConfiguration gets dynamicConfiguration
func (env *Environment) GetDynamicConfiguration() config_center.DynamicConfiguration {
return env.dynamicConfiguration
}
-// InmemoryConfiguration ...
+// InmemoryConfiguration stores config in memory
type InmemoryConfiguration struct {
store *sync.Map
}
@@ -109,7 +110,7 @@ func newInmemoryConfiguration(p *sync.Map) *InmemoryConfiguration {
return &InmemoryConfiguration{store: p}
}
-// GetProperty ...
+// GetProperty gets value from InmemoryConfiguration instance by @key
func (conf *InmemoryConfiguration) GetProperty(key string) (bool, string) {
if conf.store == nil {
return false, ""
@@ -123,7 +124,7 @@ func (conf *InmemoryConfiguration) GetProperty(key string) (bool, string) {
return false, ""
}
-// GetSubProperty ...
+// GetSubProperty gets sub property from InmemoryConfiguration instance by @subkey
func (conf *InmemoryConfiguration) GetSubProperty(subKey string) map[string]struct{} {
if conf.store == nil {
return nil
diff --git a/common/extension/auth.go b/common/extension/auth.go
index d7900045d3f7db9e2587e4e92e377325c74971b3..7caae00e84fd80666ff79b599e12f8516e23209c 100644
--- a/common/extension/auth.go
+++ b/common/extension/auth.go
@@ -26,12 +26,12 @@ var (
accesskeyStorages = make(map[string]func() filter.AccessKeyStorage)
)
-// SetAuthenticator put the fcn into map with name
+// SetAuthenticator puts the @fcn into map with name
func SetAuthenticator(name string, fcn func() filter.Authenticator) {
authenticators[name] = fcn
}
-// GetAuthenticator find the Authenticator with name
+// GetAuthenticator finds the Authenticator with @name
// if not found, it will panic
func GetAuthenticator(name string) filter.Authenticator {
if authenticators[name] == nil {
@@ -40,12 +40,12 @@ func GetAuthenticator(name string) filter.Authenticator {
return authenticators[name]()
}
-// SetAccesskeyStorages will set the fcn into map with this name
+// SetAccesskeyStorages will set the @fcn into map with this name
func SetAccesskeyStorages(name string, fcn func() filter.AccessKeyStorage) {
accesskeyStorages[name] = fcn
}
-// GetAccesskeyStorages find the storage with the name.
+// GetAccesskeyStorages finds the storage with the @name.
// If not found, it will panic.
func GetAccesskeyStorages(name string) filter.AccessKeyStorage {
if accesskeyStorages[name] == nil {
diff --git a/common/extension/cluster.go b/common/extension/cluster.go
index b2d81f6b1e56bb487b1d408b878308f6dfe042e4..8be27a1ca3aaf93dd54201c4ff7081478c746f0f 100644
--- a/common/extension/cluster.go
+++ b/common/extension/cluster.go
@@ -25,12 +25,13 @@ var (
clusters = make(map[string]func() cluster.Cluster)
)
-// SetCluster ...
+// SetCluster sets the cluster fault-tolerant mode with @name
+// For example: available/failfast/broadcast/failfast/failsafe/...
func SetCluster(name string, fcn func() cluster.Cluster) {
clusters[name] = fcn
}
-// GetCluster ...
+// GetCluster finds the cluster fault-tolerant mode with @name
func GetCluster(name string) cluster.Cluster {
if clusters[name] == nil {
panic("cluster for " + name + " is not existing, make sure you have import the package.")
diff --git a/common/extension/config_center.go b/common/extension/config_center.go
index 03d27db46c94b0ea0e212646077d97f948a8e328..3cbced8d3bbcdb3dc7f9af800fa36681d6dc063d 100644
--- a/common/extension/config_center.go
+++ b/common/extension/config_center.go
@@ -26,12 +26,12 @@ var (
configCenters = make(map[string]func(config *common.URL) (config_center.DynamicConfiguration, error))
)
-// SetConfigCenter ...
+// SetConfigCenter sets the DynamicConfiguration with @name
func SetConfigCenter(name string, v func(config *common.URL) (config_center.DynamicConfiguration, error)) {
configCenters[name] = v
}
-// GetConfigCenter ...
+// GetConfigCenter finds the DynamicConfiguration with @name
func GetConfigCenter(name string, config *common.URL) (config_center.DynamicConfiguration, error) {
if configCenters[name] == nil {
panic("config center for " + name + " is not existing, make sure you have import the package.")
diff --git a/common/extension/config_center_factory.go b/common/extension/config_center_factory.go
index 85913fdce1ed3472c2bd9eb4aadbb0f631481dbd..dff89752296c6d2441d043ec628aa13ad219e698 100644
--- a/common/extension/config_center_factory.go
+++ b/common/extension/config_center_factory.go
@@ -25,12 +25,12 @@ var (
configCenterFactories = make(map[string]func() config_center.DynamicConfigurationFactory)
)
-// SetConfigCenterFactory ...
+// SetConfigCenterFactory sets the DynamicConfigurationFactory with @name
func SetConfigCenterFactory(name string, v func() config_center.DynamicConfigurationFactory) {
configCenterFactories[name] = v
}
-// GetConfigCenterFactory ...
+// GetConfigCenterFactory finds the DynamicConfigurationFactory with @name
func GetConfigCenterFactory(name string) config_center.DynamicConfigurationFactory {
if configCenterFactories[name] == nil {
panic("config center for " + name + " is not existing, make sure you have import the package.")
diff --git a/common/extension/config_reader.go b/common/extension/config_reader.go
index aced5b0281ff9313461425e5ec6d70d562c6c947..5e13d8629fd145dac680619a427c68b29226b051 100644
--- a/common/extension/config_reader.go
+++ b/common/extension/config_reader.go
@@ -26,12 +26,12 @@ var (
defaults = make(map[string]string)
)
-// SetConfigReaders set a creator of config reader.
+// SetConfigReaders sets a creator of config reader with @name
func SetConfigReaders(name string, v func() interfaces.ConfigReader) {
configReaders[name] = v
}
-// GetConfigReaders get a config reader by name.
+// GetConfigReaders gets a config reader with @name
func GetConfigReaders(name string) interfaces.ConfigReader {
if configReaders[name] == nil {
panic("config reader for " + name + " is not existing, make sure you have imported the package.")
@@ -39,12 +39,12 @@ func GetConfigReaders(name string) interfaces.ConfigReader {
return configReaders[name]()
}
-// SetDefaultConfigReader set {name} to default config reader for {module}
+// SetDefaultConfigReader sets @name for @module in default config reader
func SetDefaultConfigReader(module, name string) {
defaults[module] = name
}
-// GetDefaultConfigReader
+// GetDefaultConfigReader gets default config reader
func GetDefaultConfigReader() map[string]string {
return defaults
}
diff --git a/common/extension/configurator.go b/common/extension/configurator.go
index de98f8a260ea1f3a2e2a1f32c82dc869585e2789..dc2bea73afb79aaab36e2ce7cc9675169a446eb7 100644
--- a/common/extension/configurator.go
+++ b/common/extension/configurator.go
@@ -23,7 +23,7 @@ import (
)
const (
- // DefaultKey ...
+ // DefaultKey for default Configurator
DefaultKey = "default"
)
@@ -33,12 +33,12 @@ var (
configurator = make(map[string]getConfiguratorFunc)
)
-// SetConfigurator ...
+// SetConfigurator sets the getConfiguratorFunc with @name
func SetConfigurator(name string, v getConfiguratorFunc) {
configurator[name] = v
}
-// GetConfigurator ...
+// GetConfigurator finds the Configurator with @name
func GetConfigurator(name string, url *common.URL) config_center.Configurator {
if configurator[name] == nil {
panic("configurator for " + name + " is not existing, make sure you have import the package.")
@@ -47,12 +47,12 @@ func GetConfigurator(name string, url *common.URL) config_center.Configurator {
}
-// SetDefaultConfigurator ...
+// SetDefaultConfigurator sets the default Configurator
func SetDefaultConfigurator(v getConfiguratorFunc) {
configurator[DefaultKey] = v
}
-// GetDefaultConfigurator ...
+// GetDefaultConfigurator gets default configurator
func GetDefaultConfigurator(url *common.URL) config_center.Configurator {
if configurator[DefaultKey] == nil {
panic("configurator for default is not existing, make sure you have import the package.")
@@ -61,7 +61,7 @@ func GetDefaultConfigurator(url *common.URL) config_center.Configurator {
}
-// GetDefaultConfiguratorFunc ...
+// GetDefaultConfiguratorFunc gets default configurator function
func GetDefaultConfiguratorFunc() getConfiguratorFunc {
if configurator[DefaultKey] == nil {
panic("configurator for default is not existing, make sure you have import the package.")
diff --git a/common/extension/filter.go b/common/extension/filter.go
index deea2d908bc2741e0f15ecc36e9d4fc5975e531e..96059c4363060c41f14ececb466ca62bdaefb1a9 100644
--- a/common/extension/filter.go
+++ b/common/extension/filter.go
@@ -26,12 +26,13 @@ var (
rejectedExecutionHandler = make(map[string]func() filter.RejectedExecutionHandler)
)
-// SetFilter ...
+// SetFilter sets the filter extension with @name
+// For example: hystrix/metrics/token/tracing/limit/...
func SetFilter(name string, v func() filter.Filter) {
filters[name] = v
}
-// GetFilter ...
+// GetFilter finds the filter extension with @name
func GetFilter(name string) filter.Filter {
if filters[name] == nil {
panic("filter for " + name + " is not existing, make sure you have imported the package.")
@@ -39,12 +40,12 @@ func GetFilter(name string) filter.Filter {
return filters[name]()
}
-// SetRejectedExecutionHandler ...
+// SetRejectedExecutionHandler sets the RejectedExecutionHandler with @name
func SetRejectedExecutionHandler(name string, creator func() filter.RejectedExecutionHandler) {
rejectedExecutionHandler[name] = creator
}
-// GetRejectedExecutionHandler ...
+// GetRejectedExecutionHandler finds the RejectedExecutionHandler with @name
func GetRejectedExecutionHandler(name string) filter.RejectedExecutionHandler {
creator, ok := rejectedExecutionHandler[name]
if !ok {
diff --git a/common/extension/graceful_shutdown.go b/common/extension/graceful_shutdown.go
index 3abd75c0aa328f3553c3d83340ae440b8dfe3356..cb55419aabbce26b41e5b10f49268f6b3ace516d 100644
--- a/common/extension/graceful_shutdown.go
+++ b/common/extension/graceful_shutdown.go
@@ -49,7 +49,7 @@ func AddCustomShutdownCallback(callback func()) {
customShutdownCallbacks.PushBack(callback)
}
-// GetAllCustomShutdownCallbacks ...
+// GetAllCustomShutdownCallbacks gets all custom shutdown callbacks
func GetAllCustomShutdownCallbacks() *list.List {
return customShutdownCallbacks
}
diff --git a/common/extension/health_checker.go b/common/extension/health_checker.go
index 365c5d0910812efb00eb94408bb226115b037c02..548d4dc761b31773a2a39ccb0ae3de1d7ab39eb4 100644
--- a/common/extension/health_checker.go
+++ b/common/extension/health_checker.go
@@ -26,12 +26,12 @@ var (
healthCheckers = make(map[string]func(url *common.URL) router.HealthChecker)
)
-// SethealthChecker set the HealthChecker with name
+// SethealthChecker sets the HealthChecker with @name
func SethealthChecker(name string, fcn func(url *common.URL) router.HealthChecker) {
healthCheckers[name] = fcn
}
-// GetHealthChecker get the HealthChecker with name
+// GetHealthChecker gets the HealthChecker with @name
func GetHealthChecker(name string, url *common.URL) router.HealthChecker {
if healthCheckers[name] == nil {
panic("healthCheckers for " + name + " is not existing, make sure you have import the package.")
diff --git a/common/extension/loadbalance.go b/common/extension/loadbalance.go
index 0d557a4640ed892a18ad59a3247763ab5807a593..aa19141014a6c42df0c17dad05301997f67fbd79 100644
--- a/common/extension/loadbalance.go
+++ b/common/extension/loadbalance.go
@@ -25,12 +25,13 @@ var (
loadbalances = make(map[string]func() cluster.LoadBalance)
)
-// SetLoadbalance ...
+// SetLoadbalance sets the loadbalance extension with @name
+// For example: random/round_robin/consistent_hash/least_active/...
func SetLoadbalance(name string, fcn func() cluster.LoadBalance) {
loadbalances[name] = fcn
}
-// GetLoadbalance ...
+// GetLoadbalance finds the loadbalance extension with @name
func GetLoadbalance(name string) cluster.LoadBalance {
if loadbalances[name] == nil {
panic("loadbalance for " + name + " is not existing, make sure you have import the package.")
diff --git a/common/extension/metadata_report_factory.go b/common/extension/metadata_report_factory.go
index 0ae0793bb4459767cb42fb1860fc484388aae1a3..c55f8617fadd9d09d68547b05341d127716ce73c 100644
--- a/common/extension/metadata_report_factory.go
+++ b/common/extension/metadata_report_factory.go
@@ -25,12 +25,12 @@ var (
metaDataReportFactories = make(map[string]func() metadata.MetadataReportFactory, 8)
)
-// SetMetadataReportFactory ...
+// SetMetadataReportFactory sets the MetadataReportFactory with @name
func SetMetadataReportFactory(name string, v func() metadata.MetadataReportFactory) {
metaDataReportFactories[name] = v
}
-// GetMetadataReportFactory ...
+// GetMetadataReportFactory finds the MetadataReportFactory with @name
func GetMetadataReportFactory(name string) metadata.MetadataReportFactory {
if metaDataReportFactories[name] == nil {
panic("metadata report for " + name + " is not existing, make sure you have import the package.")
diff --git a/common/extension/metrics.go b/common/extension/metrics.go
index 42fca7a2db36614fcef31dd5ba7324a156164d4f..60cf6bac2384c7367094adad83e01f7dcf64a33d 100644
--- a/common/extension/metrics.go
+++ b/common/extension/metrics.go
@@ -27,12 +27,12 @@ var (
metricReporterMap = make(map[string]func() metrics.Reporter, 4)
)
-// SetMetricReporter set a reporter with the name
+// SetMetricReporter sets a reporter with the @name
func SetMetricReporter(name string, reporterFunc func() metrics.Reporter) {
metricReporterMap[name] = reporterFunc
}
-// GetMetricReporter find the reporter with name.
+// GetMetricReporter finds the reporter with @name.
// if not found, it will panic.
// we should know that this method usually is called when system starts, so we should panic
func GetMetricReporter(name string) metrics.Reporter {
diff --git a/common/extension/protocol.go b/common/extension/protocol.go
index 009687a17ace8cea567248af655e04604d09d9b8..c89dd08fae5d12b384d6ca4e797343fe79897bbd 100644
--- a/common/extension/protocol.go
+++ b/common/extension/protocol.go
@@ -25,12 +25,12 @@ var (
protocols = make(map[string]func() protocol.Protocol)
)
-// SetProtocol ...
+// SetProtocol sets the protocol extension with @name
func SetProtocol(name string, v func() protocol.Protocol) {
protocols[name] = v
}
-// GetProtocol ...
+// GetProtocol finds the protocol extension with @name
func GetProtocol(name string) protocol.Protocol {
if protocols[name] == nil {
panic("protocol for " + name + " is not existing, make sure you have import the package.")
diff --git a/common/extension/proxy_factory.go b/common/extension/proxy_factory.go
index 19826bb0560ea0d3fa471c04873b20a6878f57d8..1e326d884b5dd37925c38ffdf0a87e69bf6a865c 100644
--- a/common/extension/proxy_factory.go
+++ b/common/extension/proxy_factory.go
@@ -25,12 +25,12 @@ var (
proxyFactories = make(map[string]func(...proxy.Option) proxy.ProxyFactory)
)
-// SetProxyFactory ...
+// SetProxyFactory sets the ProxyFactory extension with @name
func SetProxyFactory(name string, f func(...proxy.Option) proxy.ProxyFactory) {
proxyFactories[name] = f
}
-// GetProxyFactory ...
+// GetProxyFactory finds the ProxyFactory extension with @name
func GetProxyFactory(name string) proxy.ProxyFactory {
if name == "" {
name = "default"
diff --git a/common/extension/registry.go b/common/extension/registry.go
index 6ba746dc47382927d12ce39b7936212c5d75153d..291a7a7fc2cae07c9228043acae7cc0ed5459a1f 100644
--- a/common/extension/registry.go
+++ b/common/extension/registry.go
@@ -26,12 +26,12 @@ var (
registrys = make(map[string]func(config *common.URL) (registry.Registry, error))
)
-// SetRegistry ...
+// SetRegistry sets the registry extension with @name
func SetRegistry(name string, v func(config *common.URL) (registry.Registry, error)) {
registrys[name] = v
}
-// GetRegistry ...
+// GetRegistry finds the registry extension with @name
func GetRegistry(name string, config *common.URL) (registry.Registry, error) {
if registrys[name] == nil {
panic("registry for " + name + " is not existing, make sure you have import the package.")
diff --git a/common/extension/registry_directory.go b/common/extension/registry_directory.go
index 6b92189c4e98b391a90e6e71a68d51a252eede2a..330fc46400daf81047e5c24c1634249e355d74b7 100644
--- a/common/extension/registry_directory.go
+++ b/common/extension/registry_directory.go
@@ -27,12 +27,12 @@ type registryDirectory func(url *common.URL, registry registry.Registry) (cluste
var defaultRegistry registryDirectory
-// SetDefaultRegistryDirectory ...
+// SetDefaultRegistryDirectory sets the default registryDirectory
func SetDefaultRegistryDirectory(v registryDirectory) {
defaultRegistry = v
}
-// GetDefaultRegistryDirectory ...
+// GetDefaultRegistryDirectory finds the registryDirectory with url and registry
func GetDefaultRegistryDirectory(config *common.URL, registry registry.Registry) (cluster.Directory, error) {
if defaultRegistry == nil {
panic("registry directory is not existing, make sure you have import the package.")
diff --git a/common/extension/rest_client.go b/common/extension/rest_client.go
index 514d1fdfd2efb5c291fdb47df4dd69da26fa90b1..9caf8c67df76bb160d5e2c3100f83e2d198b6381 100644
--- a/common/extension/rest_client.go
+++ b/common/extension/rest_client.go
@@ -25,10 +25,12 @@ var (
restClients = make(map[string]func(restOptions *client.RestOptions) client.RestClient, 8)
)
+// SetRestClient sets the RestClient with @name
func SetRestClient(name string, fun func(restOptions *client.RestOptions) client.RestClient) {
restClients[name] = fun
}
+// GetNewRestClient finds the RestClient with @name
func GetNewRestClient(name string, restOptions *client.RestOptions) client.RestClient {
if restClients[name] == nil {
panic("restClient for " + name + " is not existing, make sure you have import the package.")
diff --git a/common/extension/rest_server.go b/common/extension/rest_server.go
index fa8d435a5c976a4c95b036810fa2916a327a73b9..37a231a57c861ae49aab244eb9fa8b611ae63f6d 100644
--- a/common/extension/rest_server.go
+++ b/common/extension/rest_server.go
@@ -25,10 +25,12 @@ var (
restServers = make(map[string]func() server.RestServer, 8)
)
+// SetRestServer sets the RestServer with @name
func SetRestServer(name string, fun func() server.RestServer) {
restServers[name] = fun
}
+// GetNewRestServer finds the RestServer with @name
func GetNewRestServer(name string) server.RestServer {
if restServers[name] == nil {
panic("restServer for " + name + " is not existing, make sure you have import the package.")
diff --git a/common/extension/router_factory.go b/common/extension/router_factory.go
index 1339228618def41ccebc8d54cdebb5a623e605fa..21a49d2681b500bf4e4942d1b92e5b23bc7cf6b7 100644
--- a/common/extension/router_factory.go
+++ b/common/extension/router_factory.go
@@ -31,12 +31,12 @@ var (
fileRouterFactories = make(map[string]router.FileRouterFactory)
)
-// SetRouterFactory Set create router factory function by name
+// SetRouterFactory sets create router factory function with @name
func SetRouterFactory(name string, fun func() router.RouterFactory) {
routers[name] = fun
}
-// GetRouterFactory Get create router factory function by name
+// GetRouterFactory gets create router factory function by @name
func GetRouterFactory(name string) router.RouterFactory {
if routers[name] == nil {
panic("router_factory for " + name + " is not existing, make sure you have import the package.")
@@ -44,12 +44,12 @@ func GetRouterFactory(name string) router.RouterFactory {
return routers[name]()
}
-// GetRouterFactories Get all create router factory function
+// GetRouterFactories gets all create router factory function
func GetRouterFactories() map[string]func() router.RouterFactory {
return routers
}
-// GetFileRouterFactories Get all create file router factory instance
+// GetFileRouterFactories gets all create file router factory instance
func GetFileRouterFactories() map[string]router.FileRouterFactory {
l := len(routers)
if l == 0 {
diff --git a/common/extension/service_discovery.go b/common/extension/service_discovery.go
index 25b80cf3353505c058bea40cc4c80712ad923d2d..d70b032306f567fca5b9b57213f29bde3e7a937b 100644
--- a/common/extension/service_discovery.go
+++ b/common/extension/service_discovery.go
@@ -29,7 +29,7 @@ var (
discoveryCreatorMap = make(map[string]func(url *common.URL) (registry.ServiceDiscovery, error), 4)
)
-// SetServiceDiscovery will store the creator and name
+// SetServiceDiscovery will store the @creator and @name
func SetServiceDiscovery(name string, creator func(url *common.URL) (registry.ServiceDiscovery, error)) {
discoveryCreatorMap[name] = creator
}
diff --git a/common/extension/tps_limit.go b/common/extension/tps_limit.go
index c72c2b030fc0f391362189bfe18a65582543693a..d25821deee626cb75c94af2257f877c9983023de 100644
--- a/common/extension/tps_limit.go
+++ b/common/extension/tps_limit.go
@@ -26,12 +26,12 @@ var (
tpsLimiter = make(map[string]func() filter.TpsLimiter)
)
-// SetTpsLimiter ...
+// SetTpsLimiter sets the TpsLimiter with @name
func SetTpsLimiter(name string, creator func() filter.TpsLimiter) {
tpsLimiter[name] = creator
}
-// GetTpsLimiter ...
+// GetTpsLimiter finds the TpsLimiter with @name
func GetTpsLimiter(name string) filter.TpsLimiter {
creator, ok := tpsLimiter[name]
if !ok {
@@ -41,12 +41,12 @@ func GetTpsLimiter(name string) filter.TpsLimiter {
return creator()
}
-// SetTpsLimitStrategy ...
+// SetTpsLimitStrategy sets the TpsLimitStrategyCreator with @name
func SetTpsLimitStrategy(name string, creator filter.TpsLimitStrategyCreator) {
tpsLimitStrategy[name] = creator
}
-// GetTpsLimitStrategyCreator ...
+// GetTpsLimitStrategyCreator finds the TpsLimitStrategyCreator with @name
func GetTpsLimitStrategyCreator(name string) filter.TpsLimitStrategyCreator {
creator, ok := tpsLimitStrategy[name]
if !ok {
diff --git a/common/logger/logger.go b/common/logger/logger.go
index 016afe69808f2007541c617f406db64beb511f1c..9bc6a461003d086e8951ebac3d6997774ac69b90 100644
--- a/common/logger/logger.go
+++ b/common/logger/logger.go
@@ -40,13 +40,13 @@ var (
logger Logger
)
-// DubboLogger ...
+// nolint
type DubboLogger struct {
Logger
dynamicLevel zap.AtomicLevel
}
-// Logger ...
+// Logger is the interface for Logger types
type Logger interface {
Info(args ...interface{})
Warn(args ...interface{})
@@ -67,7 +67,7 @@ func init() {
}
}
-// InitLog ...
+// InitLog use for init logger by call InitLogger
func InitLog(logConfFile string) error {
if logConfFile == "" {
InitLogger(nil)
@@ -96,7 +96,7 @@ func InitLog(logConfFile string) error {
return nil
}
-// InitLogger ...
+// InitLogger use for init logger by @conf
func InitLogger(conf *zap.Config) {
var zapLoggerConfig zap.Config
if conf == nil {
@@ -125,18 +125,18 @@ func InitLogger(conf *zap.Config) {
getty.SetLogger(logger)
}
-// SetLogger ...
+// SetLogger sets logger for dubbo and getty
func SetLogger(log Logger) {
logger = log
getty.SetLogger(logger)
}
-// GetLogger ...
+// GetLogger gets the logger
func GetLogger() Logger {
return logger
}
-// SetLoggerLevel ...
+// SetLoggerLevel use for set logger level
func SetLoggerLevel(level string) bool {
if l, ok := logger.(OpsLogger); ok {
l.SetLoggerLevel(level)
@@ -145,13 +145,13 @@ func SetLoggerLevel(level string) bool {
return false
}
-// OpsLogger ...
+// OpsLogger use for the SetLoggerLevel
type OpsLogger interface {
Logger
SetLoggerLevel(level string)
}
-// SetLoggerLevel ...
+// SetLoggerLevel use for set logger level
func (dl *DubboLogger) SetLoggerLevel(level string) {
l := new(zapcore.Level)
l.Set(level)
diff --git a/common/logger/logging.go b/common/logger/logging.go
index 36d48ee61e8a4a986abfbaa79f3d361cd81494f4..7a31ece203815287384ade282b2a4f12e11abc2a 100644
--- a/common/logger/logging.go
+++ b/common/logger/logging.go
@@ -17,42 +17,42 @@
package logger
-// Info ...
+// Info is info level
func Info(args ...interface{}) {
logger.Info(args...)
}
-// Warn ...
+// Warn is warning level
func Warn(args ...interface{}) {
logger.Warn(args...)
}
-// Error ...
+// Error is error level
func Error(args ...interface{}) {
logger.Error(args...)
}
-// Debug ...
+// Debug is debug level
func Debug(args ...interface{}) {
logger.Debug(args...)
}
-// Infof ...
+// Infof is format info level
func Infof(fmt string, args ...interface{}) {
logger.Infof(fmt, args...)
}
-// Warnf ...
+// Warnf is format warning level
func Warnf(fmt string, args ...interface{}) {
logger.Warnf(fmt, args...)
}
-// Errorf ...
+// Errorf is format error level
func Errorf(fmt string, args ...interface{}) {
logger.Errorf(fmt, args...)
}
-// Debugf ...
+// Debugf is format debug level
func Debugf(fmt string, args ...interface{}) {
logger.Debugf(fmt, args...)
}
diff --git a/common/node.go b/common/node.go
index 979eee31ef3a63eb21af6c9045aee7f6d784f2ba..4febd78536126c67bdc65fc09d4be47fb869ef5e 100644
--- a/common/node.go
+++ b/common/node.go
@@ -17,7 +17,7 @@
package common
-// Node ...
+// Node use for process dubbo node
type Node interface {
GetUrl() URL
IsAvailable() bool
diff --git a/common/proxy/proxy.go b/common/proxy/proxy.go
index a77d26d1103e605f5d0b38ac14c8bb3e20fc27b8..abcf87cd9d297769bf8aff6fa07d6a4659091eb6 100644
--- a/common/proxy/proxy.go
+++ b/common/proxy/proxy.go
@@ -31,7 +31,7 @@ import (
invocation_impl "github.com/apache/dubbo-go/protocol/invocation"
)
-// Proxy struct
+// nolint
type Proxy struct {
rpc common.RPCService
invoke protocol.Invoker
@@ -205,12 +205,12 @@ func (p *Proxy) Implement(v common.RPCService) {
}
-// Get get rpc service instance.
+// Get gets rpc service instance.
func (p *Proxy) Get() common.RPCService {
return p.rpc
}
-// GetCallback get callback.
+// GetCallback gets callback.
func (p *Proxy) GetCallback() interface{} {
return p.callBack
}
diff --git a/common/proxy/proxy_factory.go b/common/proxy/proxy_factory.go
index 34fa3fd07eacae95351f302158d7da68165ea5cf..117428cb253e1ad4a4ceee59aa620d7097b41a75 100644
--- a/common/proxy/proxy_factory.go
+++ b/common/proxy/proxy_factory.go
@@ -29,5 +29,5 @@ type ProxyFactory interface {
GetInvoker(url common.URL) protocol.Invoker
}
-// Option ...
+// Option will define a function of handling ProxyFactory
type Option func(ProxyFactory)
diff --git a/common/proxy/proxy_factory/default.go b/common/proxy/proxy_factory/default.go
index 013b39911054ef5bd89d38cd50116a204b117872..1bb1e29c5ced78ad9e2e2483b73379c66328050a 100644
--- a/common/proxy/proxy_factory/default.go
+++ b/common/proxy/proxy_factory/default.go
@@ -40,7 +40,7 @@ func init() {
extension.SetProxyFactory("default", NewDefaultProxyFactory)
}
-// DefaultProxyFactory ...
+// DefaultProxyFactory is the default proxy factory
type DefaultProxyFactory struct {
//delegate ProxyFactory
}
@@ -53,17 +53,17 @@ type DefaultProxyFactory struct {
// }
//}
-// NewDefaultProxyFactory ...
+// NewDefaultProxyFactory returns a proxy factory instance
func NewDefaultProxyFactory(options ...proxy.Option) proxy.ProxyFactory {
return &DefaultProxyFactory{}
}
-// GetProxy ...
+// GetProxy gets a proxy
func (factory *DefaultProxyFactory) GetProxy(invoker protocol.Invoker, url *common.URL) *proxy.Proxy {
return factory.GetAsyncProxy(invoker, nil, url)
}
-// GetAsyncProxy ...
+// GetAsyncProxy gets a async proxy
func (factory *DefaultProxyFactory) GetAsyncProxy(invoker protocol.Invoker, callBack interface{}, url *common.URL) *proxy.Proxy {
//create proxy
attachments := map[string]string{}
@@ -71,19 +71,19 @@ func (factory *DefaultProxyFactory) GetAsyncProxy(invoker protocol.Invoker, call
return proxy.NewProxy(invoker, callBack, attachments)
}
-// GetInvoker ...
+// GetInvoker gets a invoker
func (factory *DefaultProxyFactory) GetInvoker(url common.URL) protocol.Invoker {
return &ProxyInvoker{
BaseInvoker: *protocol.NewBaseInvoker(url),
}
}
-// ProxyInvoker ...
+// ProxyInvoker is a invoker struct
type ProxyInvoker struct {
protocol.BaseInvoker
}
-// Invoke ...
+// Invoke is used to call service method by invocation
func (pi *ProxyInvoker) Invoke(ctx context.Context, invocation protocol.Invocation) protocol.Result {
result := &protocol.RPCResult{}
result.SetAttachments(invocation.Attachments())
diff --git a/common/rpc_service.go b/common/rpc_service.go
index d7d900718e911fe12915225c04338d52e5f084f5..211e4eae9c395bbeb0e2a46f2d3f8c7d460c3f40 100644
--- a/common/rpc_service.go
+++ b/common/rpc_service.go
@@ -35,23 +35,23 @@ import (
)
// RPCService
-//rpc service interface
+// rpc service interface
type RPCService interface {
// Reference:
// rpc service id or reference id
Reference() string
}
-//AsyncCallbackService callback interface for async
+// AsyncCallbackService callback interface for async
type AsyncCallbackService interface {
// Callback: callback
CallBack(response CallbackResponse)
}
-//CallbackResponse for different protocol
+// CallbackResponse for different protocol
type CallbackResponse interface{}
-//AsyncCallback async callback method
+// AsyncCallback async callback method
type AsyncCallback func(response CallbackResponse)
// for lowercase func
@@ -87,27 +87,27 @@ type MethodType struct {
replyType reflect.Type // return value, otherwise it is nil
}
-// Method get @m.method.
+// Method gets @m.method.
func (m *MethodType) Method() reflect.Method {
return m.method
}
-// CtxType get @m.ctxType.
+// CtxType gets @m.ctxType.
func (m *MethodType) CtxType() reflect.Type {
return m.ctxType
}
-// ArgsType get @m.argsType.
+// ArgsType gets @m.argsType.
func (m *MethodType) ArgsType() []reflect.Type {
return m.argsType
}
-// ReplyType get @m.replyType.
+// ReplyType gets @m.replyType.
func (m *MethodType) ReplyType() reflect.Type {
return m.replyType
}
-// SuiteContext tranfer @ctx to reflect.Value type or get it from @m.ctxType.
+// SuiteContext tranfers @ctx to reflect.Value type or get it from @m.ctxType.
func (m *MethodType) SuiteContext(ctx context.Context) reflect.Value {
if contextv := reflect.ValueOf(ctx); contextv.IsValid() {
return contextv
@@ -127,17 +127,17 @@ type Service struct {
methods map[string]*MethodType
}
-// Method get @s.methods.
+// Method gets @s.methods.
func (s *Service) Method() map[string]*MethodType {
return s.methods
}
-// RcvrType get @s.rcvrType.
+// RcvrType gets @s.rcvrType.
func (s *Service) RcvrType() reflect.Type {
return s.rcvrType
}
-// Rcvr get @s.rcvr.
+// Rcvr gets @s.rcvr.
func (s *Service) Rcvr() reflect.Value {
return s.rcvr
}
@@ -152,7 +152,7 @@ type serviceMap struct {
interfaceMap map[string][]*Service // interface -> service
}
-// GetService get a service defination by protocol and name
+// GetService gets a service defination by protocol and name
func (sm *serviceMap) GetService(protocol, name string) *Service {
sm.mutex.RLock()
defer sm.mutex.RUnlock()
@@ -165,7 +165,7 @@ func (sm *serviceMap) GetService(protocol, name string) *Service {
return nil
}
-// GetInterface get an interface defination by interface name
+// GetInterface gets an interface defination by interface name
func (sm *serviceMap) GetInterface(interfaceName string) []*Service {
sm.mutex.RLock()
defer sm.mutex.RUnlock()
@@ -175,7 +175,7 @@ func (sm *serviceMap) GetInterface(interfaceName string) []*Service {
return nil
}
-// Register register a service by @interfaceName and @protocol
+// Register registers a service by @interfaceName and @protocol
func (sm *serviceMap) Register(interfaceName, protocol string, rcvr RPCService) (string, error) {
if sm.serviceMap[protocol] == nil {
sm.serviceMap[protocol] = make(map[string]*Service)
@@ -223,7 +223,7 @@ func (sm *serviceMap) Register(interfaceName, protocol string, rcvr RPCService)
return strings.TrimSuffix(methods, ","), nil
}
-// UnRegister cancel a service by @interfaceName, @protocol and @serviceId
+// UnRegister cancels a service by @interfaceName, @protocol and @serviceId
func (sm *serviceMap) UnRegister(interfaceName, protocol, serviceId string) error {
if protocol == "" || serviceId == "" {
return perrors.New("protocol or serviceName is nil")
diff --git a/common/url.go b/common/url.go
index f727f20b681fba70086a38cdebcd7d2c4bef185b..1cfa47ae28451a6ab6c00029247ba7179b43371a 100644
--- a/common/url.go
+++ b/common/url.go
@@ -44,31 +44,31 @@ import (
// role constant
const (
- // CONSUMER ...
+ // CONSUMER is consumer role
CONSUMER = iota
- // CONFIGURATOR ...
+ // CONFIGURATOR is configurator role
CONFIGURATOR
- // ROUTER ...
+ // ROUTER is router role
ROUTER
- // PROVIDER ...
+ // PROVIDER is provider role
PROVIDER
)
var (
- // DubboNodes ...
+ // DubboNodes Dubbo service node
DubboNodes = [...]string{"consumers", "configurators", "routers", "providers"}
// DubboRole Dubbo service role
DubboRole = [...]string{"consumer", "", "routers", "provider"}
)
-// RoleType ...
+// nolint
type RoleType int
func (t RoleType) String() string {
return DubboNodes[t]
}
-// Role ...
+// Role returns role by @RoleType
func (t RoleType) Role() string {
return DubboRole[t]
}
@@ -97,79 +97,81 @@ type URL struct {
SubURL *URL
}
+// Option accepts url
+// Option will define a function of handling URL
type option func(*URL)
-// WithUsername ...
+// WithUsername sets username for url
func WithUsername(username string) option {
return func(url *URL) {
url.Username = username
}
}
-// WithPassword ...
+// WithPassword sets password for url
func WithPassword(pwd string) option {
return func(url *URL) {
url.Password = pwd
}
}
-// WithMethods ...
+// WithMethods sets methods for url
func WithMethods(methods []string) option {
return func(url *URL) {
url.Methods = methods
}
}
-// WithParams ...
+// WithParams sets params for url
func WithParams(params url.Values) option {
return func(url *URL) {
url.params = params
}
}
-// WithParamsValue ...
+// WithParamsValue sets params field for url
func WithParamsValue(key, val string) option {
return func(url *URL) {
url.SetParam(key, val)
}
}
-// WithProtocol ...
+// WithProtocol sets protocol for url
func WithProtocol(proto string) option {
return func(url *URL) {
url.Protocol = proto
}
}
-// WithIp ...
+// WithIp sets ip for url
func WithIp(ip string) option {
return func(url *URL) {
url.Ip = ip
}
}
-// WithPort ...
+// WithPort sets port for url
func WithPort(port string) option {
return func(url *URL) {
url.Port = port
}
}
-// WithPath ...
+// WithPath sets path for url
func WithPath(path string) option {
return func(url *URL) {
url.Path = "/" + strings.TrimPrefix(path, "/")
}
}
-// WithLocation ...
+// WithLocation sets location for url
func WithLocation(location string) option {
return func(url *URL) {
url.Location = location
}
}
-// WithToken ...
+// WithToken sets token for url
func WithToken(token string) option {
return func(url *URL) {
if len(token) > 0 {
@@ -182,7 +184,7 @@ func WithToken(token string) option {
}
}
-// NewURLWithOptions ...
+// NewURLWithOptions will create a new url with options
func NewURLWithOptions(opts ...option) *URL {
url := &URL{}
for _, opt := range opts {
@@ -306,7 +308,7 @@ func (c URL) String() string {
return buf.String()
}
-// Key ...
+// Key gets key
func (c URL) Key() string {
buildString := fmt.Sprintf(
"%s://%s:%s@%s:%s/?interface=%s&group=%s&version=%s",
@@ -314,7 +316,7 @@ func (c URL) Key() string {
return buildString
}
-// ServiceKey get a unique key of a service.
+// ServiceKey gets a unique key of a service.
func (c URL) ServiceKey() string {
intf := c.GetParam(constant.INTERFACE_KEY, strings.TrimPrefix(c.Path, "/"))
if intf == "" {
@@ -360,13 +362,13 @@ func (c *URL) ColonSeparatedKey() string {
return buf.String()
}
-// EncodedServiceKey ...
+// EncodedServiceKey encode the service key
func (c *URL) EncodedServiceKey() string {
serviceKey := c.ServiceKey()
return strings.Replace(serviceKey, "/", "*", 1)
}
-// Service ...
+// Service gets service
func (c URL) Service() string {
service := c.GetParam(constant.INTERFACE_KEY, strings.TrimPrefix(c.Path, "/"))
if service != "" {
@@ -405,7 +407,7 @@ func (c *URL) RangeParams(f func(key, value string) bool) {
}
}
-// GetParam ...
+// GetParam gets value by key
func (c URL) GetParam(s string, d string) string {
r := c.params.Get(s)
if len(r) == 0 {
@@ -414,19 +416,19 @@ func (c URL) GetParam(s string, d string) string {
return r
}
-// GetParams ...
+// GetParams gets values
func (c URL) GetParams() url.Values {
return c.params
}
-// GetParamAndDecoded ...
+// GetParamAndDecoded gets values and decode
func (c URL) GetParamAndDecoded(key string) (string, error) {
ruleDec, err := base64.URLEncoding.DecodeString(c.GetParam(key, ""))
value := string(ruleDec)
return value, err
}
-// GetRawParam ...
+// GetRawParam gets raw param
func (c URL) GetRawParam(key string) string {
switch key {
case "protocol":
@@ -446,25 +448,25 @@ func (c URL) GetRawParam(key string) string {
}
}
-// GetParamBool ...
-func (c URL) GetParamBool(s string, d bool) bool {
- r, err := strconv.ParseBool(c.GetParam(s, ""))
+// GetParamBool judge whether @key exists or not
+func (c URL) GetParamBool(key string, d bool) bool {
+ r, err := strconv.ParseBool(c.GetParam(key, ""))
if err != nil {
return d
}
return r
}
-// GetParamInt ...
-func (c URL) GetParamInt(s string, d int64) int64 {
- r, err := strconv.Atoi(c.GetParam(s, ""))
+// GetParamInt gets int value by @key
+func (c URL) GetParamInt(key string, d int64) int64 {
+ r, err := strconv.Atoi(c.GetParam(key, ""))
if r == 0 || err != nil {
return d
}
return int64(r)
}
-// GetMethodParamInt ...
+// GetMethodParamInt gets int method param
func (c URL) GetMethodParamInt(method string, key string, d int64) int64 {
r, err := strconv.Atoi(c.GetParam("methods."+method+"."+key, ""))
if r == 0 || err != nil {
@@ -473,7 +475,7 @@ func (c URL) GetMethodParamInt(method string, key string, d int64) int64 {
return int64(r)
}
-// GetMethodParamInt64 ...
+// GetMethodParamInt64 gets int64 method param
func (c URL) GetMethodParamInt64(method string, key string, d int64) int64 {
r := c.GetMethodParamInt(method, key, math.MinInt64)
if r == math.MinInt64 {
@@ -482,7 +484,7 @@ func (c URL) GetMethodParamInt64(method string, key string, d int64) int64 {
return r
}
-// GetMethodParam ...
+// GetMethodParam gets method param
func (c URL) GetMethodParam(method string, key string, d string) string {
r := c.GetParam("methods."+method+"."+key, "")
if r == "" {
@@ -491,7 +493,7 @@ func (c URL) GetMethodParam(method string, key string, d string) string {
return r
}
-// GetMethodParamBool ...
+// GetMethodParamBool judge whether @method param exists or not
func (c URL) GetMethodParamBool(method string, key string, d bool) bool {
r := c.GetParamBool("methods."+method+"."+key, d)
return r
@@ -612,7 +614,7 @@ func (c *URL) CloneExceptParams(excludeParams *gxset.HashSet) *URL {
return newUrl
}
-// Copy url based on the reserved parameters' keys.
+// Copy url based on the reserved parameter's keys.
func (c *URL) CloneWithParams(reserveParams []string) *URL {
params := url.Values{}
for _, reserveParam := range reserveParams {
diff --git a/common/yaml/yaml.go b/common/yaml/yaml.go
index 93ebb166144510236aff27a67422a6377ccb5c9f..5edda1b3c7751e8171528d121148b6c3c60fe128 100644
--- a/common/yaml/yaml.go
+++ b/common/yaml/yaml.go
@@ -40,7 +40,7 @@ func LoadYMLConfig(confProFile string) ([]byte, error) {
return ioutil.ReadFile(confProFile)
}
-// unmarshalYMLConfig Load yml config byte from file , then unmarshal to object
+// unmarshalYMLConfig Load yml config byte from file, then unmarshal to object
func UnmarshalYMLConfig(confProFile string, out interface{}) ([]byte, error) {
confFileStream, err := LoadYMLConfig(confProFile)
if err != nil {