Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add more details in ClientConn GoDoc. #3096

Merged
merged 2 commits into from Oct 15, 2019
Merged

Add more details in ClientConn GoDoc. #3096

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
630f0be
Add more details in ClientConn GoDoc.
easwars Oct 14, 2019
7651f4c
Review comments.
easwars Oct 14, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
13 changes: 12 additions & 1 deletion clientconn.go
View file
Open in desktop
Expand Up @@ -442,7 +442,18 @@ func (csm *connectivityStateManager) getNotifyChan() <-chan struct{} {
return csm.notifyChan
}

// ClientConn represents a client connection to an RPC server.
// ClientConn represents a virtual connection to a conceptual endpoint, to
// perform RPCs.
//
// A ClientConn is free to have zero or more actual connections to the endpoint
// based on configuration, load, etc. It is also free to determine which actual
// endpoints to use and may change it every RPC, permitting client-side load
// balancing.
//
// A ClientConn encapsulates a range of functionality including name
// resolution, TCP connection establishment (with retries and backoff) and TLS
// handshakes. It also handles errors on established connections by
// re-resolving the name and reconnecting.
type ClientConn struct {
ctx context.Context
cancel context.CancelFunc
Expand Down