common

Documentation

Index

• Constants
• Variables
• func AllUsersWithSockets() ([]*user.User, error)
• func Chown(path string, usr *user.User) error
• func CmdSocketPath(usr *user.User) string
• func EtcDirPath() string
• func InitSettings(params InitSettingsParams) error
• func JobberShouldRunForUser(usr *user.User) bool
• func LibexecDirPath() string
• func LibexecProgramPath(name string) string
• func LogAllToStderr()
• func LogToStdoutStderr()
• func LongVersionStr() string
• func MakeCmdExitedChan(cmd *exec.Cmd) <-chan error
• func MakeDefaultPrefs(params InitSettingsParams) string
• func PerUserDirPath(usr *user.User) string
• func PrintPaths()
• func SetLogFile(paths ...string)
• func ShortVersionStr() string
• func Sudo(usr user.User, cmdStr string) *exec.Cmd
• func TempDirPath() string
• func UseSyslog() error
• func UserOwnsFile(usr *user.User, path string) (bool, error)
• func UserOwnsFileF(usr *user.User, f *os.File) (bool, error)
• func VarDirPath() string
• type Error
  • func (e *Error) Error() string
• type ExecResult
  • func ExecAndWait(args []string, input []byte) (*ExecResult, error)
  • func ExecAndWaitContext(ctx context.Context, args []string, input []byte) (*ExecResult, error)
  • func (self *ExecResult) Close()
  • func (self *ExecResult) ReadStderr(max int) ([]byte, error)
  • func (self *ExecResult) ReadStdout(max int) (data []byte, err error)
• type InitSettingsParams
• type SubprocFate
  • func (self SubprocFate) String() string
• type UserSpec

Constants

const (
	DaemonSocketAddr string = "/var/jobber_daemon.sock"
)

Variables

var ErrLogger *log.Logger = log.New(os.Stderr, "", 0)

var Logger *log.Logger = log.New(os.Stdout, "", 0)

Functions

func AllUsersWithSockets

func AllUsersWithSockets() ([]*user.User, error)

Get a list of all users for whom there is a jobberrunner process.

func Chown

func Chown(path string, usr *user.User) error

func CmdSocketPath

func CmdSocketPath(usr *user.User) string

func EtcDirPath

func EtcDirPath() string

func InitSettings

func InitSettings(params InitSettingsParams) error

func JobberShouldRunForUser

func JobberShouldRunForUser(usr *user.User) bool

func LibexecDirPath

func LibexecDirPath() string

func LibexecProgramPath

func LibexecProgramPath(name string) string

func LogAllToStderr

func LogAllToStderr()

func LogToStdoutStderr

func LogToStdoutStderr()

func LongVersionStr

func LongVersionStr() string

func MakeCmdExitedChan

func MakeCmdExitedChan(cmd *exec.Cmd) <-chan error

func MakeDefaultPrefs

func MakeDefaultPrefs(params InitSettingsParams) string

func PerUserDirPath

func PerUserDirPath(usr *user.User) string

func PrintPaths

func PrintPaths()

func SetLogFile

func SetLogFile(paths ...string)

func ShortVersionStr

func ShortVersionStr() string

func Sudo

func Sudo(usr user.User, cmdStr string) *exec.Cmd

Returns an unstarted process descriptor.

func TempDirPath

func TempDirPath() string

func UseSyslog

func UseSyslog() error

func UserOwnsFile

func UserOwnsFile(usr *user.User, path string) (bool, error)

func UserOwnsFileF

func UserOwnsFileF(usr *user.User, f *os.File) (bool, error)

func VarDirPath

func VarDirPath() string

Types

type Error

type Error struct {
	What  string
	Cause error
}

func (*Error) Error

func (e *Error) Error() string

type ExecResult

type ExecResult struct {
	Stdout io.ReadSeeker
	Stderr io.ReadSeeker
	Fate   SubprocFate
}

An ExecResult describes the result of running a subprocess via ExecAndWait. Stdout and Stderr can be used to get the subprocess's stdout and stderr. When done with this object (e.g., when done reading Stdout/Stderr), you must call Close.

func ExecAndWait

func ExecAndWait(args []string, input []byte) (*ExecResult, error)

func ExecAndWaitContext

func ExecAndWaitContext(ctx context.Context, args []string, input []byte) (*ExecResult, error)

func (*ExecResult) Close

func (self *ExecResult) Close()

func (*ExecResult) ReadStderr

func (self *ExecResult) ReadStderr(max int) ([]byte, error)

func (*ExecResult) ReadStdout

func (self *ExecResult) ReadStdout(max int) (data []byte, err error)

type InitSettingsParams

type InitSettingsParams struct {
	VarDir     *string
	LibexecDir *string
	TempDir    *string
	EtcDir     *string
}

type SubprocFate

type SubprocFate int

const (
	SubprocFateSucceeded SubprocFate = iota
	SubprocFateFailed    SubprocFate = iota
	SubprocFateCancelled SubprocFate = iota
)

func (SubprocFate) String

func (self SubprocFate) String() string

type UserSpec

type UserSpec struct {
	Username string
	Home     string
}