package serviceconfig

Import Path
	google.golang.org/grpc/internal/serviceconfig (on go.dev)

Dependency Relation
	imports 7 packages, and imported by 2 packages

Involved Source Files

	   #d serviceconfig.go
		Package serviceconfig contains utility functions to parse service config.
Package-Level Type Names (total 4, in which 3 are exported)

	/* sort exporteds by: alphabet | popularity */
	 type BalancerConfig (struct)
		BalancerConfig wraps the name and config associated with one load balancing
		policy. It corresponds to a single entry of the loadBalancingConfig field
		from ServiceConfig.

		It implements the json.Unmarshaler interface.

		https://github.com/grpc/grpc-proto/blob/54713b1e8bc6ed2d4f25fb4dff527842150b91b2/grpc/service_config/service_config.proto#L247

		Fields (total 2, both are exported)
			Config externalserviceconfig.LoadBalancingConfig
			Name string
		Methods (total 2, both are exported)
			(*BalancerConfig) MarshalJSON() ([]byte, error)
				MarshalJSON implements the json.Marshaler interface.

				It marshals the balancer and config into a length-1 slice
				([]map[string]config).

			(*BalancerConfig) UnmarshalJSON(b []byte) error
				UnmarshalJSON implements the json.Unmarshaler interface.

				ServiceConfig contains a list of loadBalancingConfigs, each with a name and
				config. This method iterates through that list in order, and stops at the
				first policy that is supported.
				  - If the config for the first supported policy is invalid, the whole service
				    config is invalid.
				  - If the list doesn't contain any supported policy, the whole service config
				    is invalid.

		Implements (at least 2, both are exported)
			*BalancerConfig : encoding/json.Marshaler
			*BalancerConfig : encoding/json.Unmarshaler

	 type MethodConfig (struct)
		MethodConfig defines the configuration recommended by the service providers for a
		particular method.

		Fields (total 5, all are exported)
			MaxReqSize *int
				MaxReqSize is the maximum allowed payload size for an individual request in a
				stream (client->server) in bytes. The size which is measured is the serialized
				payload after per-message compression (but before stream compression) in bytes.
				The actual value used is the minimum of the value specified here and the value set
				by the application via the gRPC client API. If either one is not set, then the other
				will be used.  If neither is set, then the built-in default is used.

			MaxRespSize *int
				MaxRespSize is the maximum allowed payload size for an individual response in a
				stream (server->client) in bytes.

			RetryPolicy *RetryPolicy
				RetryPolicy configures retry options for the method.

			Timeout *time.Duration
				Timeout is the default timeout for RPCs sent to this method. The actual
				deadline used will be the minimum of the value specified here and the value
				set by the application via the gRPC client API.  If either one is not set,
				then the other will be used.  If neither is set, then the RPC has no deadline.

			WaitForReady *bool
				WaitForReady indicates whether RPCs sent to this method should wait until
				the connection is ready by default (!failfast). The value specified via the
				gRPC client API will override the value set here.

		As Outputs Of (at least 2, in which 1 are exported)
			func google.golang.org/grpc.(*ClientConn).GetMethodConfig(method string) grpc.MethodConfig
			/* at least one unexported ... *//* at least one unexported: */
			func google.golang.org/grpc.getMethodConfig(sc *grpc.ServiceConfig, method string) grpc.MethodConfig
		As Inputs Of (at least one unexported)
			/* at least one unexported ... *//* at least one unexported: */
			func google.golang.org/grpc.newClientStreamWithParams(ctx context.Context, desc *grpc.StreamDesc, cc *grpc.ClientConn, method string, mc MethodConfig, onCommit, doneFunc func(), opts ...grpc.CallOption) (_ iresolver.ClientStream, err error)

	 type RetryPolicy (struct)
		RetryPolicy defines the go-native version of the retry policy defined by the
		service config here:
		https://github.com/grpc/proposal/blob/master/A6-client-retries.md#integration-with-service-config

		Fields (total 5, all are exported)
			BackoffMultiplier float64
			InitialBackoff time.Duration
				Exponential backoff parameters. The initial retry attempt will occur at
				random(0, initialBackoff). In general, the nth attempt will occur at
				random(0,
				  min(initialBackoff*backoffMultiplier**(n-1), maxBackoff)).

				These fields are required and must be greater than zero.

			MaxAttempts int
				MaxAttempts is the maximum number of attempts, including the original RPC.

				This field is required and must be two or greater.

			MaxBackoff time.Duration
			RetryableStatusCodes map[codes.Code]bool
				The set of status codes which may be retried.

				Status codes are specified as strings, e.g., "UNAVAILABLE".

				This field is required and must be non-empty.
				Note: a set is used to store this for easy lookup.

		As Outputs Of (at least one unexported)
			/* at least one unexported ... *//* at least one unexported: */
			func google.golang.org/grpc.convertRetryPolicy(jrp *grpc.jsonRetryPolicy) (p *RetryPolicy, err error)

	/* one unexported ... *//* one unexported: */
	 type intermediateBalancerConfig ([])
Package-Level Variables (only one, which is unexported)

	/* one unexported ... *//* one unexported: */
	  var logger grpclog.DepthLoggerV2

The pages are generated with Golds v0.4.9. (GOOS=linux GOARCH=amd64)