psiphonfeat

Documentation

Overview

Package psiphonfeat implements the psiphon feature. When it is possible to enable this feature, we are able to start psiphon tunnels. Otherwise, it's not possible to start psiphon tunnels.

Index

• Constants
• Variables
• type Tunnel
  • func Start(ctx context.Context, config []byte, workdir string) (Tunnel, error)

Constants

const Enabled = false

Enabled indicates whether this feature is enabled.

Variables

var ErrFeatureNotEnabled = errors.New("psiphonfeat: not enabled")

ErrFeatureNotEnabled indicates that the Psiphon feature is not enabled in this build.

Types

type Tunnel

type Tunnel interface {
	// Stop stops a running Psiphon tunnel.
	Stop()

	// GetSOCKSProxyPort returns the SOCKS5 port used by the tunnel.
	GetSOCKSProxyPort() int
}

Tunnel is the interface implementing the Psiphon tunnel.

func Start

func Start(ctx context.Context, config []byte, workdir string) (Tunnel, error)

Start attempts to start the Psiphon tunnel and returns either a Tunnel or an error.