package connectivity

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

Dependency Relation
	imports 2 packages, and imported by 6 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.
		All APIs in this package are experimental.
Package-Level Type Names (total 2, both are exported)

	/* sort exporteds by: alphabet | popularity */
	 type Reporter (interface)
		Reporter reports the connectivity states.

		Methods (total 2, both are exported)
			( T) CurrentState() State
				CurrentState returns the current state of the reporter.

			( T) WaitForStateChange(context.Context, State) bool
				WaitForStateChange blocks until the reporter's state is different from the given state,
				and returns true.
				It returns false if <-ctx.Done() can proceed (ctx got timeout or got canceled).


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

		Methods (only one, which is exported)
			( T) String() string
		Implements (at least 4, in which 2 are exported)
			 T : expvar.Var
			 T : fmt.Stringer
			/* 2+ unexporteds ... *//* 2+ unexporteds: */
			 T : context.stringer
			 T : runtime.stringer
		As Outputs Of (at least 3, all are exported)
			func Reporter.CurrentState() State
			func google.golang.org/grpc.(*ClientConn).GetState() State
			func google.golang.org/grpc/balancer.(*ConnectivityStateEvaluator).RecordTransition(oldState, newState State) State
		As Inputs Of (at least 4, in which 3 are exported)
			func Reporter.WaitForStateChange(context.Context, State) bool
			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
			/* at least one unexported ... *//* at least one unexported: */
			func google.golang.org/grpc.(*ClientConn).handleSubConnStateChange(sc balancer.SubConn, s State, err error)
		As Types Of (total 5, all are exported)
			const Connecting
			const Idle
			const Ready
			const Shutdown
			const TransientFailure


Package-Level Variables (only one, which is unexported)

	/* one unexported ... *//* one unexported: */
	  var logger grpclog.DepthLoggerV2
Package-Level Constants (total 5, all are exported)

	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 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.3.2-preview. (GOOS=darwin 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 @Go100and1 (reachable from the left QR code) to get the latest news of Golds.