tunnel

Documentation

Index

• type Mode
  • func (m Mode) String() string
  • func (m *Mode) UnmarshalTOML(data interface{}) error
• type Status
• type StringOrInt
  • func (s StringOrInt) String() string
  • func (s *StringOrInt) UnmarshalTOML(v any) error
• type Tunnel
  • func (t *Tunnel) Close() error
  • func (t *Tunnel) Open() error

Types

type Mode

type Mode int

const (
	Local Mode = iota
	Remote
	Socks
	RemoteSocks
)

func (Mode) String

func (m Mode) String() string

func (*Mode) UnmarshalTOML

func (m *Mode) UnmarshalTOML(data interface{}) error

type Status

type Status int

const (
	Closed Status = iota
	Open
	Reconn
)

type StringOrInt

type StringOrInt string

Custom type to handle both string and integer values in the TOML config. This is useful for the local address.

func (StringOrInt) String

func (s StringOrInt) String() string

func (*StringOrInt) UnmarshalTOML

func (s *StringOrInt) UnmarshalTOML(v any) error

type Tunnel

type Tunnel struct {
	Name          string        `toml:"name" json:"name"`
	LocalAddress  StringOrInt   `toml:"local" json:"local"`
	RemoteAddress StringOrInt   `toml:"remote" json:"remote"`
	Host          string        `toml:"host" json:"host"`
	User          string        `toml:"user" json:"user"`
	IdentityFile  string        `toml:"identity" json:"identity"`
	Port          int           `toml:"port" json:"port"`
	Mode          Mode          `toml:"mode" json:"mode"`
	Status        Status        `toml:"-" json:"status"`
	LastConn      time.Time     `toml:"-" json:"last_conn"`
	Closed        chan struct{} `toml:"-" json:"-"`
	// contains filtered or unexported fields
}

func (*Tunnel) Close

func (t *Tunnel) Close() error

func (*Tunnel) Open

func (t *Tunnel) Open() error