opensource/grpc-go
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

polish the comments of Notify() and Get().

Browse Source
This commit is contained in:
iamqizhao
2016-05-26 15:34:18 -07:00
parent fca009f66f
commit 7acc9989fd
1 changed files with 10 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
balancer.go
View File

@ -85,9 +85,7 @@ type Balancer interface {
// iii) If it returns an address on which the connection does not exist, gRPC // iii) If it returns an address on which the connection does not exist, gRPC
// internals treats it as an error and will fail the corresponding RPC. // internals treats it as an error and will fail the corresponding RPC.
// //
// Therefore, we recommend the following general rule when you write your own // Therefore, the following is the recommended rule when writing a custom Balancer.
// custom Balancer.
//
// If opts.BlockingWait is true, it should return a connected address or // If opts.BlockingWait is true, it should return a connected address or
// block if there is no connected address. It should respect the timeout or // block if there is no connected address. It should respect the timeout or
// cancellation of ctx when blocking. If opts.BlockingWait is false (for fail-fast // cancellation of ctx when blocking. If opts.BlockingWait is false (for fail-fast
@ -97,14 +95,15 @@ type Balancer interface {
// The function returns put which is called once the rpc has completed or failed. // The function returns put which is called once the rpc has completed or failed.
// put can collect and report RPC stats to a remote load balancer. // put can collect and report RPC stats to a remote load balancer.
Get(ctx context.Context, opts BalancerGetOptions) (addr Address, put func(), err error) Get(ctx context.Context, opts BalancerGetOptions) (addr Address, put func(), err error)
// Notify notifies gRPC internals the list of Address to be connected. The list // Notify returns a channel that is used by gRPC internals to watch the addresses
// may be from a name resolver or remote load balancer. gRPC internals will // gRPC needs to connect. The addresses might be from a name resolver or remote
// compare it with the existing connected addresses. If the address Balancer // load balancer. gRPC internals will compare it with the existing connected
// notified is not in the existing connected addresses, gRPC starts to connect // addresses. If the address Balancer notified is not in the existing connected
// the address. If an address in the existing connected addresses is not in // addresses, gRPC starts to connect the address. If an address in the existing
// the notification list, the corresponding connection is shutdown gracefully. // connected addresses is not in the notification list, the corresponding connection
// Otherwise, there are no operations to take. Note that this function must // is shutdown gracefully. Otherwise, there are no operations to take. Note that
// return the full list of the Addresses which should be connected. It is NOT delta. // the Address slice must be the full list of the Addresses which should be connected.
// It is NOT delta.
Notify() <-chan []Address Notify() <-chan []Address
// Close shuts down the balancer. // Close shuts down the balancer.
Close() error Close() error