grpcpool

README

grpcpool

a grpc pool

Documentation

Index

• Variables
• type Builder
• type ClientConn
• type Option
  • func WithEnablePrometheus() Option
• type Pool
  • func NewPool(builder Builder, options ...Option) (Pool, error)
• type Stub

Variables

var (
	// ClosedErr pool has closed
	ClosedErr = stderr.New("grpc pool has closed")
)

Types

type Builder

type Builder func() (*grpc.ClientConn, error)

Builder builer for create grpc client connection

type ClientConn

type ClientConn interface {
	grpc.ClientConnInterface
	// contains filtered or unexported methods
}

ClientConn wrapper for *grpc.ClientConn

type Option

type Option func(*option)

Option optional configs

func WithEnablePrometheus

func WithEnablePrometheus() Option

WithEnablePrometheus enable to record prometheus metrics

type Pool

type Pool interface {
	Close()
	Get() (Stub, error)
	Restore(Stub)
}

Pool grpc pool

func NewPool

func NewPool(builder Builder, options ...Option) (Pool, error)

NewPool create a grpc pool

type Stub

type Stub interface {
	Conn() ClientConn
	// contains filtered or unexported methods
}

Stub the real handler in pool