tunnel

Documentation

Index

• func IsAvailable() bool
• type Tunnel
  • func New(port int) (*Tunnel, error)
  • func (t *Tunnel) Close() error
  • func (t *Tunnel) Ready() <-chan struct{}
  • func (t *Tunnel) URL() string

Functions

func IsAvailable

func IsAvailable() bool

IsAvailable checks if SSH is available on the system

Types

type Tunnel

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

Tunnel implements interfaces.Tunnel

func New

func New(port int) (*Tunnel, error)

New creates and starts a new SSH tunnel asynchronously

func (*Tunnel) Close

func (t *Tunnel) Close() error

Close closes the tunnel and cleans up resources

func (*Tunnel) Ready

func (t *Tunnel) Ready() <-chan struct{}

Ready returns a channel that's closed when the tunnel is ready to use

func (*Tunnel) URL

func (t *Tunnel) URL() string

URL returns the tunnel's public URL