Skip to content

Commit

Permalink
Add more details in ClientConn GoDoc. (#3096)
Browse files Browse the repository at this point in the history
The newly added lines are mostly stolen from existing Java and C-core
documentation.
  • Loading branch information
easwars committed Oct 15, 2019
1 parent d5ab743 commit 7c8e603
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion clientconn.go
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

0 comments on commit 7c8e603

Please sign in to comment.