connectivity

Documentation

Overview

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.

Index

• type Reporter
• type State
  • func (s State) String() string

Types

type Reporter

type Reporter interface {
	// CurrentState returns the current state of the reporter.
	CurrentState() State
	// 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).
	WaitForStateChange(context.Context, State) bool
}

Reporter reports the connectivity states.

type State

type State int

State indicates the state of connectivity. It can be the state of a ClientConn or SubConn.

const (
	// Idle indicates the ClientConn is idle.
	Idle State = iota
	// Connecting indicates the ClienConn is connecting.
	Connecting
	// Ready indicates the ClientConn is ready for work.
	Ready
	// TransientFailure indicates the ClientConn has seen a failure but expects to recover.
	TransientFailure
	// Shutdown indicates the ClientConn has started shutting down.
	Shutdown
)

func (State) String

func (s State) String() string