grpc

Documentation

Index

• Constants
• Variables
• func NewBuilder(reg registry.Registry, oo ...client.BalancerOption) resolver.Builder
• func RegisterMock(serviceName string, mock grpc.ClientConnInterface)
• func RegisterServiceTransformer(transformer ServiceTransformer)
• func ResolveConn(ctx context.Context, serviceName string, opt ...Option) grpc.ClientConnInterface
• type HealthMonitor
  • func NewHealthChecker(c context.Context) HealthMonitor
  • func NewHealthCheckerWithRetries(c context.Context, retry, timeout time.Duration) HealthMonitor
• type Option
  • func WithCallTimeout(c time.Duration) Option
  • func WithClientConn(c grpc.ClientConnInterface) Option
  • func WithDialOptions(opts ...grpc.DialOption) Option
  • func WithPeerSelector(host string) Option
  • func WithRegistry(r registry.Registry) Option
  • func WithSilentNotFound() Option
• type Options
• type ServiceTransformer

Constants

const BalancerRoundRobin = "cells-robin-"

Variables

var (
	CallTimeoutShort = 1 * time.Second
)

Functions

func NewBuilder

func NewBuilder(reg registry.Registry, oo ...client.BalancerOption) resolver.Builder

func RegisterMock

func RegisterMock(serviceName string, mock grpc.ClientConnInterface)

RegisterMock registers a stubbed ClientConnInterface for a given service

func RegisterServiceTransformer

func RegisterServiceTransformer(transformer ServiceTransformer)

func ResolveConn

func ResolveConn(ctx context.Context, serviceName string, opt ...Option) grpc.ClientConnInterface

Types

type HealthMonitor

type HealthMonitor interface {
	Monitor(string)
	Up() bool
	Stop()
}

HealthMonitor blocks a connection to a specific service health

func NewHealthChecker

func NewHealthChecker(c context.Context) HealthMonitor

NewHealthChecker creates a HealthMonitor that blocks once on establishing the gRPC connection

func NewHealthCheckerWithRetries

func NewHealthCheckerWithRetries(c context.Context, retry, timeout time.Duration) HealthMonitor

NewHealthCheckerWithRetries creates a HealthMonitor that retries the gRPC connection if it fails Do not pass 0 as retry or timeout parameters !

type Option

type Option func(*Options)

func WithCallTimeout

func WithCallTimeout(c time.Duration) Option

func WithClientConn

func WithClientConn(c grpc.ClientConnInterface) Option

func WithDialOptions

func WithDialOptions(opts ...grpc.DialOption) Option

func WithPeerSelector

func WithPeerSelector(host string) Option

func WithRegistry

func WithRegistry(r registry.Registry) Option

func WithSilentNotFound

func WithSilentNotFound() Option

type Options

type Options struct {
	ClientConn     grpc.ClientConnInterface
	Registry       registry.Registry
	CallTimeout    time.Duration
	DialOptions    []grpc.DialOption
	BalancerFilter client.BalancerTargetFilter
	SilentNotFound bool
}

type ServiceTransformer

type ServiceTransformer func(context.Context, string) (string, []string, bool)