process

Documentation

Index

• Constants
• Variables
• func Run(opts *Options, cancel chan struct{}, chCmdStr chan string) (chan *Command, chan string, chan int, chan int)
• func Run4Output(opts *Options, cancel chan struct{}, chCmdStr chan string) (chan string, chan string, chan int, chan int)
• type ChildCheckRecord
• type Command
  • func NewCommand(id uint64, cmdStr string, cancel chan struct{}, timeout time.Duration) *Command
  • func (c *Command) Cleanup() error
  • func (c *Command) Run(opts *Options, tryNumber int) (chan string, error)
  • func (c *Command) String() string
• type ImmediateLineWriter
  • func NewImmediateLineWriter(lock *sync.Mutex, numJobs int, cmdId uint64, tryNumber int) *ImmediateLineWriter
  • func (lw *ImmediateLineWriter) WritePrefixedLines(input string, outfh *os.File)
• type ImmediateWriter
  • func NewImmediateWriter(lineWriter *ImmediateLineWriter, fh *os.File) *ImmediateWriter
  • func (iw ImmediateWriter) Write(p []byte) (n int, err error)
• type IntSet
  • func (set *IntSet) Add(i int) bool
• type Options
• type ProcessRecord
• type TopLevelEnum

Constants

const (
	INVALID_HANDLE int = 0

	CTRL_C_SIGNAL     int = 0
	CTRL_BREAK_SIGNAL int = 1
	KILL_SIGNAL       int = 2

	// bit mask
	SEND_NO_SIGNAL         int = 0
	SEND_CTRL_C_SIGNAL     int = 1
	SEND_CTRL_BREAK_SIGNAL int = 2
	SEND_KILL_SIGNAL       int = 4
)

Variables

var ChildMarker string = strconv.Itoa(os.Getpid()) + "_" + strconv.FormatInt(time.Now().Unix(), 16)

pid_numSecondsSinceEpoch

var ErrCancelled = fmt.Errorf("cancelled")

ErrCancelled means command being cancelled

var ErrTimeout = fmt.Errorf("time out")

ErrTimeout means command timeout

var Log *logging.Logger

Log is *logging.Logger

var OutputChunkSize = 16384 // 16K

OutputChunkSize is buffer size of output string chunk sent to channel, default 16K.

var Procd string

var TmpOutputDataBuffer = 1048576 // 1M

TmpOutputDataBuffer is buffer size for output of a command before saving to tmpfile, default 1M.

var Verbose bool

Verbose decides whether print extra information

Functions

func Run

func Run(opts *Options, cancel chan struct{}, chCmdStr chan string) (chan *Command, chan string, chan int, chan int)

Run runs commands in parallel from channel chCmdStr， and returns a Command channel, and a done channel to ensure safe exit.

func Run4Output

func Run4Output(opts *Options, cancel chan struct{}, chCmdStr chan string) (chan string, chan string, chan int, chan int)

Run4Output runs commands in parallel from channel chCmdStr, and returns an output text channel, and a done channel to ensure safe exit.

Types

type ChildCheckRecord

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

type Command

type Command struct {
	ID  uint64 // ID
	Cmd string // command

	Cancel  chan struct{} // channel for close
	Timeout time.Duration // time out

	Ch chan string // channel for stdout

	Err      error         // Error
	Duration time.Duration // runtime

	Executed chan int // for checking if the command has been executed
	// contains filtered or unexported fields
}

Command is the Command struct

func NewCommand

func NewCommand(id uint64, cmdStr string, cancel chan struct{}, timeout time.Duration) *Command

NewCommand create a Command

func (*Command) Cleanup

func (c *Command) Cleanup() error

Cleanup removes tmpfile

func (*Command) Run

func (c *Command) Run(opts *Options, tryNumber int) (chan string, error)

Run runs a command and send output to command.Ch in background.

func (*Command) String

func (c *Command) String() string

type ImmediateLineWriter

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

ImmediateLineWriter is safe to use concurrently

func NewImmediateLineWriter

func NewImmediateLineWriter(lock *sync.Mutex, numJobs int, cmdId uint64, tryNumber int) *ImmediateLineWriter

func (*ImmediateLineWriter) WritePrefixedLines

func (lw *ImmediateLineWriter) WritePrefixedLines(input string, outfh *os.File)

type ImmediateWriter

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

func NewImmediateWriter

func NewImmediateWriter(lineWriter *ImmediateLineWriter, fh *os.File) *ImmediateWriter

func (ImmediateWriter) Write

func (iw ImmediateWriter) Write(p []byte) (n int, err error)

type IntSet

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

from https://softwareengineering.stackexchange.com/questions/177428/sets-data-structure-in-golang

func (*IntSet) Add

func (set *IntSet) Add(i int) bool

type Options

type Options struct {
	DryRun bool // just print command
	Jobs   int  // max jobs number

	ETA    bool // show eta
	ETABar *pb.ProgressBar

	KeepOrder           bool          // keep output order
	Retries             int           // max retry chances
	RetryInterval       time.Duration // retry interval
	OutFileHandle       *os.File      // where to send stdout
	ErrFileHandle       *os.File      // where to send stderr
	ImmediateOutput     bool          // print output immediately and interleaved
	ImmediateLock       sync.Mutex    // make immediate output thread-safe and do one write at a time
	PrintRetryOutput    bool          // print output from retries
	Timeout             time.Duration // timeout
	StopOnErr           bool          // stop on any error
	NoStopExes          []string      // exe names to exclude from stop signal
	NoKillExes          []string      // exe names to exclude from kill signal
	CleanupTime         time.Duration // time to allow children to clean up
	PropExitStatus      bool          // propagate child exit status
	RecordSuccessfulCmd bool          // send successful command to channel
	Verbose             bool
}

Options contains the options

type ProcessRecord

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

type TopLevelEnum

type TopLevelEnum int

const (
	NotTopLevel TopLevelEnum = 0
	TopLevel    TopLevelEnum = 1
)