portforward

Documentation

Index

• func RandomLocalPort() string
• type ForwardingSpec
  • func ParseLocal(s string) (ForwardingSpec, error)
  • func (f ForwardingSpec) LocalAddr() string
  • func (f ForwardingSpec) RemoteAddr() string
• type Tunnel
  • func StartTunnel(ctx context.Context, client *api.Client, opts TunnelOptions) (*Tunnel, error)
  • func (t *Tunnel) Forward(ctx context.Context, spec ForwardingSpec, errCh chan error) error
  • func (t *Tunnel) MarshalJSON() ([]byte, error)
  • func (t *Tunnel) UnmarshalJSON(data []byte) error
• type TunnelOptions

Functions

func RandomLocalPort

func RandomLocalPort() string

Types

type ForwardingSpec

type ForwardingSpec struct {
	LocalHost  string // Defaults to "127.0.0.1" if not specified
	LocalPort  string // Empty if a random port is to be used
	RemoteHost string // Defaults to ""
	RemotePort string // Required, no default
}

func ParseLocal

func ParseLocal(s string) (ForwardingSpec, error)

func (ForwardingSpec) LocalAddr

func (f ForwardingSpec) LocalAddr() string

func (ForwardingSpec) RemoteAddr

func (f ForwardingSpec) RemoteAddr() string

type Tunnel

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

func StartTunnel

func StartTunnel(ctx context.Context, client *api.Client, opts TunnelOptions) (*Tunnel, error)

func (*Tunnel) Forward

func (t *Tunnel) Forward(ctx context.Context, spec ForwardingSpec, errCh chan error) error

func (*Tunnel) MarshalJSON

func (t *Tunnel) MarshalJSON() ([]byte, error)

func (*Tunnel) UnmarshalJSON

func (t *Tunnel) UnmarshalJSON(data []byte) error

type TunnelOptions

type TunnelOptions struct {
	PlayID   string
	Machine  string
	PlaysDir string
	SSHUser  string
	SSHDir   string
}