tunnel

package

v3.5.1 Latest Latest Go to latest Published: Feb 3, 2021 License: BSD-3-Clause Imports: 7 Imported by: 0

Details

Package tunnel contains code to create a psiphon or tor tunnel.

This section is empty.

This section is empty.

This section is empty.

type Config struct {
	Name    string
	Session Session
	WorkDir string
}

Config contains config for the session tunnel.

type Session interface {
	psiphonx.Session
	torx.Session
	Logger() model.Logger
}

Session is the way in which this package sees a Session.

type Tunnel interface {
	BootstrapTime() time.Duration
	SOCKS5ProxyURL() *url.URL
	Stop()
}

Tunnel is a tunnel used by the session

func Start(ctx context.Context, config Config) (Tunnel, error)

Start starts a new tunnel by name or returns an error. Note that if you pass to this function the "" tunnel, you get back nil, nil.