refactor: better method name

impl/impl.go

@@ -322,7 +322,7 @@ func (m *manager) CloseDataTransferChannel(ctx context.Context, chid datatransfe
 // ConnectTo opens a connection to a peer on the data-transfer protocol,
 // retrying if necessary
 func (m *manager) ConnectTo(ctx context.Context, p peer.ID) error {
-	return m.dataTransferNetwork.OpenStreamTo(ctx, p)
+	return m.dataTransferNetwork.ConnectWithRetry(ctx, p)
 }
 
 // close an open channel and fire an error event

network/interface.go

@@ -26,10 +26,10 @@ type DataTransferNetwork interface {
 	// ConnectTo establishes a connection to the given peer
 	ConnectTo(context.Context, peer.ID) error
 
-	// OpenStreamTo establishes a connection to the given peer, retrying if
+	// ConnectWithRetry establishes a connection to the given peer, retrying if
 	// necessary, and opens a stream on the data-transfer protocol to verify
 	// the peer will accept messages on the protocol
-	OpenStreamTo(ctx context.Context, p peer.ID) error
+	ConnectWithRetry(ctx context.Context, p peer.ID) error
 
 	// ID returns the peer id of this libp2p host
 	ID() peer.ID

network/libp2p_impl.go

@@ -187,15 +187,19 @@ func (dtnet *libp2pDataTransferNetwork) ConnectTo(ctx context.Context, p peer.ID
 	return dtnet.host.Connect(ctx, peer.AddrInfo{ID: p})
 }
 
-// OpenStreamTo establishes a connection to the given peer, retrying if
+// ConnectWithRetry establishes a connection to the given peer, retrying if
 // necessary, and opens a stream on the data-transfer protocol to verify
 // the peer will accept messages on the protocol
-func (dtnet *libp2pDataTransferNetwork) OpenStreamTo(ctx context.Context, p peer.ID) error {
+func (dtnet *libp2pDataTransferNetwork) ConnectWithRetry(ctx context.Context, p peer.ID) error {
+	// Open a stream over the data-transfer protocol, to make sure that the
+	// peer is listening on the protocol
 	s, err := dtnet.openStream(ctx, p, dtnet.dtProtocols...)
 	if err != nil {
 		return err
 	}
 
+	// We don't actually use the stream, we just open it to verify it's
+	// possible to connect over the data-transfer protocol, so we close it here
 	return s.Close()
 }
 

testutil/testnet.go

@@ -45,7 +45,7 @@ func (fn *FakeNetwork) ConnectTo(_ context.Context, _ peer.ID) error {
 	panic("not implemented")
 }
 
-func (fn *FakeNetwork) OpenStreamTo(ctx context.Context, p peer.ID) error {
+func (fn *FakeNetwork) ConnectWithRetry(ctx context.Context, p peer.ID) error {
 	panic("implement me")
 }