localcommand

Documentation

Overview

Package localcommand provides an implementation of webtty.Slave that launches a local command with a PTY.

Index

• Constants
• type Factory
  • func NewFactory(command string, argv []string, options *Options) (*Factory, error)
  • func (factory *Factory) Name() string
  • func (factory *Factory) New(params map[string][]string) (server.Slave, error)
• type LocalCommand
  • func New(command string, argv []string, options ...Option) (*LocalCommand, error)
  • func (lcmd *LocalCommand) Close() error
  • func (lcmd *LocalCommand) Read(p []byte) (n int, err error)
  • func (lcmd *LocalCommand) ResizeTerminal(width int, height int) error
  • func (lcmd *LocalCommand) WindowTitleVariables() map[string]interface{}
  • func (lcmd *LocalCommand) Write(p []byte) (n int, err error)
• type Option
  • func WithCloseSignal(signal syscall.Signal) Option
  • func WithCloseTimeout(timeout time.Duration) Option
• type Options

Constants

const (
	DefaultCloseSignal  = syscall.SIGINT
	DefaultCloseTimeout = 10 * time.Second
)

Types

type Factory

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

func NewFactory

func NewFactory(command string, argv []string, options *Options) (*Factory, error)

func (*Factory) Name

func (factory *Factory) Name() string

func (*Factory) New

func (factory *Factory) New(params map[string][]string) (server.Slave, error)

type LocalCommand

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

func New

func New(command string, argv []string, options ...Option) (*LocalCommand, error)

func (*LocalCommand) Close

func (lcmd *LocalCommand) Close() error

func (*LocalCommand) Read

func (lcmd *LocalCommand) Read(p []byte) (n int, err error)

func (*LocalCommand) ResizeTerminal

func (lcmd *LocalCommand) ResizeTerminal(width int, height int) error

func (*LocalCommand) WindowTitleVariables

func (lcmd *LocalCommand) WindowTitleVariables() map[string]interface{}

func (*LocalCommand) Write

func (lcmd *LocalCommand) Write(p []byte) (n int, err error)

type Option

type Option func(*LocalCommand)

func WithCloseSignal

func WithCloseSignal(signal syscall.Signal) Option

func WithCloseTimeout

func WithCloseTimeout(timeout time.Duration) Option

type Options

type Options struct {
	CloseSignal  int `` /* 155-byte string literal not displayed */
	CloseTimeout int `` /* 166-byte string literal not displayed */
}