app

Documentation

Index

• Constants
• func LoopbackAddrForLocalConnect(addr string) string
• func PublicURLForAddr(addr string) string
• type App
  • func New(opts Options) (*App, error)
  • func (a *App) Close() error
  • func (a *App) Run(ctx context.Context) error
• type Options
  • func DefaultOptions(version string) Options

Constants

const (
	DefaultAddr        = "0.0.0.0:8765"
	DefaultPairingTTL  = 5 * time.Minute
	DefaultPollEvery   = 5 * time.Second
	DefaultCanaryEvery = time.Minute
)

Functions

func LoopbackAddrForLocalConnect

func LoopbackAddrForLocalConnect(addr string) string

LoopbackAddrForLocalConnect returns an address the Mac-side CLI can use to reach the local app server. It intentionally differs from PublicURLForAddr.

func PublicURLForAddr

func PublicURLForAddr(addr string) string

PublicURLForAddr returns the browser-visible URL for an app listen address. Wildcard binds need a concrete LAN address because phones cannot resolve the Mac's loopback address.

Types

type App

type App struct {
	Options Options
	Store   *state.Store
	Auth    *auth.Manager
	Live    *live.Service
	Relay   relay.Client
	Server  *hyperserve.Server
	// contains filtered or unexported fields
}

func New

func New(opts Options) (*App, error)

func (*App) Close

func (a *App) Close() error

func (*App) Run

func (a *App) Run(ctx context.Context) error

type Options

type Options struct {
	Addr             string
	PublicURL        string
	PublicURLFromEnv bool
	Remote           bool
	RemoteURL        string
	StateDir         string
	SocketPath       string
	Version          string
	PairingTTL       time.Duration
	PollEvery        time.Duration
	CanaryEvery      time.Duration
}

func DefaultOptions

func DefaultOptions(version string) Options