grpc_health_v1

Documentation

Index

• func StatusString(status HealthStatus) string
• type Client
  • func NewClient(svrAddr string, opts ...grpc.DialOption) (*Client, error)
  • func NewClientFromConsul(consulHost string, consulPort uint16, opts ...grpc.DialOption) (*Client, error)
  • func (e Client) Check(ctx context.Context, service string) (HealthStatus, error)
  • func (e Client) Watch(ctx context.Context, service string) (<-chan HealthStatus, error)
• type HealthStatus
• type Service

Functions

func StatusString

func StatusString(status HealthStatus) string

Types

type Client

type Client struct {
	*grpc.ClientConn
	// contains filtered or unexported fields
}

func NewClient

func NewClient(svrAddr string, opts ...grpc.DialOption) (*Client, error)

func NewClientFromConsul

func NewClientFromConsul(consulHost string, consulPort uint16, opts ...grpc.DialOption) (*Client, error)

func (Client) Check

func (e Client) Check(ctx context.Context, service string) (HealthStatus, error)

func (Client) Watch

func (e Client) Watch(ctx context.Context, service string) (<-chan HealthStatus, error)

type HealthStatus

type HealthStatus int32

const (
	UNKNOWN HealthStatus = iota
	SERVING
	NOT_SERVING
	SERVICE_UNKNOWN
)

type Service

type Service interface {
	Check(ctx context.Context, service string) (HealthStatus, error)
	Watch(ctx context.Context, service string) (<-chan HealthStatus, error)
}