tunnel

Documentation

Overview

Package tunnel opens a tunnel using provided server and tunnel configuration and keeps it until something will break it or close it. As soon as the tunnel closed, it returns a signal to executing the routine using the channel flag.

Index

• func GetFullKeyPath(keyPath string) string
• func NewSshConfig(serverConfig config.Server) (*ssh.ClientConfig, error)
• type State
• type Stats
  • func NewStats(state State, updateStatsCallback func(stats *Stats)) *Stats
  • func (s *Stats) AddConnQty()
  • func (s *Stats) AddRxCount(count int64)
  • func (s *Stats) AddTxCount(count int64)
  • func (s *Stats) InitSpeedCalculation()
  • func (s *Stats) SetConnQty(qty int64)
  • func (s *Stats) SubConnQty()
  • func (s *Stats) UpdateState(state State)
• type Tunnel
  • func NewTunnel(appRuntime runtime.ApplicationRuntime, serverConfig config.Server, ...) *Tunnel
  • func (t *Tunnel) GetTunnelId() string
  • func (t *Tunnel) Init(runtime runtime.ApplicationRuntime)
  • func (t *Tunnel) Start() error

Functions

func GetFullKeyPath

func GetFullKeyPath(keyPath string) string

func NewSshConfig

func NewSshConfig(serverConfig config.Server) (*ssh.ClientConfig, error)

Types

type State

type State int

const (
	Starting State = iota
	Started
	Stopped
)

type Stats

type Stats struct {
	*sync.Mutex
	State State

	TxCount             int64
	RxCount             int64
	TxSpeed             int64
	RxSpeed             int64
	ConnQty             int64
	UpdateStatsCallback func(stats *Stats)
	// contains filtered or unexported fields
}

func NewStats

func NewStats(state State, updateStatsCallback func(stats *Stats)) *Stats

func (*Stats) AddConnQty

func (s *Stats) AddConnQty()

func (*Stats) AddRxCount

func (s *Stats) AddRxCount(count int64)

func (*Stats) AddTxCount

func (s *Stats) AddTxCount(count int64)

func (*Stats) InitSpeedCalculation

func (s *Stats) InitSpeedCalculation()

func (*Stats) SetConnQty

func (s *Stats) SetConnQty(qty int64)

func (*Stats) SubConnQty

func (s *Stats) SubConnQty()

func (*Stats) UpdateState

func (s *Stats) UpdateState(state State)

type Tunnel

type Tunnel struct {
	*sync.Mutex

	ServerConfig config.Server
	TunnelConfig config.Tunnel
	LoggerCh     chan string
	StatsCh      chan *Stats
	// contains filtered or unexported fields
}

func NewTunnel

func NewTunnel(appRuntime runtime.ApplicationRuntime, serverConfig config.Server, tunnelConfig config.Tunnel) *Tunnel

func (*Tunnel) GetTunnelId

func (t *Tunnel) GetTunnelId() string

func (*Tunnel) Init

func (t *Tunnel) Init(runtime runtime.ApplicationRuntime)

func (*Tunnel) Start

func (t *Tunnel) Start() error