multiplex

Documentation

Overview

Package multiplex implements a connection pool that supports connection multiplexing.

Index

• Variables
• func NewPool(dialFunc connpool.DialFunc, opt ...OptPool) multiplexed.Pool
• type OptPool
  • func WithDialTimeout(timeout time.Duration) OptPool
  • func WithEnableMetrics() OptPool
  • func WithMaxConcurrentVirConnsPerConn(max int) OptPool
• type PoolOption

Variables

var (
	// ErrConnClosed indicates connection is closed.
	ErrConnClosed = errors.New("connection is closed")
	// ErrDuplicateID indicates request ID already exist.
	ErrDuplicateID = errors.New("request ID already exist")
	// ErrInvalid indicates the operation is invalid.
	ErrInvalid = errors.New("it's invalid")
)

Functions

func NewPool

func NewPool(dialFunc connpool.DialFunc, opt ...OptPool) multiplexed.Pool

NewPool creates a new multiplex pool, which uses dialFunc to dial new connections.

Types

type OptPool

type OptPool func(*PoolOption)

OptPool is function to modify PoolOption.

func WithDialTimeout

func WithDialTimeout(timeout time.Duration) OptPool

WithDialTimeout returns an OptPool which sets dial timeout.

func WithEnableMetrics

func WithEnableMetrics() OptPool

WithEnableMetrics returns an OptPool which enable metrics.

func WithMaxConcurrentVirConnsPerConn

func WithMaxConcurrentVirConnsPerConn(max int) OptPool

WithMaxConcurrentVirConnsPerConn returns an OptPool which sets the number of concurrent virtual connections per connection.

type PoolOption

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

PoolOption represents some settings for the multiplex pool.