chclient

Documentation

Index

• type Client
  • func NewClient(c *Config) (*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
  • func NewClientConfig(profileConfigPath string, cfg *Config) (*Config, error)
• 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 (*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        `yaml:"fingerprint,omitempty"`
	Auth             string        `yaml:"auth,omitempty"`
	KeepAlive        time.Duration `yaml:"keepalive,omitempty"`
	MaxRetryCount    int           `yaml:"max-retry-count,omitempty"`
	MaxRetryInterval time.Duration `yaml:"max-retry-interval,omitempty"`
	Server           string        `yaml:"server,omitempty"`
	Proxy            string        `yaml:"proxy,omitempty"`
	Remotes          []string      `yaml:"remotes,omitempty"`
	Headers          http.Header   `yaml:"headers,omitempty"`
	TLS              TLSConfig     `yaml:"tls,omitempty"`
	DialContext      func(ctx context.Context, network, addr string) (net.Conn, error)
	Verbose          bool `yaml:"verbose,omitempty"`
}

Config represents a client configuration

func NewClientConfig

func NewClientConfig(profileConfigPath string, cfg *Config) (*Config, error)

type TLSConfig

type TLSConfig struct {
	SkipVerify bool   `yaml:"tls-skip-verify,omitempty"`
	CA         string `yaml:"tls-ca,omitempty"`
	Cert       string `yaml:"tls-cert,omitempty"`
	Key        string `yaml:"tls-key,omitempty"`
	ServerName string `yaml:"hostname,omitempty"`
}

TLSConfig for a Client