Clarify dial vs connection timeout

Signed-off-by: Sam Batschelet <[email protected]>
ava-labs · Oct 2, 2023 · 15d0a83 · 15d0a83
1 parent a2718e9
commit 15d0a83
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 5 deletions.
diff --git a/vms/rpcchainvm/factory.go b/vms/rpcchainvm/factory.go
@@ -70,7 +70,7 @@ func (f *factory) New(log logging.Logger) (interface{}, error) {
 	// any error after the dial timeout.
 	failFastConn, err := grpcutils.Dial(
 		status.Addr,
-		grpcutils.WithConnectTimeout(grpcutils.FailFastDialTimeout),
+		grpcutils.WithConnectTimeout(grpcutils.FailFastConnectionTimeout),
 		grpcutils.WithWaitForReady(false),
 	)
 	if err != nil {

diff --git a/vms/rpcchainvm/grpcutils/client.go b/vms/rpcchainvm/grpcutils/client.go
@@ -15,9 +15,9 @@ import (
 )
 
 const (
-	// FailFastDialTimeout is the amount of time to wait for a connection to be
+	// FailFastConnectionTimeout is the amount of time to wait for a connection to be
 	// established before failing.
-	FailFastDialTimeout = 2 * time.Second
+	FailFastConnectionTimeout = 2 * time.Second
 	// After a duration of this time if the client doesn't see any activity it
 	// pings the server to see if the transport is still alive.
 	// If set below 10s, a minimum value of 10s will be used instead.

diff --git a/vms/rpcchainvm/vm_client.go b/vms/rpcchainvm/vm_client.go
@@ -356,7 +356,7 @@ func (vm *VMClient) Shutdown(ctx context.Context) error {
 	errs := wrappers.Errs{}
 	// Shutdown is a special case, where we don't want to wait for the
 	// connection to be "ready" and instead want to "fail fast".  The client
-	// will timeout after the grpcutils.FailFastDialTimeout if it can't
+	// will timeout after the grpcutils.FailFastConnectionTimeout if it can't
 	// establish a connection.
 	_, err := vm.failFastClient.Shutdown(ctx, &emptypb.Empty{})
 	errs.Add(err)
@@ -534,7 +534,7 @@ func (vm *VMClient) SetPreference(ctx context.Context, blkID ids.ID) error {
 func (vm *VMClient) HealthCheck(ctx context.Context) (interface{}, error) {
 	// HealthCheck is a special case, where we don't want to wait for the
 	// connection to be "ready" and instead want to "fail fast".  The client
-	// will timeout after the grpcutils.FailFastDialTimeout if it can't
+	// will timeout after the grpcutils.FailFastConnectionTimeout if it can't
 	// establish a connection.
 	health, err := vm.failFastClient.Health(ctx, &emptypb.Empty{})
 	if err != nil {