pool

Documentation

Index

• func Key(cfg sshclient.ConnConfig) string
• type ConnInfo
• type DialFunc
• type HealthFunc
• type Pool
  • func New(ttl time.Duration) *Pool
  • func (p *Pool) Close(key string) error
  • func (p *Pool) CloseAll() error
  • func (p *Pool) Get(ctx context.Context, alias string, cfg sshclient.ConnConfig) (*sshclient.Client, error)
  • func (p *Pool) GetWithStatus(ctx context.Context, alias string, cfg sshclient.ConnConfig) (*sshclient.Client, bool, error)
  • func (p *Pool) Len() int
  • func (p *Pool) Reap() int
  • func (p *Pool) Stats() []ConnInfo

Functions

func Key

func Key(cfg sshclient.ConnConfig) string

Types

type ConnInfo

type ConnInfo struct {
	Key       string    `json:"key"`
	Alias     string    `json:"alias"`
	Host      string    `json:"host"`
	Port      string    `json:"port"`
	IdleSince time.Time `json:"idle_since"`
}

type DialFunc

type DialFunc func(context.Context, sshclient.ConnConfig) (*sshclient.Client, error)

DialFunc and HealthFunc are the pool's dependency-injection seams. They default to the real implementations in New and let tests drive Get's concurrency behaviour deterministically without a live SSH server — replacing the former package-level mutable globals, which leaked shared state across tests.

type HealthFunc

type HealthFunc func(*sshclient.Client) bool

type Pool

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

func New

func New(ttl time.Duration) *Pool

func (*Pool) Close

func (p *Pool) Close(key string) error

func (*Pool) CloseAll

func (p *Pool) CloseAll() error

func (*Pool) Get

func (p *Pool) Get(ctx context.Context, alias string, cfg sshclient.ConnConfig) (*sshclient.Client, error)

func (*Pool) GetWithStatus

func (p *Pool) GetWithStatus(ctx context.Context, alias string, cfg sshclient.ConnConfig) (*sshclient.Client, bool, error)

func (*Pool) Len

func (p *Pool) Len() int

func (*Pool) Reap

func (p *Pool) Reap() int

func (*Pool) Stats

func (p *Pool) Stats() []ConnInfo