app

Documentation

Index

• Constants
• Variables
• func ApplyConfigFile(options *Options, configFilePath string) error
• func Asset(name string) ([]byte, error)
• func AssetDir(name string) ([]string, error)
• func AssetInfo(name string) (os.FileInfo, error)
• func AssetNames() []string
• func MustAsset(name string) []byte
• func RestoreAsset(dir, name string) error
• func RestoreAssets(dir, name string) error
• type App
  • func New(command []string, options *Options) (*App, error)
  • func (app *App) Exit() (firstCall bool)
  • func (app *App) Run() error
• type ContextVars
• type Options

Constants

const (
	Input          = '0'
	ResizeTerminal = '1'
)

const (
	Output         = '0'
	SetWindowTitle = '1'
	SetPreferences = '2'
	SetReconnect   = '3'
)

Variables

var DefaultOptions = Options{
	Address:         "",
	Port:            "8080",
	PermitWrite:     false,
	EnableBasicAuth: false,
	Credential:      "",
	EnableRandomUrl: false,
	RandomUrlLength: 8,
	ProfileFile:     "~/.gotty.prf",
	EnableTLS:       false,
	TLSCrtFile:      "~/.gotty.key",
	TLSKeyFile:      "~/.gotty.crt",
	TitleFormat:     "GoTTY - {{ .Command }} ({{ .Hostname }})",
	EnableReconnect: false,
	ReconnectTime:   10,
	Once:            false,
}

Functions

func ApplyConfigFile

func ApplyConfigFile(options *Options, configFilePath string) error

func Asset

func Asset(name string) ([]byte, error)

Asset loads and returns the asset for the given name. It returns an error if the asset could not be found or could not be loaded.

func AssetDir

func AssetDir(name string) ([]string, error)

AssetDir returns the file names below a certain directory embedded in the file by go-bindata. For example if you run go-bindata on data/... and data contains the following hierarchy:

data/
  foo.txt
  img/
    a.png
    b.png

then AssetDir("data") would return []string{"foo.txt", "img"} AssetDir("data/img") would return []string{"a.png", "b.png"} AssetDir("foo.txt") and AssetDir("notexist") would return an error AssetDir("") will return []string{"data"}.

func AssetInfo

func AssetInfo(name string) (os.FileInfo, error)

AssetInfo loads and returns the asset info for the given name. It returns an error if the asset could not be found or could not be loaded.

func AssetNames

func AssetNames() []string

AssetNames returns the names of the assets.

func MustAsset

func MustAsset(name string) []byte

MustAsset is like Asset but panics when Asset would return an error. It simplifies safe initialization of global variables.

func RestoreAsset

func RestoreAsset(dir, name string) error

RestoreAsset restores an asset under the given directory

func RestoreAssets

func RestoreAssets(dir, name string) error

RestoreAssets restores an asset under the given directory recursively

Types

type App

type App struct {
	// contains filtered or unexported fields
}

func New

func New(command []string, options *Options) (*App, error)

func (*App) Exit

func (app *App) Exit() (firstCall bool)

func (*App) Run

func (app *App) Run() error

type ContextVars

type ContextVars struct {
	Command    string
	Pid        int
	Hostname   string
	RemoteAddr string
}

type Options

type Options struct {
	Address         string
	Port            string
	PermitWrite     bool
	EnableBasicAuth bool
	Credential      string
	EnableRandomUrl bool
	RandomUrlLength int
	ProfileFile     string
	EnableTLS       bool
	TLSCrtFile      string
	TLSKeyFile      string
	TitleFormat     string
	EnableReconnect bool
	ReconnectTime   int
	Once            bool
}