rpc

package
v0.0.0-...-ab4a820 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 5, 2020 License: Apache-2.0 Imports: 18 Imported by: 0

README

https://github.com/grpc/grpc-go update proto package, gRPC package and rebuild the proto files:

go get -u github.com/golang/protobuf/{proto,protoc-gen-go}
go get -u google.golang.org/grpc
protoc --go_out=plugins=grpc:. *.proto

Documentation

Overview

Package grpcpool provides a pool of grpc clients https://github.com/processout/grpc-go-pool/blob/master/LICENSE

Index

Constants

This section is empty.

Variables

View Source
var (
	// ErrClosed is the error when the client pool is closed
	ErrClosed = errors.New("grpc pool: client pool is closed")
	// ErrTimeout is the error when the client pool timed out
	ErrTimeout = errors.New("grpc pool: client pool timed out")
	// ErrAlreadyClosed is the error when the client conn was already closed
	ErrAlreadyClosed = errors.New("grpc pool: the connection was already closed")
	// ErrFullPool is the error when the pool is already full
	ErrFullPool = errors.New("grpc pool: closing a ClientConn into a full pool")
)

Functions

func GetListener

func GetListener() net.Listener

func GetRPCAddress

func GetRPCAddress() string

func GetRPCServer

func GetRPCServer() *grpc.Server

func Setup

func Setup(cfg *config.RPCConfig)

func StartRPCServer

func StartRPCServer()

Types

type ClientConn

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

ClientConn is the wrapper for a grpc client conn

func ObtainConnection

func ObtainConnection(addr string) (client *ClientConn, err error)

auto select connection

func ObtainLocalConnection

func ObtainLocalConnection() (conn *ClientConn, err error)

only select local connection

func (*ClientConn) Close

func (c *ClientConn) Close() error

Close returns a ClientConn to the pool. It is safe to call multiple time, but will return an error after first time

func (*ClientConn) Unhealthy

func (c *ClientConn) Unhealthy()

Unhealthy marks the client conn as unhealthy, so that the connection gets reset when closed

type Factory

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

Factory is a function type creating a grpc client

type FactoryWithContext

type FactoryWithContext func(context.Context) (*grpc.ClientConn, error)

FactoryWithContext is a function type creating a grpc client that accepts the context parameter that could be passed from Get or NewWithContext method.

type Pool

type Pool struct {
	// contains filtered or unexported fields
}

Pool is the grpc client pool

func New

func New(factory Factory, init, capacity int, idleTimeout time.Duration,
	maxLifeDuration ...time.Duration) (*Pool, error)

New creates a new clients pool with the given initial and maximum capacity, and the timeout for the idle clients. Returns an error if the initial clients could not be created

func NewWithContext

func NewWithContext(ctx context.Context, factory FactoryWithContext, init, capacity int, idleTimeout time.Duration,
	maxLifeDuration ...time.Duration) (*Pool, error)

NewWithContext creates a new clients pool with the given initial and maximum capacity, and the timeout for the idle clients. The context parameter would be passed to the factory method during initialization. Returns an error if the initial clients could not be created.

func (*Pool) Available

func (p *Pool) Available() int

Available returns the number of currently unused clients

func (*Pool) Capacity

func (p *Pool) Capacity() int

Capacity returns the capacity

func (*Pool) Close

func (p *Pool) Close()

Close empties the pool calling Close on all its clients. You can call Close while there are outstanding clients. The pool channel is then closed, and Get will not be allowed anymore

func (*Pool) Get

func (p *Pool) Get(ctx context.Context) (*ClientConn, error)

Get will return the next available client. If capacity has not been reached, it will create a new one using the factory. Otherwise, it will wait till the next client becomes available or a timeout. A timeout of 0 is an indefinite wait

func (*Pool) IsClosed

func (p *Pool) IsClosed() bool

IsClosed returns true if the client pool is closed.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL