chclient

Documentation

Index

• type Client
  • func NewClient(c *Config) (*Client, error)
  • func NewClientWithUserAndAuth(c *Config, user string, pass string) (*Client, error)
  • func (c *Client) Close() error
  • func (c *Client) Run() error
  • func (c *Client) Start(ctx context.Context) error
  • func (c *Client) Wait() error
• type Config
• type TLSConfig

Types

type Client

type Client struct {
	*cio.Logger
	// contains filtered or unexported fields
}

Client represents a client instance

func NewClient

func NewClient(c *Config) (*Client, error)

NewClient creates a new client instance

func NewClientWithUserAndAuth

func NewClientWithUserAndAuth(c *Config, user string, pass string) (
	*Client, error)

NewClientWithUserAndAuth creates a new client with an SSHConfig containing the provided user and password

func (*Client) Close

func (c *Client) Close() error

Close manually stops the client

func (*Client) Run

func (c *Client) Run() error

Run starts client and blocks while connected

func (*Client) Start

func (c *Client) Start(ctx context.Context) error

Start client and does not block

func (*Client) Wait

func (c *Client) Wait() error

Wait blocks while the client is running.

type Config

type Config struct {
	Fingerprint      string
	Auth             string
	KeepAlive        time.Duration
	MaxRetryCount    int
	MaxRetryInterval time.Duration
	Server           string
	Proxy            string
	Remotes          []string
	Headers          http.Header
	TLS              TLSConfig
	DialContext      func(ctx context.Context, network, addr string) (net.Conn, error)
	Verbose          bool
}

Config represents a client configuration

type TLSConfig

type TLSConfig struct {
	SkipVerify   bool
	CA           string
	Cert         string
	Key          string
	ServerName   string
	CipherSuites []uint16
	MinVersion   uint16
	MaxVersion   uint16
}

TLSConfig for a Client