package connectivity

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

Dependency Relation
	imports one package, and imported by 9 packages

Involved Source Files

	  d connectivity.go
		Package connectivity defines connectivity semantics.
		For details, see https://github.com/grpc/grpc/blob/master/doc/connectivity-semantics-and-api.md.
Package-Level Type Names (total 2)

	/* sort by: alphabet | popularity */
	 type ServingMode int (basic type)
		ServingMode indicates the current mode of operation of the server.
		
		Only xDS enabled gRPC servers currently report their serving mode.

		Methods (only one)
			( ServingMode) String() string
		Implements (at least 2)
			 ServingMode : expvar.Var
			 ServingMode : fmt.Stringer
		As Types Of (total 3)
			const ServingModeNotServing
			const ServingModeServing
			const ServingModeStarting

	 type State int (basic type)
		State indicates the state of connectivity.
		It can be the state of a ClientConn or SubConn.

		Methods (only one)
			( State) String() string
		Implements (at least 2)
			 State : expvar.Var
			 State : fmt.Stringer
		As Outputs Of (at least 3)
			func google.golang.org/grpc.(*ClientConn).GetState() State
			func google.golang.org/grpc/balancer.(*ConnectivityStateEvaluator).CurrentState() State
			func google.golang.org/grpc/balancer.(*ConnectivityStateEvaluator).RecordTransition(oldState, newState State) State
		As Inputs Of (at least 3)
			func google.golang.org/grpc.(*ClientConn).WaitForStateChange(ctx context.Context, sourceState State) bool
			func google.golang.org/grpc/balancer.(*ConnectivityStateEvaluator).RecordTransition(oldState, newState State) State
			func google.golang.org/grpc/internal/channelz.NewChannelMetricForTesting(state State, target string, started, succeeded, failed, timestamp int64) *channelz.ChannelMetrics
		As Types Of (total 5)
			const Connecting
			const Idle
			const Ready
			const Shutdown
			const TransientFailure


Package-Level Constants (total 8)

	const Connecting State = 1
		Connecting indicates the ClientConn is connecting.

	const Idle State = 0
		Idle indicates the ClientConn is idle.

	const Ready State = 2
		Ready indicates the ClientConn is ready for work.

	const ServingModeNotServing ServingMode = 2
		ServingModeNotServing indicates that the server is not accepting new
		connections. Existing connections will be closed gracefully, allowing
		in-progress RPCs to complete. A server enters this mode when it does not
		contain the required configuration to serve RPCs.

	const ServingModeServing ServingMode = 1
		ServingModeServing indicates that the server contains all required
		configuration and is serving RPCs.

	const ServingModeStarting ServingMode = 0
		ServingModeStarting indicates that the server is starting up.

	const Shutdown State = 4
		Shutdown indicates the ClientConn has started shutting down.

	const TransientFailure State = 3
		TransientFailure indicates the ClientConn has seen a failure but expects to recover.

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.