command

Documentation

Overview

Package command provides a relatively thin wrapper around exec.Cmd, adding support for communicating with the dependent process using a channel.Channel.

Index

• type Command
  • func (cmd *Command) AddEnvVar(kv string)
  • func (cmd *Command) Kill() error
  • func (cmd *Command) SetupCommsChannel() (*channel.Channel, error)
  • func (cmd *Command) SoftKill() error
  • func (cmd *Command) Start() error

Types

type Command

type Command struct {
	exec.Cmd
	// contains filtered or unexported fields
}

Command is a wrapper around exec.Cmd which adds needed operations which are os specific. Notably, it knows how to attach a channel.Channel.

func (*Command) AddEnvVar

func (cmd *Command) AddEnvVar(kv string)

AddEnvVar passes the given environment variable to the process.

The environment variables are passed when the process is spawned, so this method should only be called before .Start is called.

The argument kv is a key value pair in the form "key=value".

func (*Command) Kill

func (cmd *Command) Kill() error

Kill sends SIGKILL to cmd.

func (*Command) SetupCommsChannel

func (cmd *Command) SetupCommsChannel() (*channel.Channel, error)

SetupCommsChannel prepares a daemonServiceCommand to communicate with a DaemonService locally over an interprocess pipe.

func (*Command) SoftKill

func (cmd *Command) SoftKill() error

SoftKill sends SIGINT to cmd.

func (*Command) Start

func (cmd *Command) Start() error

Start refines exec.Cmd.Start.