Documentation
¶
Overview ¶
Copyright 2019 shimingyah. All rights reserved.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. ee the License for the specific language governing permissions and limitations under the License.
Index ¶
Constants ¶
const ( // DialTimeout the timeout of create connection DialTimeout = 5 * time.Second // BackoffMaxDelay provided maximum delay when backing off after failed connection attempts. BackoffMaxDelay = 3 * time.Second // KeepAliveTime is the duration of time after which if the client doesn't see // any activity it pings the server to see if the transport is still alive. KeepAliveTime = time.Duration(10) * time.Second // KeepAliveTimeout is the duration of time for which the client waits after having // pinged for keepalive check and if no activity is seen even after that the connection // is closed. KeepAliveTimeout = time.Duration(3) * time.Second // InitialWindowSize we set it 1GB is to provide system's throughput. InitialWindowSize = 1 << 30 // InitialConnWindowSize we set it 1GB is to provide system's throughput. InitialConnWindowSize = 1 << 30 // MaxSendMsgSize set max gRPC request message size sent to server. // If any request message size is larger than current value, an error will be reported from gRPC. MaxSendMsgSize = 4 << 30 // MaxRecvMsgSize set max gRPC receive message size received from server. // If any message size is larger than current value, an error will be reported from gRPC. MaxRecvMsgSize = 4 << 30 )
Variables ¶
var DefaultOptions = Options{ Dial: Dial, MaxIdle: 8, MaxActive: 64, MaxConcurrentStreams: 64, Reuse: true, }
DefaultOptions sets a list of recommended options for good performance. Feel free to modify these to suit your needs.
var ErrClosed = errors.New("pool is closed")
ErrClosed is the error resulting if the pool is closed via pool.Close().
Functions ¶
Types ¶
type Conn ¶
type Conn interface {
// Value return the actual grpc connection type *grpc.ClientConn.
Value() *grpc.ClientConn
// Close decrease the reference of grpc connection, instead of close it.
// if the pool is full, just close it.
Close() error
}
Conn single grpc connection inerface
type Options ¶
type Options struct {
// Dial is an application supplied function for creating and configuring a connection.
Dial func(address string) (*grpc.ClientConn, error)
// Maximum number of idle connections in the pool.
MaxIdle int
// Maximum number of connections allocated by the pool at a given time.
// When zero, there is no limit on the number of connections in the pool.
MaxActive int
// MaxConcurrentStreams limit on the number of concurrent streams to each single connection
MaxConcurrentStreams int
// If Reuse is true and the pool is at the MaxActive limit, then Get() reuse
// the connection to return, If Reuse is false and the pool is at the MaxActive limit,
// create a one-time connection to return.
Reuse bool
}
Options are params for creating grpc connect pool.
type Pool ¶
type Pool interface {
// Get returns a new connection from the pool. Closing the connections puts
// it back to the Pool. Closing it when the pool is destroyed or full will
// be counted as an error. we guarantee the conn.Value() isn't nil when conn isn't nil.
Get() (Conn, error)
// Close closes the pool and all its connections. After Close() the pool is
// no longer usable. You can't make concurrent calls Close and Get method.
// It will be cause panic.
Close() error
// Status returns the current status of the pool.
Status() string
}
Pool interface describes a pool implementation. An ideal pool is threadsafe and easy to use.
Source Files