From 827f6178ceed9614d8f3a18ceef4adbd47c318f8 Mon Sep 17 00:00:00 2001 From: zhyuri <4649294+zhyuri@users.noreply.github.com> Date: Thu, 19 Dec 2024 20:55:59 -0500 Subject: [PATCH] Add comment to BlockingDial --- grpcurl.go | 2 ++ 1 file changed, 2 insertions(+) diff --git a/grpcurl.go b/grpcurl.go index 7cdd7ae..91f23d2 100644 --- a/grpcurl.go +++ b/grpcurl.go @@ -609,6 +609,8 @@ func ServerTransportCredentials(cacertFile, serverCertFile, serverKeyFile string // BlockingDial is a helper method to dial the given address, using optional TLS credentials, // and blocking until the returned connection is ready. If the given credentials are nil, the // connection will be insecure (plain-text). +// The network parameter should be left empty in most cases when your address is a RFC 3986 +// compliant URI. The resolver from grpc-go will resolve the correct network type. func BlockingDial(ctx context.Context, network, address string, creds credentials.TransportCredentials, opts ...grpc.DialOption) (*grpc.ClientConn, error) { if creds == nil { creds = insecure.NewCredentials()