sshpool

package

v0.1.3 Latest Latest Go to latest Published: Dec 31, 2025 License: MIT Imports: 10 Imported by: 0

Details

This section is empty.

This section is empty.

func CloseDefault() error

CloseDefault closes the default pool.

type Config struct {
	Host     string
	Port     int
	User     string
	Password string
	KeyFile  string
	Timeout  time.Duration
}

Config holds SSH connection configuration.

type Option func(*Pool)

Option configures the Pool.

func WithIdleTimeout(d time.Duration) Option

WithIdleTimeout sets the idle timeout for connections.

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

Pool manages a pool of SSH connections.

func Default() *Pool

Default returns the default global pool.

func New(opts ...Option) *Pool

New creates a new connection pool.

func (p *Pool) Close() error

Close closes all connections and stops the cleaner.

func (p *Pool) Get(ctx context.Context, cfg *Config) (*ssh.Client, error)

Get returns an SSH client for the given configuration. If a connection exists and is healthy, it will be reused.

func (p *Pool) Stats() (active int, idle int)

Stats returns pool statistics.