grpcready

Documentation

Index

• func Conn(ctx context.Context, log hclog.Logger, conn *grpc.ClientConn, wait bool) error

Functions

func Conn

func Conn(
	ctx context.Context,
	log hclog.Logger,
	conn *grpc.ClientConn,
	wait bool,
) error

Conn returns nil if the connection is in the ready state. If wait is set, this will wait for the connection to become ready or until the context is cancelled.

This is useful over `WithBlock` when connecting because it allows a fail-fast first attempt to connect. This makes it easily to synchronously attempt connection once before falling back to a retry loop in the background.