Publicize channel root peers

CHANGELOG.md

@@ -1,8 +1,9 @@
 Changelog
 =========
 
-# (unreleased)
+# v1.3.0 (unreleased)
 
+* Exposes the channel's RootPeerList with `channel.RootPeers()`.
 * Add OnPeerStatusChanged option to NewChannel to receive notifications when
   TChannel drops a connection and potentially other state change notifications.
   Accepts a function and sends the affected peer.  The event handler function
@@ -16,7 +17,7 @@ Changelog
   but none was found (e.g., exception is from the future). (#566)
 * Fix ListenIP selecting docker interfaces over physical networks. (#565)
 * Fix for error when a Thrift payload has completed decoding and attempts
-  to close the argument reader without waiting till EOF.  (#564)
+  to close the argument reader without waiting until EOF.  (#564)
 * thrift-gen: Fix "namespace go" being ignored even though the Apache thrift
   generated code was respecting it. (#559)
 

channel.go

@@ -370,18 +370,18 @@ func (ch *Channel) Peers() *PeerList {
 	return ch.peers
 }
 
-// rootPeers returns the root PeerList for the channel, which is the sole place
+// RootPeers returns the root PeerList for the channel, which is the sole place
 // new Peers are created. All children of the root list (including ch.Peers())
 // automatically re-use peers from the root list and create new peers in the
 // root list.
-func (ch *Channel) rootPeers() *RootPeerList {
+func (ch *Channel) RootPeers() *RootPeerList {
 	return ch.peers.parent
 }
 
 // BeginCall starts a new call to a remote peer, returning an OutboundCall that can
 // be used to write the arguments of the call.
 func (ch *Channel) BeginCall(ctx context.Context, hostPort, serviceName, methodName string, callOptions *CallOptions) (*OutboundCall, error) {
-	p := ch.rootPeers().GetOrAdd(hostPort)
+	p := ch.RootPeers().GetOrAdd(hostPort)
 	return p.BeginCall(ctx, serviceName, methodName, callOptions)
 }
 
@@ -438,7 +438,7 @@ func (ch *Channel) serve() {
 
 // Ping sends a ping message to the given hostPort and waits for a response.
 func (ch *Channel) Ping(ctx context.Context, hostPort string) error {
-	peer := ch.rootPeers().GetOrAdd(hostPort)
+	peer := ch.RootPeers().GetOrAdd(hostPort)
 	conn, err := peer.GetConnection(ctx)
 	if err != nil {
 		return err
@@ -531,7 +531,7 @@ func (ch *Channel) exchangeUpdated(c *Connection) {
 		return
 	}
 
-	p, ok := ch.rootPeers().Get(c.remotePeerInfo.HostPort)
+	p, ok := ch.RootPeers().Get(c.remotePeerInfo.HostPort)
 	if !ok {
 		return
 	}
@@ -582,7 +582,7 @@ func (ch *Channel) connectionActive(c *Connection, direction connectionDirection
 }
 
 func (ch *Channel) addConnectionToPeer(hostPort string, c *Connection, direction connectionDirection) {
-	p := ch.rootPeers().GetOrAdd(hostPort)
+	p := ch.RootPeers().GetOrAdd(hostPort)
 	if err := p.addConnection(c, direction); err != nil {
 		c.log.WithFields(
 			LogField{"remoteHostPort", c.remotePeerInfo.HostPort},
@@ -627,7 +627,7 @@ func (ch *Channel) getMinConnectionState() connectionState {
 // connectionCloseStateChange is called when a connection's close state changes.
 func (ch *Channel) connectionCloseStateChange(c *Connection) {
 	ch.removeClosedConn(c)
-	if peer, ok := ch.rootPeers().Get(c.remotePeerInfo.HostPort); ok {
+	if peer, ok := ch.RootPeers().Get(c.remotePeerInfo.HostPort); ok {
 		if ch.onPeerStatusChanged != nil {
 			ch.onPeerStatusChanged(peer)
 		}
@@ -636,7 +636,7 @@ func (ch *Channel) connectionCloseStateChange(c *Connection) {
 	}
 	if c.outboundHP != "" && c.outboundHP != c.remotePeerInfo.HostPort {
 		// Outbound connections may be in multiple peers.
-		if peer, ok := ch.rootPeers().Get(c.outboundHP); ok {
+		if peer, ok := ch.RootPeers().Get(c.outboundHP); ok {
 			peer.connectionCloseStateChange(c)
 			ch.updatePeer(peer)
 		}

introspection.go

@@ -216,7 +216,7 @@ func (ch *Channel) IntrospectState(opts *IntrospectionOptions) *RuntimeState {
 		CreatedStack:   ch.createdStack,
 		LocalPeer:      ch.PeerInfo(),
 		SubChannels:    ch.subChannels.IntrospectState(opts),
-		RootPeers:      ch.rootPeers().IntrospectState(opts),
+		RootPeers:      ch.RootPeers().IntrospectState(opts),
 		Peers:          ch.Peers().IntrospectList(opts),
 		NumConnections: numConns,
 		Connections:    connIDs,

relay.go

@@ -196,7 +196,7 @@ func NewRelayer(ch *Channel, conn *Connection) *Relayer {
 		localHandler: ch.relayLocal,
 		outbound:     newRelayItems(ch.Logger().WithFields(LogField{"relay", "outbound"})),
 		inbound:      newRelayItems(ch.Logger().WithFields(LogField{"relay", "inbound"})),
-		peers:        ch.rootPeers(),
+		peers:        ch.RootPeers(),
 		conn:         conn,
 		logger:       conn.log,
 	}

utils_for_test.go

@@ -33,11 +33,6 @@ import (
 // MexChannelBufferSize is the size of the message exchange channel buffer.
 const MexChannelBufferSize = mexChannelBufferSize
 
-// RootPeers returns the root peer list from the Channel.
-func (ch *Channel) RootPeers() *RootPeerList {
-	return ch.rootPeers()
-}
-
 // SetOnUpdate sets onUpdate for a peer, which is called when the peer's score is
 // updated in all peer lists.
 func (p *Peer) SetOnUpdate(f func(*Peer)) {