diff --git a/cluster/cluster.go b/cluster/cluster.go index 7713a7bb902b711b2f648c768295d4ba2726bc74..7a0df4c0a24faf45d6d3d3da8651600481f782ba 100644 --- a/cluster/cluster.go +++ b/cluster/cluster.go @@ -22,7 +22,7 @@ import ( ) // Cluster -//Extension - Cluster +// Extension - Cluster type Cluster interface { Join(Directory) protocol.Invoker } diff --git a/cluster/cluster_impl/available_cluster.go b/cluster/cluster_impl/available_cluster.go index 9c40b47ea2e464c048511e8a45846ce9919b48aa..b70a97fad2de1b267ac1c6a5f0672ff445fadcc3 100644 --- a/cluster/cluster_impl/available_cluster.go +++ b/cluster/cluster_impl/available_cluster.go @@ -31,7 +31,7 @@ func init() { extension.SetCluster(available, NewAvailableCluster) } -// NewAvailableCluster returns cluster instance +// NewAvailableCluster returns a cluster instance // // Obtain available service providers func NewAvailableCluster() cluster.Cluster { diff --git a/cluster/cluster_impl/available_cluster_invoker.go b/cluster/cluster_impl/available_cluster_invoker.go index bb13805568ffbfc73ba06a42e74b67fd597c04e6..39a892379d3871565ec977aac874bb6509515ee2 100644 --- a/cluster/cluster_impl/available_cluster_invoker.go +++ b/cluster/cluster_impl/available_cluster_invoker.go @@ -35,7 +35,7 @@ type availableClusterInvoker struct { baseClusterInvoker } -// NewAvailableClusterInvoker returns cluster invoker instance +// NewAvailableClusterInvoker returns a cluster invoker instance func NewAvailableClusterInvoker(directory cluster.Directory) protocol.Invoker { return &availableClusterInvoker{ baseClusterInvoker: newBaseClusterInvoker(directory), diff --git a/cluster/cluster_impl/broadcast_cluster.go b/cluster/cluster_impl/broadcast_cluster.go index 581151f61645b63d610118b016ac87ec9c4595be..ba454af6a8553f31b72b1d30ef5f44ec7a8278d2 100644 --- a/cluster/cluster_impl/broadcast_cluster.go +++ b/cluster/cluster_impl/broadcast_cluster.go @@ -31,9 +31,9 @@ func init() { extension.SetCluster(broadcast, NewBroadcastCluster) } -// NewBroadcastCluster returns broadcast cluster instance +// NewBroadcastCluster returns a broadcast cluster instance. // -// Calling all providers broadcast, one by one call, any error is reported. +// Calling all providers' broadcast one by one. All errors will be reported. // It is usually used to notify all providers to update local resource information such as caches or logs. func NewBroadcastCluster() cluster.Cluster { return &broadcastCluster{} diff --git a/cluster/cluster_impl/failback_cluster.go b/cluster/cluster_impl/failback_cluster.go index ebad70c84b62bb277cf2e341c2c1bb4f161a774e..432e33122c2ee599bc848ca9ab1842084da5ef68 100644 --- a/cluster/cluster_impl/failback_cluster.go +++ b/cluster/cluster_impl/failback_cluster.go @@ -31,7 +31,7 @@ func init() { extension.SetCluster(failback, NewFailbackCluster) } -// NewFailbackCluster returns failback cluster instance +// NewFailbackCluster returns a failback cluster instance // // Failure automatically restored, failed to record the background request, // regular retransmission. Usually used for message notification operations. diff --git a/cluster/cluster_impl/failfast_cluster.go b/cluster/cluster_impl/failfast_cluster.go index 8d8177b7c72d013d7eae418c4263f63d7de2ef5f..ac9ec6b821c1d0333c73fae56169d5bc8256ec5b 100644 --- a/cluster/cluster_impl/failfast_cluster.go +++ b/cluster/cluster_impl/failfast_cluster.go @@ -31,7 +31,7 @@ func init() { extension.SetCluster(failfast, NewFailFastCluster) } -// NewFailFastCluster returns failfast cluster instance +// NewFailFastCluster returns a failfast cluster instance. // // Fast failure, only made a call, failure immediately error. Usually used for non-idempotent write operations, // such as adding records. diff --git a/cluster/cluster_impl/failover_cluster.go b/cluster/cluster_impl/failover_cluster.go index 6c32a8c2564fbdd3938fea1ca35ee2dd4323f955..d30a743e034dafabad87381cdaa356e7603b74d1 100644 --- a/cluster/cluster_impl/failover_cluster.go +++ b/cluster/cluster_impl/failover_cluster.go @@ -31,9 +31,9 @@ func init() { extension.SetCluster(name, NewFailoverCluster) } -// NewFailoverCluster returns failover cluster instance +// NewFailoverCluster returns a failover cluster instance // -// Failure automatically switch, when there is failure, +// Failure automatically switch, when there is a failure, // retry the other server (default). Usually used for read operations, // but retries can result in longer delays. func NewFailoverCluster() cluster.Cluster { diff --git a/cluster/cluster_impl/failsafe_cluster.go b/cluster/cluster_impl/failsafe_cluster.go index e88690f0aeea34d91fa42ce62243e9b60859e4c7..f708b7fb9108bdd17fec5dc68dc1e4249c8199d4 100644 --- a/cluster/cluster_impl/failsafe_cluster.go +++ b/cluster/cluster_impl/failsafe_cluster.go @@ -31,9 +31,10 @@ func init() { extension.SetCluster(failsafe, NewFailsafeCluster) } -// NewFailsafeCluster returns failsafe cluster instance +// NewFailsafeCluster returns a failsafe cluster instance. // -// Failure of security, anomalies, directly ignored. Usually used to write audit logs and other operations. +// Failure of security, anomalies, directly ignored. Usually it is +// used to write audit logs and other operations. func NewFailsafeCluster() cluster.Cluster { return &failsafeCluster{} } diff --git a/cluster/cluster_impl/forking_cluster.go b/cluster/cluster_impl/forking_cluster.go index 720f8d11873068d3f11bd74d2621124eaa6c3b0c..0e6cd26882788a1f897d0d4dc8e0d4eb0a9d4218 100644 --- a/cluster/cluster_impl/forking_cluster.go +++ b/cluster/cluster_impl/forking_cluster.go @@ -31,10 +31,10 @@ func init() { extension.SetCluster(forking, NewForkingCluster) } -// NewForkingCluster returns forking cluster instance +// NewForkingCluster returns a forking cluster instance. // // Multiple servers are invoked in parallel, returning as soon as one succeeds. -// Usually used for real-time demanding read operations, but need to waste more service resources. +// Usually it is used for real-time demanding read operations while wasting more service resources. func NewForkingCluster() cluster.Cluster { return &forkingCluster{} } diff --git a/cluster/cluster_impl/mock_cluster.go b/cluster/cluster_impl/mock_cluster.go index 6ad75cf1bcfd97e6def5c41f9e4ccdaa87b5c5c7..d887cfb45b9c92c859b1396046c1c1c73d46b295 100644 --- a/cluster/cluster_impl/mock_cluster.go +++ b/cluster/cluster_impl/mock_cluster.go @@ -24,11 +24,11 @@ import ( type mockCluster struct{} -// NewMockCluster returns mock cluster instance +// NewMockCluster returns a mock cluster instance. // // Mock cluster is usually used for service degradation, such as an authentication service. // When the service provider is completely hung up, the client does not throw an exception, -// but returns the authorization failure through the Mock data. +// return an authorization failure through the Mock data instead. func NewMockCluster() cluster.Cluster { return &mockCluster{} } diff --git a/cluster/cluster_impl/registry_aware_cluster.go b/cluster/cluster_impl/registry_aware_cluster.go index 58618951acbffbf93b2a86518fc5e2ed01d564b2..fcefa52862a39eece98dca8660e62d9ca144e955 100644 --- a/cluster/cluster_impl/registry_aware_cluster.go +++ b/cluster/cluster_impl/registry_aware_cluster.go @@ -29,7 +29,7 @@ func init() { extension.SetCluster("registryAware", NewRegistryAwareCluster) } -// NewRegistryAwareCluster returns registry aware cluster instance +// NewRegistryAwareCluster returns a registry aware cluster instance func NewRegistryAwareCluster() cluster.Cluster { return ®istryAwareCluster{} } diff --git a/cluster/directory.go b/cluster/directory.go index 5a03b3a4490ce0b3aadece8a9ef43395f845dd12..37f0c3282935bac430d0ae676abc72d60d711c85 100644 --- a/cluster/directory.go +++ b/cluster/directory.go @@ -23,7 +23,7 @@ import ( ) // Directory -//Extension - Directory +// Extension - Directory type Directory interface { common.Node List(invocation protocol.Invocation) []protocol.Invoker diff --git a/cluster/loadbalance.go b/cluster/loadbalance.go index fb3641a77377eabbd692729a32e2c0c096282f18..a5b344a4952d338e0f481028b3835116f1743773 100644 --- a/cluster/loadbalance.go +++ b/cluster/loadbalance.go @@ -22,7 +22,7 @@ import ( ) // LoadBalance -//Extension - LoadBalance +// Extension - LoadBalance type LoadBalance interface { Select([]protocol.Invoker, protocol.Invocation) protocol.Invoker } diff --git a/cluster/loadbalance/least_active.go b/cluster/loadbalance/least_active.go index 7eff05bd1cc617f61b654eebb9f859358b336148..37ad91c3ed6b44370820a989b7af8ccaa82c48a2 100644 --- a/cluster/loadbalance/least_active.go +++ b/cluster/loadbalance/least_active.go @@ -28,6 +28,7 @@ import ( ) const ( + // LeastActive is used to set the load balance extension LeastActive = "leastactive" ) @@ -38,9 +39,9 @@ func init() { type leastActiveLoadBalance struct { } -// NewLeastActiveLoadBalance returns least active load balance +// NewLeastActiveLoadBalance returns a least active load balance. // -// A random mechanism based on actives, actives means the num of requests a consumer have sent but not return yet +// A random mechanism based on actives, actives means the number of a consumer's requests have been sent to provider but not yet got response. func NewLeastActiveLoadBalance() cluster.LoadBalance { return &leastActiveLoadBalance{} } diff --git a/cluster/loadbalance/random.go b/cluster/loadbalance/random.go index d5a8471e80775d7b7bacdb3387038979c180bc23..cdde1b41fb8e986d9923681dc4ab075496ac810e 100644 --- a/cluster/loadbalance/random.go +++ b/cluster/loadbalance/random.go @@ -38,9 +38,9 @@ func init() { type randomLoadBalance struct { } -// NewRandomLoadBalance returns random load balance instance +// NewRandomLoadBalance returns a random load balance instance. // -// Set random probabilities by weight, the request sent to provider is random +// Set random probabilities by weight, and the request will be sent to provider randomly. func NewRandomLoadBalance() cluster.LoadBalance { return &randomLoadBalance{} } diff --git a/cluster/loadbalance/round_robin.go b/cluster/loadbalance/round_robin.go index 587e059b37d0559a0fe03fe3b1149269118827db..c44b239dbcbcc744f47ca3c97128f92567e32a78 100644 --- a/cluster/loadbalance/round_robin.go +++ b/cluster/loadbalance/round_robin.go @@ -52,7 +52,7 @@ func init() { type roundRobinLoadBalance struct{} -// NewRoundRobinLoadBalance returns round robin load balance +// NewRoundRobinLoadBalance returns a round robin load balance // // Use the weight's common advisory to determine round robin ratio func NewRoundRobinLoadBalance() cluster.LoadBalance {