ssh

README

ssh

Documentation

Index

• Variables
• type Client
• type Config
  • func (cfg *Config) Callback() ConfigCallback
  • func (cfg *Config) With(opts ...Option) *Config
  • func (cfg *Config) WithAuth(methods ...ssh.AuthMethod) *Config
• type ConfigCallback
• type Conn
• type Heartbeat
• type Option
• type Session

Variables

var ErrConfigNotFound = errors.New("config not found")

Types

type Client

type Client struct {
	ConfigCallback ConfigCallback
}

type Config

type Config struct {
	ssh.ClientConfig `json:"-" yaml:"-"`

	Network     string
	Address     string
	KeepAlive   bool
	ServerAlive Heartbeat
}

func (*Config) Callback

func (cfg *Config) Callback() ConfigCallback

func (*Config) With

func (cfg *Config) With(opts ...Option) *Config

func (*Config) WithAuth

func (cfg *Config) WithAuth(methods ...ssh.AuthMethod) *Config

type ConfigCallback

type ConfigCallback func(ctx context.Context, network, address string) (*Config, error)

type Conn

type Conn struct {
	*ssh.Client
}

type Heartbeat

type Heartbeat struct {
	Interval time.Duration
	MaxCount int
}

type Option

type Option interface {
	Apply(*Config) *Config
}

type Session

type Session struct {
}