Skip to content

Commit

Permalink
grpc: stabilize WithDefaultServiceConfig and improve godoc (#4888)
Browse files Browse the repository at this point in the history
  • Loading branch information
dfawley committed Oct 20, 2021
1 parent 3b1d3e4 commit fbf9b56
Showing 1 changed file with 8 additions and 6 deletions.
14 changes: 8 additions & 6 deletions dialoptions.go
Expand Up @@ -518,14 +518,16 @@ func WithDisableServiceConfig() DialOption {
// WithDefaultServiceConfig returns a DialOption that configures the default
// service config, which will be used in cases where:
//
// 1. WithDisableServiceConfig is also used.
// 2. Resolver does not return a service config or if the resolver returns an
// invalid service config.
// 1. WithDisableServiceConfig is also used, or
//
// Experimental
// 2. The name resolver does not provide a service config or provides an
// invalid service config.
//
// Notice: This API is EXPERIMENTAL and may be changed or removed in a
// later release.
// The parameter s is the JSON representation of the default service config.
// For more information about service configs, see:
// https://github.com/grpc/grpc/blob/master/doc/service_config.md
// For a simple example of usage, see:
// examples/features/load_balancing/client/main.go
func WithDefaultServiceConfig(s string) DialOption {
return newFuncDialOption(func(o *dialOptions) {
o.defaultServiceConfigRawJSON = &s
Expand Down

0 comments on commit fbf9b56

Please sign in to comment.