grpc_connection_pool

README

grpc-connection-pool

Package grpc_connection_pool provides the ability to create connection pool for gRPC.

License

Licensed under the MIT License

Authors

Copyright(c) 2020 Fred Chien cfsghost@gmail.com

Documentation

Overview

Package grpc_connection_pool provides the ability to create connection pool for gRPC.

Here is example to create connection pool:

// Create Options object
options := &pool.Options{
	InitCap: 8,
	MaxCap: 16,
	DialTimeout: time.Second * 20,
}

// Create connection pool with options
pool, err := grpc_connection_pool.NewGRPCPool("localhost:8888", options, grpc.WithInsecure())
if err != nil {
	log.Println(err)
	return
}

// Get a available gRPC client
client := pool.Get()

Index

• Variables
• type Connection
  • func NewConnection(c *grpc.ClientConn) *Connection
• type GRPCPool
  • func NewGRPCPool(host string, options *Options, dialOptions ...grpc.DialOption) (*GRPCPool, error)
  • func (pool *GRPCPool) Get() (*grpc.ClientConn, error)
  • func (pool *GRPCPool) Pop() (*grpc.ClientConn, error)
  • func (pool *GRPCPool) Push(connection *grpc.ClientConn) error
• type Options
  • func NewOptions() *Options

Variables

var ErrExceeded = errors.New("Maximum number of connections exceeded")

ErrExceeded is the error when maximum number of connections exceeded

var ErrUnavailable = errors.New("No available connection")

Types

type Connection

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

func NewConnection

func NewConnection(c *grpc.ClientConn) *Connection

type GRPCPool

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

func NewGRPCPool

func NewGRPCPool(host string, options *Options, dialOptions ...grpc.DialOption) (*GRPCPool, error)

NewGRPCPool creates a new connection pool.

func (*GRPCPool) Get

func (pool *GRPCPool) Get() (*grpc.ClientConn, error)

Get will returns a available gRPC client.

func (*GRPCPool) Pop

func (pool *GRPCPool) Pop() (*grpc.ClientConn, error)

Pop will return a availabe gRPC client and the gRPC client will not be reused before return client to the pool.

func (*GRPCPool) Push

func (pool *GRPCPool) Push(connection *grpc.ClientConn) error

Push will put gRPC client to the pool.

type Options

type Options struct {
	InitCap     int
	MaxCap      int
	DialTimeout time.Duration
}

Options represent all of the available options when creating a connection pool with NewGRPCPool.

func NewOptions

func NewOptions() *Options

NewOptions creates a Options object.