batch

Documentation

Index

• func CopyEnv(vars ...string) map[string]string
• func Init()
• func Register(fns ...interface{})
• type Client
  • func NewClient(path string) (*Client, error)
  • func (cl *Client) MapFunc(env map[string]string, fn interface{}, argsList ...interface{}) []Result
  • func (cl *Client) Run(task Task) (Result, error)
  • func (cl *Client) RunFunc(env map[string]string, fn interface{}, args interface{}) (Result, error)
• type Result
• type Task

Functions

func CopyEnv

func CopyEnv(vars ...string) map[string]string

func Init

func Init()

Init must be called at the top of your program's main function after `Register`.

func Register

func Register(fns ...interface{})

Register stores information about functions so they can be called remotely. The function must take a pointer to a struct as an argument and return nothing.

Types

type Client

type Client struct {
	*rpc.Client
}

func NewClient

func NewClient(path string) (*Client, error)

func (*Client) MapFunc

func (cl *Client) MapFunc(
	env map[string]string,
	fn interface{},
	argsList ...interface{},
) []Result

Run runs the function on the given list of arguments. See RunFunc.

func (*Client) Run

func (cl *Client) Run(task Task) (Result, error)

func (*Client) RunFunc

func (cl *Client) RunFunc(
	env map[string]string,
	fn interface{},
	args interface{},
) (
	Result,
	error,
)

Run runs the function on the given arguments. The function must be registered with the `Register` function. See also: `Init` function.

type Result

type Result struct {
	Code   int    // Executable exit code. 0 is traditionally success.
	Output string // Combined command output.
}

type Task

type Task struct {
	Executable string            // Full path to executable.
	Env        map[string]string // Environment variables and values.
	Args       string            // Arguments to the executable.
}