client

Documentation

Index

• Constants
• func ExpBackoff(c BackoffConfig) *backoff.ExponentialBackOff
• func MapTunnels(m map[string]*Tunnel) map[string]*proto.Tunnel
• type Backoff
• type BackoffConfig
• type Client
  • func NewClient(config *ClientConfig) (*Client, error)
  • func (c *Client) Start() error
  • func (c *Client) Stop()
• type ClientConfig
• type ProxyFunc
  • func CreateProxy(m map[string]*Tunnel, logger *logrus.Entry) ProxyFunc
  • func Proxy(p ProxyFuncs) ProxyFunc
• type ProxyFuncs
• type Tunnel
• type TunnelExt

Constants

const (
	DefaultBackoffInterval    = 500 * time.Millisecond
	DefaultBackoffMultiplier  = 1.5
	DefaultBackoffMaxInterval = 60 * time.Second
	DefaultBackoffMaxTime     = 15 * time.Minute
)

Functions

func ExpBackoff

func ExpBackoff(c BackoffConfig) *backoff.ExponentialBackOff

func MapTunnels

func MapTunnels(m map[string]*Tunnel) map[string]*proto.Tunnel

Types

type Backoff

type Backoff interface {
	// Next returns the duration to sleep before retrying to reconnect.
	// If the returned value is negative, the retry is aborted.
	NextBackOff() time.Duration

	// Reset is used to signal a reconnection was successful and next
	// call to Next should return desired time duration for 1st reconnection
	// attempt.
	Reset()
}

Backoff defines behavior of staggering reconnection retries.

type BackoffConfig

type BackoffConfig struct {
	Interval    time.Duration `yaml:"interval"`
	Multiplier  float64       `yaml:"multiplier"`
	MaxInterval time.Duration `yaml:"max_interval"`
	MaxTime     time.Duration `yaml:"max_time"`
}

BackoffConfig defines behavior of staggering reconnection retries.

type Client

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

Client is responsible for creating connection to the server, handling control messages. It uses ProxyFunc for transferring data between server and local services.

func NewClient

func NewClient(config *ClientConfig) (*Client, error)

NewClient creates a new unconnected Client based on configuration. Caller must invoke Start() on returned instance in order to connect server.

func (*Client) Start

func (c *Client) Start() error

Start connects client to the server, it returns error if there is a connection error, or server cannot open requested tunnels. On connection error a backoff policy is used to reestablish the connection. When connected HTTP/2 server is started to handle ControlMessages.

func (*Client) Stop

func (c *Client) Stop()

Stop disconnects client from server.

type ClientConfig

type ClientConfig struct {
	// ServerAddress specifies TCP address of the tunnel server.
	ServerAddress string
	// Tunnels specifies the tunnels client requests to be opened on server.
	Tunnels map[string]*Tunnel
	// Logger is optional logger. If nil logging is disabled.
	Logger *log.Entry
	// AuthToken authentication token used to establish http tunnel
	AuthToken string
	// IdName optional name for client
	IdName string
}

ClientConfig is configuration of the Client.

type ProxyFunc

type ProxyFunc func(w io.Writer, r io.ReadCloser, msg *proto.ControlMessage)

ProxyFunc is responsible for forwarding a remote connection to local server and writing the response.

func CreateProxy

func CreateProxy(m map[string]*Tunnel, logger *logrus.Entry) ProxyFunc

func Proxy

func Proxy(p ProxyFuncs) ProxyFunc

Proxy returns a ProxyFunc that uses custom function if provided.

type ProxyFuncs

type ProxyFuncs struct {
	// HTTP is custom implementation of HTTP proxing.
	HTTP ProxyFunc
	// TCP is custom implementation of TCP proxing.
	TCP ProxyFunc
}

ProxyFuncs is a collection of ProxyFunc.

type Tunnel

type Tunnel struct {
	Protocol   string `yaml:"proto,omitempty"`
	Addr       string `yaml:"addr,omitempty"`
	Auth       string `yaml:"auth,omitempty"`
	Host       string `yaml:"host,omitempty"`
	RemoteAddr string `yaml:"remote_addr,omitempty"`
}

type TunnelExt

type TunnelExt struct {
	IdName  string
	Tunnels map[string]*proto.Tunnel
}