Skip to content

Commit 827f617

Browse files
committed
Add comment to BlockingDial
1 parent 76cc595 commit 827f617

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

grpcurl.go

+2
Original file line numberDiff line numberDiff line change
@@ -609,6 +609,8 @@ func ServerTransportCredentials(cacertFile, serverCertFile, serverKeyFile string
609609
// BlockingDial is a helper method to dial the given address, using optional TLS credentials,
610610
// and blocking until the returned connection is ready. If the given credentials are nil, the
611611
// connection will be insecure (plain-text).
612+
// The network parameter should be left empty in most cases when your address is a RFC 3986
613+
// compliant URI. The resolver from grpc-go will resolve the correct network type.
612614
func BlockingDial(ctx context.Context, network, address string, creds credentials.TransportCredentials, opts ...grpc.DialOption) (*grpc.ClientConn, error) {
613615
if creds == nil {
614616
creds = insecure.NewCredentials()

0 commit comments

Comments
 (0)