package pickfirst

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

Dependency Relation
	imports 14 packages, and imported by one package

Involved Source Files

	  d pickfirst.go
		Package pickfirst contains the pick_first load balancing policy.
Package-Level Type Names (total 6, in which 1 is exported)

	/* sort exporteds by: alphabet | popularity */
	 type Shuffler (interface)
		Shuffler is an interface for shuffling an address list.

		Methods (only one, which is exported)
			( Shuffler) ShuffleAddressListForTesting(n int, swap func(i, j int))

	/* 5 unexporteds ... *//* 5 unexporteds: */
	 type idlePicker (struct)
		idlePicker is used when the SubConn is IDLE and kicks the SubConn into
		CONNECTING when Pick is called.

		Fields (only one, which is unexported)
			/* one unexported ... *//* one unexported: */
			subConn balancer.SubConn
		Methods (only one, which is exported)
			(*idlePicker) Pick(balancer.PickInfo) (balancer.PickResult, error)
		Implements (at least one exported)
			*idlePicker : google.golang.org/grpc/balancer.Picker

	 type pfConfig (struct)

		Fields (total 2, both are exported)
			LoadBalancingConfig serviceconfig.LoadBalancingConfig
			ShuffleAddressList bool
				If set to true, instructs the LB policy to shuffle the order of the list
				of endpoints received from the name resolver before attempting to
				connect to them.

		Methods (only one, which is unexported)
			/* one unexported ... *//* one unexported: */
			( pfConfig) isLoadBalancingConfig()
		Implements (at least one exported)
			 pfConfig : google.golang.org/grpc/serviceconfig.LoadBalancingConfig

	 type picker (struct)

		Fields (total 2, neither is exported)
			/* 2 unexporteds ... *//* 2 unexporteds: */
			err error
			result balancer.PickResult
		Methods (only one, which is exported)
			(*picker) Pick(balancer.PickInfo) (balancer.PickResult, error)
		Implements (at least one exported)
			*picker : google.golang.org/grpc/balancer.Picker

	 type pickfirstBalancer (struct)

		Fields (total 4, none are exported)
			/* 4 unexporteds ... *//* 4 unexporteds: */
			cc balancer.ClientConn
			logger *internalgrpclog.PrefixLogger
			state connectivity.State
			subConn balancer.SubConn
		Methods (total 6, in which 5 are exported)
			(*pickfirstBalancer) Close()
			(*pickfirstBalancer) ExitIdle()
			(*pickfirstBalancer) ResolverError(err error)
			(*pickfirstBalancer) UpdateClientConnState(state balancer.ClientConnState) error
			(*pickfirstBalancer) UpdateSubConnState(subConn balancer.SubConn, state balancer.SubConnState)
				UpdateSubConnState is unused as a StateListener is always registered when
				creating SubConns.

			/* one unexported ... *//* one unexported: */
			(*pickfirstBalancer) updateSubConnState(subConn balancer.SubConn, state balancer.SubConnState)
		Implements (at least 3, all are exported)
			*pickfirstBalancer : google.golang.org/grpc/balancer.Balancer
			*pickfirstBalancer : google.golang.org/grpc/balancer.ExitIdler
			*pickfirstBalancer : google.golang.org/grpc/balancer/endpointsharding.ExitIdler

	 type pickfirstBuilder (struct)

		Methods (total 3, all are exported)
			( pickfirstBuilder) Build(cc balancer.ClientConn, _ balancer.BuildOptions) balancer.Balancer
			( pickfirstBuilder) Name() string
			( pickfirstBuilder) ParseConfig(js json.RawMessage) (serviceconfig.LoadBalancingConfig, error)
		Implements (at least 2, both are exported)
			 pickfirstBuilder : google.golang.org/grpc/balancer.Builder
			 pickfirstBuilder : google.golang.org/grpc/balancer.ConfigParser


Package-Level Functions (total 2, in which 1 is exported)

	 func ShuffleAddressListForTesting(n int, swap func(i, j int))
		ShuffleAddressListForTesting pseudo-randomizes the order of addresses.  n
		is the number of elements.  swap swaps the elements with indexes i and j.

	/* one unexported ... *//* one unexported: */
	 func init()
Package-Level Variables (only one, which is unexported)

	/* one unexported ... *//* one unexported: */
	  var logger grpclog.DepthLoggerV2
Package-Level Constants (total 2, in which 1 is exported)

	const Name = "pick_first"
		Name is the name of the pick_first balancer.

	/* one unexported ... *//* one unexported: */
	const logPrefix = "[pick-first-lb %p] "

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