commands

Documentation

Index

• Variables
• func CaptureCommand(stdin io.Reader, pipePath string, cmd string, args ...string) (stdout string, stderr string, exitCode int, err error)
• func ExtendOffline(srv *server.HTTPServer, d time.Duration) error
• func GoOfflineFor(srv *server.HTTPServer, d time.Duration) error
• func GoOnline(srv *server.HTTPServer) error
• func InitCommand(pipePath string, handler ClientCommandHandlerFunc, cmd string, args ...string) (exitCode int, err error)
• func SendCommand(pipePath string, cmd string, args ...string) (exitCode int, err error)
• type ClientCommandHandlerFunc
• type ClientConn
  • func (cc *ClientConn) ListenMessage() (msg Message, err error)
  • func (cc *ClientConn) Pipe(stdin io.Reader, stdout io.Writer, stderr io.Writer) error
  • func (cc *ClientConn) WriteMessage(message string) error
• type CommandServer
  • func NewCommandServer(pipePath string, router *server.Router) (*CommandServer, error)
  • func (cs *CommandServer) Logger() logger.Logger
  • func (cs *CommandServer) RegisterCommand(cmd string, f ServerCommandHandler)
  • func (cs *CommandServer) Start()
  • func (cs *CommandServer) Stop() error
• type Message
  • func (msg Message) IsExit() bool
  • func (msg Message) ToStdErr() bool
  • func (msg Message) ToStdOut() bool
• type ServerCommandHandler
• type ServerConn
  • func (sc *ServerConn) ReadMessage() (string, error)
  • func (sc *ServerConn) WriteError(msg string) error
  • func (sc *ServerConn) WriteOutput(msg string) error

Variables

var (
	ErrCommandRead = errors.New("failed reading command: no data received")
	ErrCommandInit = errors.New("invalid command")
)

var (
	ErrInvalidRespType = errors.New("invalid response type")
	ErrDecodeMessage   = errors.New("message decode failed")
	ErrExitCodeLost    = errors.New("exit code not received")
)

Functions

func CaptureCommand

func CaptureCommand(stdin io.Reader, pipePath string, cmd string, args ...string) (stdout string, stderr string, exitCode int, err error)

func ExtendOffline

func ExtendOffline(srv *server.HTTPServer, d time.Duration) error

func GoOfflineFor

func GoOfflineFor(srv *server.HTTPServer, d time.Duration) error

func GoOnline

func GoOnline(srv *server.HTTPServer) error

func InitCommand

func InitCommand(pipePath string, handler ClientCommandHandlerFunc, cmd string, args ...string) (exitCode int, err error)

func SendCommand

func SendCommand(pipePath string, cmd string, args ...string) (exitCode int, err error)

Types

type ClientCommandHandlerFunc

type ClientCommandHandlerFunc func(cc *ClientConn) error

type ClientConn

type ClientConn struct {
	Conn *pipe.Conn
	// contains filtered or unexported fields
}

func (*ClientConn) ListenMessage

func (cc *ClientConn) ListenMessage() (msg Message, err error)

func (*ClientConn) Pipe

func (cc *ClientConn) Pipe(stdin io.Reader, stdout io.Writer, stderr io.Writer) error

func (*ClientConn) WriteMessage

func (cc *ClientConn) WriteMessage(message string) error

type CommandServer

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

func NewCommandServer

func NewCommandServer(pipePath string, router *server.Router) (*CommandServer, error)

func (*CommandServer) Logger

func (cs *CommandServer) Logger() logger.Logger

func (*CommandServer) RegisterCommand

func (cs *CommandServer) RegisterCommand(cmd string, f ServerCommandHandler)

func (*CommandServer) Start

func (cs *CommandServer) Start()

func (*CommandServer) Stop

func (cs *CommandServer) Stop() error

type Message

type Message struct {
	Msg string
	// contains filtered or unexported fields
}

func (Message) IsExit

func (msg Message) IsExit() bool

func (Message) ToStdErr

func (msg Message) ToStdErr() bool

func (Message) ToStdOut

func (msg Message) ToStdOut() bool

type ServerCommandHandler

type ServerCommandHandler func(sc *ServerConn, args ...string) (exitCode int, err error)

type ServerConn

type ServerConn struct {
	Router *server.Router
	Logger logger.Logger
	// contains filtered or unexported fields
}

func (*ServerConn) ReadMessage

func (sc *ServerConn) ReadMessage() (string, error)

func (*ServerConn) WriteError

func (sc *ServerConn) WriteError(msg string) error

func (*ServerConn) WriteOutput

func (sc *ServerConn) WriteOutput(msg string) error