grpc
/
grpc-go
mirror of https://github.com/grpc/grpc-go.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

docs: fix and improve anti-patterns.md (#7418)

This commit is contained in:
Mahé 2024-07-23 22:13:42 +02:00 committed by GitHub
parent ac5a7fe417
commit aae9e64cf3
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
Documentation/anti-patterns.md
View File

@ -30,7 +30,7 @@ to create _a_ connection which may need to be recreated if it is lost.
`grpc.Dial` uses "passthrough" as the default name resolver for backward `grpc.Dial` uses "passthrough" as the default name resolver for backward
compatibility while `grpc.NewClient` uses "dns" as its default name resolver. compatibility while `grpc.NewClient` uses "dns" as its default name resolver.
This subtle diffrence is important to legacy systems that also specified a This subtle difference is important to legacy systems that also specified a
custom dialer and expected it to receive the target string directly. custom dialer and expected it to receive the target string directly.
For these reasons, using `grpc.Dial` is discouraged. Even though it is marked For these reasons, using `grpc.Dial` is discouraged. Even though it is marked
@ -62,10 +62,10 @@ the RPC was sent to a server.
Some users of `Dial` use it as a way to validate the configuration of their Some users of `Dial` use it as a way to validate the configuration of their
system. If you wish to maintain this behavior but migrate to `NewClient`, you system. If you wish to maintain this behavior but migrate to `NewClient`, you
can call `State` and `WaitForStateChange` until the channel is connected. can call `GetState`, then `Connect` if the state is `Idle` and
However, if this fails, it does not mean that your configuration was bad - it `WaitForStateChange` until the channel is connected. However, if this fails,
could also mean the service is not reachable by the client due to connectivity it does not mean that your configuration was bad - it could also mean the
reasons. service is not reachable by the client due to connectivity reasons.
## Best practices for error handling in gRPC ## Best practices for error handling in gRPC