package endpointsharding

Import Path
	google.golang.org/grpc/balancer/endpointsharding (on go.dev)

Dependency Relation
	imports 8 packages, and imported by one package

Involved Source Files

	  d endpointsharding.go
		Package endpointsharding implements a load balancing policy that manages
		homogeneous child policies each owning a single endpoint.
		
		# Experimental
		
		Notice: This package is EXPERIMENTAL and may be changed or removed in a
		later release.
Package-Level Type Names (total 4)

	/* sort by: alphabet | popularity */
	 type ChildBuilderFunc (func)
		ChildBuilderFunc creates a new balancer with the ClientConn. It has the same
		type as the balancer.Builder.Build method.

		As Inputs Of (at least one exported)
			func NewBalancer(cc balancer.ClientConn, opts balancer.BuildOptions, childBuilder ChildBuilderFunc, esOpts Options) balancer.Balancer

	 type ChildState (struct)
		ChildState is the balancer state of a child along with the endpoint which
		identifies the child balancer.

		Fields (total 3)
			Balancer ExitIdler
				Balancer exposes only the ExitIdler interface of the child LB policy.
				Other methods of the child policy are called only by endpointsharding.

			Endpoint resolver.Endpoint
			State balancer.State
		As Outputs Of (at least one exported)
			func ChildStatesFromPicker(picker balancer.Picker) []ChildState

	 type ExitIdler (interface)
		ExitIdler provides access to only the ExitIdle method of the child balancer.

		Methods (only one)
			( ExitIdler) ExitIdle()
				ExitIdle instructs the LB policy to reconnect to backends / exit the
				IDLE state, if appropriate and possible.  Note that SubConns that enter
				the IDLE state will not reconnect until SubConn.Connect is called.

		Implemented By (at least 3)
			 google.golang.org/grpc/balancer.Balancer (interface)
			 google.golang.org/grpc/balancer.ExitIdler (interface)
			*google.golang.org/grpc/internal/balancer/gracefulswitch.Balancer
		Implements (at least one exported)
			 ExitIdler : google.golang.org/grpc/balancer.ExitIdler

	 type Options (struct)
		Options are the options to configure the behaviour of the
		endpointsharding balancer.

		Fields (only one)
			DisableAutoReconnect bool
				DisableAutoReconnect allows the balancer to keep child balancer in the
				IDLE state until they are explicitly triggered to exit using the
				ChildState obtained from the endpointsharding picker. When set to false,
				the endpointsharding balancer will automatically call ExitIdle on child
				connections that report IDLE.

		As Inputs Of (at least one exported)
			func NewBalancer(cc balancer.ClientConn, opts balancer.BuildOptions, childBuilder ChildBuilderFunc, esOpts Options) balancer.Balancer


Package-Level Functions (total 2)

	 func ChildStatesFromPicker(picker balancer.Picker) []ChildState
		ChildStatesFromPicker returns the state of all the children managed by the
		endpoint sharding balancer that created this picker.

	 func NewBalancer(cc balancer.ClientConn, opts balancer.BuildOptions, childBuilder ChildBuilderFunc, esOpts Options) balancer.Balancer
		NewBalancer returns a load balancing policy that manages homogeneous child
		policies each owning a single endpoint. The endpointsharding balancer
		forwards the LoadBalancingConfig in ClientConn state updates to its children.

The pages are generated with Golds v0.8.2. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @zigo_101 (reachable from the left QR code) to get the latest news of Golds.