cmdstate

Documentation

Index

• type CommandManager
  • func NewManager(runner *state.TaskRunner) *CommandManager
  • func (m *CommandManager) Connect(r *http.Request, w http.ResponseWriter, task *state.Task, websocketID string) error
  • func (m *CommandManager) Ensure() error
• type ExecArgs
• type ExecMetadata
  • func Exec(st *state.State, args *ExecArgs) (*state.Task, ExecMetadata, error)

Types

type CommandManager

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

func NewManager

func NewManager(runner *state.TaskRunner) *CommandManager

NewManager creates a new CommandManager.

func (*CommandManager) Connect

func (m *CommandManager) Connect(r *http.Request, w http.ResponseWriter, task *state.Task, websocketID string) error

Connect upgrades the HTTP connection and connects to the given websocket.

func (*CommandManager) Ensure

func (m *CommandManager) Ensure() error

Ensure is part of the overlord.StateManager interface.

type ExecArgs

type ExecArgs struct {
	Command     []string
	Environment map[string]string
	WorkingDir  string
	Timeout     time.Duration
	UserID      *int
	GroupID     *int
	Terminal    bool
	Interactive bool
	SplitStderr bool
	Width       int
	Height      int
}

ExecArgs holds the arguments for a command execution.

type ExecMetadata

type ExecMetadata struct {
	TaskID      string
	Environment map[string]string
	WorkingDir  string
}

ExecMetadata is the metadata returned from an Exec call.

func Exec

func Exec(st *state.State, args *ExecArgs) (*state.Task, ExecMetadata, error)

Exec creates a task that will execute the command with the given arguments.