portforward

package
v0.1.56 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jan 15, 2026 License: Apache-2.0 Imports: 13 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func RandomLocalPort

func RandomLocalPort() string

func RestoreSavedForwards added in v0.1.56

func RestoreSavedForwards(
	ctx context.Context,
	client *api.Client,
	playID string,
	out labcli.Outputer,
) (<-chan error, error)

RestoreSavedForwards starts port forwarding for all saved port forwards in the background. It returns a channel that will receive the result (nil on success, error on failure). The caller can choose to wait on the channel or let it run in the background.

Types

type ForwardingSpec

type ForwardingSpec struct {
	Kind       string // "local" or "remote"
	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 PortForwardToSpec added in v0.1.56

func PortForwardToSpec(pf *api.PortForward) ForwardingSpec

PortForwardToSpec converts an API PortForward to a ForwardingSpec.

func (ForwardingSpec) LocalAddr

func (f ForwardingSpec) LocalAddr() string

func (ForwardingSpec) RemoteAddr

func (f ForwardingSpec) RemoteAddr() string

func (ForwardingSpec) ToPortForward added in v0.1.56

func (f ForwardingSpec) ToPortForward(machine string) (*api.PortForward, error)

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

type TunnelOptions

type TunnelOptions struct {
	PlayID          string
	Machine         string
	SSHUser         string
	SSHIdentityFile string
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL