Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

client

package

Go to main page

Versions in this module

v0

v0.6.0

Apr 15, 2026

Changes in this version

+ type ActiveTunnel struct

+ Def TunnelDef

+ PublicURL string

+ TCPPort uint32

+ TunnelID string

type Client

+ func (c *Client) ListActiveTunnels() []ActiveTunnel

+ func (c *Client) ReloadTunnels(ctx context.Context, newDefs []TunnelDef)

+ func (c *Client) StartControlServer(ctrlHost string, ctrlPort int) error

type Config

+ CtrlHost string

+ CtrlPort int

+ Tunnels []TunnelDef

+ type FileConfig struct

+ CtrlHost string

+ CtrlPort int

+ P2P *bool

+ Server string

+ TLS bool

+ TLSCACert string

+ TLSInsecure bool

+ Token string

+ Tunnels map[string]FileTunnelDef

+ func LoadFileConfig(path string) (*FileConfig, error)

+ func (fc *FileConfig) ToClientConfig(base Config) Config

+ type FileTunnelDef struct

+ Hostname string

+ LocalHost string

+ LocalPort int

+ PathPrefix string

+ Protocol string

+ Subdomain string

+ type TunnelDef struct

+ Hostname string

+ LocalHost string

+ LocalPort int

+ Name string

+ PathPrefix string

+ Protocol string

+ Subdomain string

+ type TunnelInfo struct

+ LocalHost string

+ LocalPort int

+ Name string

+ Protocol string

+ PublicURL string

+ TCPPort uint32

+ TunnelID string

v0.5.0

Apr 14, 2026

v0.4.4

Apr 11, 2026

v0.4.3

Apr 11, 2026

v0.4.2

Apr 11, 2026

Changes in this version

type Client

+ func (c *Client) CloseTunnel(ctx context.Context, tunnelID, reason string) error

+ func (c *Client) RequestStats(ctx context.Context) (*proto.StatsResponse, error)

v0.4.1

Apr 11, 2026

v0.4.0

Apr 11, 2026

Changes in this version

type Config

+ Hostname string

+ InspectorHost string

+ PathPrefix string

+ Protocol string

+ TLSCACert string

type FlagValues

+ TLSCACertSet bool

v0.3.1

Apr 10, 2026

v0.3.0

Apr 10, 2026

v0.2.0

Apr 10, 2026

Changes in this version

+ const ConfigDirName

+ const ConfigFileName

+ func ApplyPersistentConfig(cfg *Config, persistent *PersistentConfig, flags *FlagValues)

+ func ClearToken() error

+ func SavePersistentConfig(cfg *PersistentConfig) error

+ func UpdatePersistentConfig(cfg *Config, saveToken bool) error

+ type Client struct

+ func NewClient(config Config) *Client

+ func (c *Client) Close() error

+ func (c *Client) GetInspector() *inspector.Inspector

+ func (c *Client) GetP2PManager() *p2p.Manager

+ func (c *Client) GetStats() Stats

+ func (c *Client) IsConnected() bool

+ func (c *Client) IsP2PMode() bool

+ func (c *Client) Start(ctx context.Context) error

+ func (c *Client) StartInspector(port int) error

+ type Config struct

+ HeartbeatInterval time.Duration

+ HeartbeatTimeout time.Duration

+ InspectorPort int

+ LocalHost string

+ LocalPort int

+ MaxReconnectAttempts int

+ MaxReconnectInterval time.Duration

+ MuxConfig tunnel.MuxConfig

+ P2PConfig p2p.ManagerConfig

+ P2PEnabled bool

+ ReconnectBackoff float64

+ ReconnectInterval time.Duration

+ ServerAddr string

+ Subdomain string

+ TLSEnabled bool

+ TLSInsecure bool

+ Token string

+ func DefaultConfig() Config

+ type FlagValues struct

+ InspectorPortSet bool

+ P2PEnabledSet bool

+ ServerAddrSet bool

+ SubdomainSet bool

+ TLSInsecureSet bool

+ TLSSet bool

+ TokenSet bool

+ type PersistentConfig struct

+ InspectorPort int

+ P2PEnabled *bool

+ ServerAddr string

+ Subdomain string

+ TLSEnabled bool

+ TLSInsecure bool

+ Token string

+ func LoadPersistentConfig() (*PersistentConfig, error)

+ type Stats struct

+ BytesIn uint64

+ BytesOut uint64

+ ConnectionTime time.Time

+ Reconnects uint64

+ Requests uint64