ssh

Documentation

Index

• type Tunnel
  • func NewTunnel(cfg *config.SSHConfig, remoteHost string, remotePort int) (*Tunnel, error)
  • func (t *Tunnel) Close() error
  • func (t *Tunnel) IsClosed() bool
  • func (t *Tunnel) LocalAddr() string
  • func (t *Tunnel) LocalPort() int

Types

type Tunnel

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

Tunnel represents an SSH tunnel that forwards a local port to a remote MySQL server.

func NewTunnel

func NewTunnel(cfg *config.SSHConfig, remoteHost string, remotePort int) (*Tunnel, error)

NewTunnel establishes an SSH tunnel and returns a Tunnel that forwards connections from a random local port to remoteHost:remotePort through the SSH server.

func (*Tunnel) Close

func (t *Tunnel) Close() error

Close shuts down the tunnel.

func (*Tunnel) IsClosed

func (t *Tunnel) IsClosed() bool

IsClosed returns whether the tunnel has been closed.

func (*Tunnel) LocalAddr

func (t *Tunnel) LocalAddr() string

LocalAddr returns the local address that MySQL should connect to.

func (*Tunnel) LocalPort

func (t *Tunnel) LocalPort() int

LocalPort returns the local port number.